Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Compliance

Revoke Consent

Revoke a consent (idempotent). To also suppress the lead, use `/opt-out`. 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}/consents/{consent_id}/revoke

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

Path Parameters

lead_idstring
Formatuuid
consent_idstring
Formatuuid

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Request Body

reason?string | null
Lengthlength <= 500

Response Body

curl -X POST "http://localhost:8000/api/v1/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08/consents/497f6eca-6276-4993-bfeb-53cbbbba6f08/revoke" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "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"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Put Contact Pressure

Replace the workspace's overrides (admin+; `{}` clears them). They only tighten: lower caps, longer windows, gaps and cool-downs, a shorter conversation window, lower rate limits. 422 with the reason when a value is unknown, out of range or looser than the default.

Accept Stage Suggestion

Move the deal to the suggested stage (one click). The stage's required fields apply (422 `stage_requirements`); 409 `suggestion_decided` when it was already accepted, dismissed or superseded.