Upload file attachments

POST 
/conversations/messages/upload

Post the necessary fields for the API to upload files. The files need to be a buffer with the key "fileAttachment".

Note: One of conversationId or contactId must be provided.

File Size Limits:

• Maximum file size: 5 MB
• Maximum files per upload: 5

Allowed file types:

Images: JPG, JPEG, PNG, GIF, SVG, HEIC, AI

Videos: MP4, MPEG, 3GP

Audio: MP3, WAV, WAVE, AIFF, AIF, AIFC, GSM, ULAW, OGG, AAC, M4A, AMR

Documents: PDF, DOC, DOCX, TXT, CSV, XLS, XLSX, PPT, PPTX, ODT

Archives: ZIP, RAR

Other: VCF, VCARD (contact files), ICS (calendar files)

The API will return an object with the URLs

Request

Version stringrequired

API Version

Available optionsv3

multipart/form-data

multipart/form-data

Body

Bodyrequired

conversationIdstring

Conversation Id

contactIdstring

Contact Id

workflowIdstring

Workflow Id

campaignIdstring

Campaign Id

locationIdstringrequired
attachmentUrlsstring[]required

Example (auto)

{
  "conversationId": "ve9EPM428h8vShlRW1KT",
  "contactId": "ve9EPM428h8vShlRW1KT",
  "workflowId": "ve9EPM428h8vShlRW1KT",
  "campaignId": "ve9EPM428h8vShlRW1KT",
  "locationId": "string",
  "attachmentUrls": [
    "string"
  ]
}

application/json

Uploaded the file successfully

application/json

Schema

Schema

uploadedFilesobjectrequired

Example (auto)

{
  "uploadedFiles": {}
}