Upload cohort

View as Markdown
Upload a cohort of users for a deployment. When a known user calls in, the agent receives their personalized variables (name, balance, language, etc.) for a tailored conversation. Upload as multipart form-data with three fields: - `name` — Cohort name (1–50 characters) - `cohort_file` — CSV file with a header row and user data - `cohort_transformation_file` — JSON file that maps CSV columns to phone numbers and agent variables

Path parameters

org_idstringRequired
workspace_idstringRequired
deployment_idstringRequired

Request

This endpoint expects a multipart form with multiple files.
namestringRequiredformat: "^[\w\- ]{1,50}$"<=50 characters

Cohort name (1-50 characters)

cohort_filefileRequired
CSV file containing the cohort data
cohort_transformation_filefileRequired
JSON file defining how CSV columns map to agent variables

Response

Successful Response
namestring
Name of the resource
cohort_idstring
Unique identifier for the cohort
statusenum
Current status
source_typeenum
How the cohort was uploaded
created_bystring
User who created this resource
created_atdatetime

Timestamp when the resource was created (ISO 8601)

updated_atdatetime

Timestamp when the resource was last updated (ISO 8601)

resultobject or null
Processing result with record counts
updated_bystring or null
User who last updated this resource

Errors

422
Unprocessable Entity Error