Compliance
Contactability
Whether the lead may be contacted on `channel` for `purpose` right now, and why.
API key access
Needs the
leads:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.GET
/api/v1/leads/{lead_id}/contactabilityAuthorizationBearer <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
Format
uuidQuery Parameters
channelChannel
Value in
"email" | "phone" | "sms" | "linkedin"purpose?ConsentPurpose
Value in
"marketing" | "transactional"Header Parameters
X-Workspace-Id?string | null
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08/contactability?channel=email&purpose=marketing" \ -H "X-Workspace-Id: string"{
"lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
"channel": "email",
"purpose": "marketing",
"allowed": true,
"reasons": [
"string"
],
"policy": "string",
"next_allowed_at": "2019-08-24T14:15:22Z",
"calling": {}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}Add Suppression
Suppress an email, phone, domain or LinkedIn URL. 409 (with `existing_id`) if present. In-flight sequence enrollments of matching leads that can no longer reach them on any channel they use stop (`suppressed`).
Create Consent
Record a consent with its evidence. 422 if the lead has no address for the channel.