Skip to main content
POST
Upload a file for a file custom field

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

multipart/form-data
file
file
required

The file bytes, sent as the only part of a multipart/form-data body; the part's filename names the file. Max 25MB. Allowed extensions: .pdf, .doc, .docx, .xls, .xlsx, .ppt, .pptx, .csv, .png, .jpg, .jpeg, .gif, .webp, .heic, .zip. The part's content type must match the extension, and the bytes are checked against it.

Response

201 - application/json

An uploaded file of a file field. Put it in a lead or deal value as { file: [{ uuid }] } within 24 hours, or it is deleted.

An uploaded file of a file field. Put it in a lead or deal value as { file: [{ uuid }] } within 24 hours, or it is deleted.

uuid
string
required
file_name
string | null
required
mime_type
string | null
required
size
number | null
required