Skip to main content
POST
Attach File
Creates a file_attachments row linking the file to a CRM entity. Attachments are a many-to-many join, not a field on the file — a file can be attached to several entities at once. In practice entity_type is one of deal, account, contact, task, or project, but the database does not constrain the value.

Auth

Requires a CRM manage scope and an active organization on the token. Any *:manage scope qualifies — in practice contacts:manage, deals:manage, companies:manage, or activities:manage.

Response

Errors

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

file_id
string
required

UUID of the file to attach to a CRM entity.

Body

application/json
entity_type
string
required

CRM entity kind to attach to, e.g. deal, account, contact, task, project.

entity_id
string
required

UUID of the entity to attach the file to.

Response

Successful Response

{key}
boolean