CRMchat APIBeta
Outreach Campaigns

Get campaign

GET
/workspaces/{workspaceId}/outreach/sequences/{sequenceId}

Returns a single outreach campaign by its ID.

Authorization

bearerAuth
AuthorizationBearer <token>

API key (sk_...) as Bearer token

In: header

Path Parameters

workspaceId*string
sequenceId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/workspaces/string/outreach/sequences/string"
{  "data": {    "createdAt": "2019-08-24T14:15:22Z",    "createdBy": "string",    "updatedAt": "2019-08-24T14:15:22Z",    "estimatedLastMessageAt": null,    "schedulingStatusReason": "outside_planning_window",    "workspaceId": "string",    "listId": "string",    "name": "string",    "status": "draft",    "accounts": {      "mode": "all",      "selected": [        "string"      ],      "conversationStrategy": "prefer-existing-dialog"    },    "contactOwnerSettings": {      "ownerIds": [        "string"      ]    },    "contactCreationTrigger": "on-reply",    "contactDefaults": {      "property1": "string",      "property2": "string"    },    "contactUpdatesOnReply": {      "property1": "string",      "property2": "string"    },    "messages": [      {        "id": "string",        "delay": {          "period": "minutes",          "value": 0        },        "text": "string",        "type": "text"      }    ],    "duplicationResolutionNeeded": true,    "totalLeads": 0,    "completedLeadsCount": 0,    "id": "string"  }}

List campaigns GET

Returns a paginated list of outreach campaigns in a workspace.

Create campaign POST

Creates an outreach campaign for an existing list and triggers list processing. A list must be created first using the lists endpoints. See [Creating and Starting a Campaign](/docs/api/campaigns#creating-and-starting-a-campaign) for the complete flow.