Set data residency
Set the workspace's data residency, which decides whether a call may ever fall back to a service outside Australia. 'au': when the AI model or the voice fails, the call has no overseas backup, post-call analysis and grading stay in Australia, and agents cannot pick an overseas grading model. 'global': the platform may fall back to the model's overseas provider and to an overseas backup voice, and agents may grade on an overseas model. An agent switched to an overseas model or voice by name uses it under either setting. Applies to every agent in the workspace. A workspace connected to its own cloud account stays 'au'. Requires workspace-admin.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Header Parameters
A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/operations/set_workspace_residency" \ -H "Content-Type: application/json" \ -d '{ "residency": "au", "agent": "string" }'{}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}Set workspace notifications POST
Turn the workspace's observability + simulation notifications on or off and set the recipient email list they all deliver to. Toggles: cronFailure, cronSuccess, resultsCompletion, evalDeferred, dailyReport, weeklyReport, noCallsAlert, frequentCalls, spendCap, agentPublished, transferSpike, agentPerformance, burstUsed, capacityRequestDecided, campaignReply (someone replied to a campaign SMS; on by default, one email per reply), webhookDeliveryFailed (a webhook dropped events after its final retry; on by default, at most one email an hour per webhook). `recipients` REPLACES the list (an empty array clears it, which falls back to the workspace owner). Every field is optional, pass only what you want to change. These are workspace-level, not per-agent. For per-alert delivery of a specific metric alert (email / Slack / webhook), use create_alert or update_alert.
Set workspace slug POST
Change a workspace's URL slug (its stable identity). Validated for format (lowercase letters, numbers, hyphens) and uniqueness. WARNING: every agent handle ('workspace-slug/agent-slug'), share link, and bookmarked URL changes to the new slug, anything addressing the old slug stops resolving. Use rename_workspace to change only the display name (slug stays put).