Skip to main content
POST
Attach a file to a deal, contact, or company

Authorizations

Authorization
string
header
required

Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.

Body

application/json
fileAssetId
string
required

File asset ID from the file upload system

description
string

Description/label for the attachment

dealId
string

Deal ID to attach the file to

contactId
string

Contact ID to attach the file to

crmCompanyId
string

CRM Company ID to attach the file to

Response

id
string
required
kind
enum<string>
required

A link carries its title in filename/originalFilename, mimeType text/uri-list, sizeBytes 0 and an empty fileAssetId

Available options:
file,
link
fileAssetId
string
required
filename
string
required
originalFilename
string
required
mimeType
string
required
sizeBytes
number
required
createdAt
string<date-time>
required
url
string

Set for links only

description
string
dealId
string
contactId
string
crmCompanyId
string
uploadedById
string
uploadedByName
string