Files

Create Files

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

docIdstringRequired

The document ID to attach files to

docTypestring · enumRequired

The document type (deal, contact, or company)

Possible values:

Body

application/json

Responses

200

Array of created files

application/json

idstringOptional

The unique ID of the File

titlestring · nullableOptional

The title of the File

srcstring · nullableOptional

The URL of the File

typestring · nullableOptional

The MIME type of the File (e.g. image/jpeg, application/pdf)

formatstring · nullableOptional

The file format/extension (e.g. jpg, pdf, png)

visibilitystring · enum · nullableOptional

The visibility of the File

Possible values:

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

post/files

HTTPcURLJavaScriptPython

POST /v2/files?docId=text&docType=deal HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "files": [
    {
      "url": "https://example.com/photo.jpg",
      "title": "Site Photo",
      "visibility": "visible"
    }
  ]
}

[
  {
    "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
    "title": "Site Photo",
    "src": "https://example.com/files/photo.jpg",
    "type": "image/jpeg",
    "format": "jpeg",
    "visibility": "visible",
    "timestamp": {
      "created": 1672531200,
      "updated": 1672617600
    }
  }
]