Opt Out

Suppress the lead (phone + every channel per policy) and stop their sequences. Idempotent; accepted even after the call completed.

API key access

This route has its own authentication (or none); an API key is not used here.

POST/api/v1/calls/{call_id}/opt-out

Authorization

AuthorizationBearer <token>

Per-call token issued when the call was created (job metadata api_token).

In: header

Path Parameters

call_idstring

Formatuuid

Header Parameters

X-Workspace-Id?string | null

Workspace of the call (must match the token).

Request Body

lead_idstring

Formatuuid

reason?string

Default""

Lengthlength <= 2000

channels?array<string>

Itemsitems <= 4

Response Body

curl -X POST "http://localhost:8000/api/v1/calls/497f6eca-6276-4993-bfeb-53cbbbba6f08/opt-out" \
  -H "X-Workspace-Id: string" \
  -H "Content-Type: application/json" \
  -d '{
    "lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0"
  }'

curl -X POST "http://localhost:8000/api/v1/calls/497f6eca-6276-4993-bfeb-53cbbbba6f08/opt-out" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{    "lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0"  }'

Empty

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

204

422