Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Compliance

Put Calling Policy

Replace the workspace's calling-policy overrides (admin+; `{}` clears them). Overrides only restrict: narrower hours, extra closed dates, lower call/text caps. A wider window or a higher cap than a legal pack's has no effect for that pack. 422 with the reason when invalid.

API key access

Needs the admin scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
PUT/api/v1/workspaces/current/calling-policy

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

Header Parameters

X-Workspace-Id?string | null

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

Request Body

hours?CallingHoursIn | null
caps?array<FrequencyCapRule>

Call caps (count outbound calls).

sms_caps?array<FrequencyCapRule>

Text caps (count outbound texts, sms_sent).

blocked_dates?array<string>
Itemsitems <= 366

Response Body

curl -X PUT "http://localhost:8000/api/v1/workspaces/current/calling-policy" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "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": {}
    }
  ]
}

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`).

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.