Skip to main content
FormsVersion: v3

Upload files to custom fields

POST/forms/upload-custom-files

Post the necessary fields for the API to upload files. The files need to be a buffer with the key "< custom_field_id >_< file_id >".
Here custom field id is the ID of your custom field and file id is a randomly generated id (or uuid)
There is support for multiple file uploads as well. Have multiple fields in the format mentioned.
File size is limited to 50 MB.

The allowed file types are:

  • PDF
  • DOCX
  • DOC
  • JPG
  • JPEG
  • PNG
  • GIF
  • CSV
  • XLSX
  • XLS
  • MP4
  • MPEG
  • ZIP
  • RAR
  • TXT
  • SVG


The API will return the updated contact object.

Authorizations

Authorizationstringheaderrequired

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

Scope:forms.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Query Parameters

contactIdstringrequired

Contact ID to upload the file to.

Example:dtEv6KtI27yF92YPm3Zz
locationIdstringrequired

Location ID of the contact.

Example:quXmPY59n1zgGBabY1bZ

Response

Successful response