CRMchat APIBeta
Outreach Campaigns

Create CRM list

POST
/workspaces/{workspaceId}/outreach/lists

Creates a list from CRM contacts or groups with optional filters.

Authorization

bearerAuth
AuthorizationBearer <token>

API key (sk_...) as Bearer token

In: header

Path Parameters

workspaceId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

contactType*string

Value in

  • "contact"
  • "group"
name*string
Length1 <= length
dynamic*boolean
filters*

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/workspaces/string/outreach/lists" \  -H "Content-Type: application/json" \  -d '{    "contactType": "contact",    "name": "string",    "dynamic": true,    "filters": {      "property1": [        "string"      ],      "property2": [        "string"      ]    }  }'
{  "data": {    "createdAt": "2019-08-24T14:15:22Z",    "createdBy": "string",    "updatedAt": "2019-08-24T14:15:22Z",    "workspaceId": "string",    "name": "string",    "source": {      "fileUrl": "string",      "fileName": "string",      "usernameColumn": "string",      "phoneColumn": "string",      "columns": [        "string"      ],      "type": "csvFile"    },    "status": "pending",    "totalSize": 0,    "importStats": {      "imported": 0,      "skippedMissingIdentifier": 0,      "skippedInvalidPhone": 0,      "skippedDuplicate": 0    },    "id": "string"  }}

Upload CSV list POST

Uploads a CSV or TSV file and creates a list. Columns are automatically inferred from the file header.

Find dialogs POST

Finds dialogs across Telegram accounts accessible to the authenticated user. Matches by peer ID, username, or either value when both are provided, and returns the most recently updated dialogs first.