Exclude cohort

POST

https://apps.sarvam.ai/api/scheduling/v1/orgs/:org_id/workspaces/:workspace_id/campaigns/:campaign_id/cohorts/upload

POST

/api/scheduling/v1/orgs/:org_id/workspaces/:workspace_id/campaigns/:campaign_id/cohorts/upload

import requests
url = "https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns/campaign_id/cohorts/upload"
files = {
    "cohort_file": open("string", "rb"),
    "cohort_transformation_file": open("string", "rb")
}
payload = {
    "name": "April Batch 1"
}
headers = {"X-API-Key": "<your-api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.json())

{
  "name": "April Batch 1",
  "cohort_id": "coh-x1y2z3",
  "status": "completed",
  "source_type": "file_upload",
  "cohort_category": "cohort",
  "created_by": "user@company.com",
  "created_at": "2026-04-01T09:00:00Z",
  "updated_at": "2026-04-01T09:05:00Z",
  "result": {
    "total_records": 10000,
    "valid_records": 9750,
    "rejected_records": 250
  },
  "updated_by": null
}

Upload a cohort as multipart form-data with three fields:

name — Cohort name (1–50 characters)
cohort_file — CSV file with a header row and at least one data row
cohort_transformation_file — JSON file that maps CSV columns to phone numbers and agent variables

Set cohort_category to stop_file to exclude users already on this campaign. It defaults to cohort.

Path parameters

org_idstringRequired

workspace_idstringRequired

campaign_idstringRequired

Request

This endpoint expects a multipart form with multiple files.

namestringRequired

Name of the resource

cohort_categoryenumOptional

cohort adds contacts. stop_file is an exclude cohort for users already on this campaign. Defaults to cohort.

Allowed values:

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

Allowed values:

source_typeenum

How the cohort was uploaded

Allowed values:

cohort_categoryenum

cohort is a contact batch. stop_file is an exclude cohort for users already on this campaign.

Allowed values:

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 nullOptional

Processing result with record counts

updated_bystring or nullOptional

User who last updated this resource

Errors

422

Unprocessable Entity Error

Path parameters

Headers

Request

Response

Errors