Create cohort

View as Markdown

Create a cohort from a pre-signed URL source with a transformation configuration. Use this when your CSV is already hosted and accessible via a URL.

Path parameters

org_idstringRequired
workspace_idstringRequired
deployment_idstringRequired

Request

This endpoint expects an object.
namestringRequired
sourceobjectRequired
Source of the cohort data
cohort_transformationobjectRequired
Configuration for how CSV columns map to phone numbers and 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