CRMchat APIBeta

Update campaign status

POST
/workspaces/{workspaceId}/outreach/sequences/{sequenceId}/status

Starts or pauses a campaign.

Authorization

bearerAuth
AuthorizationBearer <token>

API key (sk_...) as Bearer token

In: header

Path Parameters

workspaceId*string
sequenceId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

status*string

Value in

  • "active"
  • "paused"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/workspaces/string/outreach/sequences/string/status" \  -H "Content-Type: application/json" \  -d '{    "status": "active"  }'
{  "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"  }}