Upload a file

POST /api/2.0/crm/{entityType:(contact|opportunity|case)}/{entityid:[0-9]+}/files/upload

Request

Uploads a file to the CRM module with the parameters specified in the request.

Note: Upload can be done in 2 different ways:

1. Single file upload. You should set the Content-Type & Content-Disposition headers to specify file name and content type, and send a file in the request body.
2. Using standart multipart/form-data method.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

entityTypestring

Related entity type

entityidinteger

Related entity ID

fileobject

Request input stream

contentTypeobject

Content-Type header

contentDispositionobject

Content-Disposition header

filesarray of string

List of files when posted as multipart/form-data

storeOriginalFileFlagboolean

Defines if the documents in the original formats are also stored or not

Examples

POST /api/2.0/crm/%7BentityType:(contact%7Copportunity%7Ccase)%7D/%7Bentityid:[0-9]+%7D/files/upload HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request POST \
  --url 'https://example.com/api/2.0/crm/%7BentityType:(contact%7Copportunity%7Ccase)%7D/%7Bentityid:[0-9]+%7D/files/upload' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

File information

Namestring

UpdatedByobject

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

Updatedstring

Locationstring

401

Unauthorized