Attach files to the entity

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

Request

Attaches the selected file(s) to the entity specified in the request.

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: Entity type
entityidinteger: Entity ID
fileidsarray of integer: List of file IDs

Examples

POST /api/2.0/crm/%7BentityType:(contact%7Copportunity%7Ccase)%7D/%7Bentityid:[0-9]+%7D/files 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' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Entity with the file(s) attached

CreateByobject

Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring

Createdstring

Contentstring

Categoryobject

ImagePathstring
Titlestring
Descriptionstring
Colorstring
SortOrderintegerformat: int32
IDintegerformat: int32

Contactobject

SmallFotoUrlstring

MediumFotoUrlstring

DisplayNamestring

IsCompanyboolean

AccessListarray of object

Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring

IsPrivateboolean

IsSharedboolean

ShareTypeenum of integerformat: int32

[0 - None, 1 - ReadWrite, 2 - Read]

Can be one of: None, ReadWrite, Read.

Currencyobject

Titlestring
Symbolstring
Abbreviationstring
CultureNamestring
IsConvertableboolean
IsBasicboolean

CanEditboolean

CanDeleteboolean

IDintegerformat: int32

Entityobject

EntityTypestring
EntityIdintegerformat: int32
EntityTitlestring

CanEditboolean

Filesarray of object

Namestring

UpdatedByobject

Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring

Updatedstring

Locationstring