Opt Out

The lead asked us to stop: revoke consents and suppress their address(es). In-flight sequence enrollments that can no longer reach the lead on any channel they use stop (`opted_out`).

API key access

Needs the compliance:write scope with an API key (ro_pat_...). A signed-in session uses the caller's role.

POST/api/v1/leads/{lead_id}/opt-out

Authorization

AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

source?string

Default"manual"

Lengthlength <= 64

all_channels?boolean | null

Suppress every channel; default follows the workspace policy (true)

reason?SuppressionReason

Default"opt_out"

note?string | null

Lengthlength <= 500

Response Body

curl -X POST "http://localhost:8000/api/v1/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08/opt-out" \
  -H "X-Workspace-Id: string" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "email"
  }'

curl -X POST "http://localhost:8000/api/v1/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08/opt-out" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{    "channel": "email"  }'

{
  "revoked": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
      "lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
      "channel": "email",
      "consent_type": "express_written",
      "purpose": "marketing",
      "contact_value": "string",
      "source": "string",
      "evidence": {
        "property1": null,
        "property2": null
      },
      "captured_at": "2019-08-24T14:15:22Z",
      "revoked_at": "2019-08-24T14:15:22Z",
      "revoked_reason": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "suppressions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
      "kind": "email",
      "value": "string",
      "reason": "opt_out",
      "channels": [
        "email"
      ],
      "source": "string",
      "note": "string",
      "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

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

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

Opt Out

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200

422