Campaigns
Campaigns

Stop calling a recipient

Stop one recipient on a SCHEDULED, RUNNING or PAUSED campaign so the dialer never calls them again. A recipient waiting to be called becomes cancelled with the outcome stopped. If their call is in progress it finishes normally: a call that connects keeps its result, and any other ends as cancelled, stopped, with no retry. It does not add the number to the do-not-call list.

POST
/workspaces/{workspace}/campaigns/{campaign}/recipients/{recipient}/stop

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token from Settings > API tokens.

In: header

Path Parameters

workspace*string

Workspace slug (GET /me lists yours).

campaign*string
recipient*string

Header Parameters

Idempotency-Key?string

A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/workspaces/string/campaigns/string/recipients/string/stop" \  -H "Content-Type: application/json" \  -d '{}'
{
  "recipient": {
    "id": "string",
    "phoneNumber": "string",
    "status": "string",
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}

Book or cancel a recipient's callback PUT

Book, move or cancel a callback for one recipient on a RUNNING or PAUSED campaign. The agent books one itself when the person asks to be called back; this changes it. date (YYYY-MM-DD) and time (24-hour HH:MM) are in the recipient's own local time and must be inside the campaign's calling hours there, at least 5 minutes and at most 30 days ahead; a time outside them is refused with the next time the campaign may call. The recipient then waits with the outcome callback_scheduled, the dialer calls them at that time, and the callback uses no attempt and replaces any pending retry. Pass cancel: true instead to drop the callback: a recipient waiting only for it settles back to the result of their last call. A recipient whose call is in progress keeps the call, and the change applies when it ends. Every change is audited.

Update a campaign PATCH

Change a campaign's settings, under the campaign page's rules. A DRAFT can change anything. A SCHEDULED, RUNNING or PAUSED campaign can change only name, fromNumber, numberPool, maxConcurrency, maxCallsPerHour, spendCapCents, autoEnroll and routeReturnCalls (others are refused as draft_only, and the numbers never to none, number_pool_empty), and in its sequence only wording, voicemails, delays, retry gaps, double dial and converted outcomes (others are refused as sequence_locked). A COMPLETED or CANCELLED campaign can change only convertedOutcomes and routeReturnCalls. Pass only what changes; null clears brief, greetingOverride, fromNumber (with the pool, on a draft), callingWindow, smsWindow, voicemail, spendCapCents and maxCallsPerHour. Raise spendCapCents here before resuming a campaign its cap paused.