Skip to main content
POST
Upload conversations via CSV file

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique Avido Application ID

Body

multipart/form-data

Request for uploading conversations via CSV file

file
any
required

CSV file containing conversations

fileName
string
required

Name for this import

Required string length: 1 - 256
Example:

"Support Conversations Q1 2024"

quickstartId
string<uuid>

ID of the quickstart this upload belongs to.

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)$
Example:

"456e7890-e89b-12d3-a456-426614174001"

processFile
boolean
default:true

Whether to process the file asynchronously via background job. Defaults to true.

Example:

true

Response

CSV file uploaded and queued for processing successfully