Get Calling Policy
The calling rules this workspace calls and texts under: its own overrides, the effective hours and frequency caps per legal pack (and US state) after those overrides, and which countries have public-holiday calendars (no calls or texts on a recipient's public holiday).
API key access
compliance:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role./api/v1/workspaces/current/calling-policyAccess 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
Header Parameters
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/workspaces/current/calling-policy" \ -H "X-Workspace-Id: string"{
"overrides": {
"hours": {},
"caps": [
{
"scope": "lead",
"max": 1,
"period": "day"
}
],
"sms_caps": [
{
"scope": "lead",
"max": 1,
"period": "day"
}
],
"blocked_dates": [
"2019-08-24"
]
},
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"rules": [
{
"key": "US",
"policy": "us_tcpa",
"countries": [
"string"
],
"hours": {
"mon": [
"string"
],
"tue": [
"string"
],
"wed": [
"string"
],
"thu": [
"string"
],
"fri": [
"string"
],
"sat": [
"string"
],
"sun": [
"string"
]
},
"caps": [
{
"scope": "lead",
"max": 1,
"period": "day"
}
],
"sms_caps": [
{
"scope": "lead",
"max": 1,
"period": "day"
}
]
}
],
"holidays": {
"first_year": 0,
"last_year": 0,
"countries": [
"string"
]
}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}Delete Suppression
Remove a suppression; the value becomes contactable again (subject to consent).
Get Contact Pressure
The cross-channel contact-pressure rules this workspace sends and calls under (touches per person, company and recipient domain, gaps, the cool-down after a negative reply), the resource rate limits it can lower, its own overrides and what applies after them. Cold touches (sequences) get every rule; a person's one-off action is exempt while the lead is in a conversation with us; lead-initiated threads (reply drafts, requested callbacks, speed-to-lead) are exempt.