Operations
Operations

Set caller routing

Mark one caller (by phone number) for priority routing: an inbound call from them is bridged straight to a human, skipping the agent. Creates the caller's profile if none exists yet. Pass destination to route them somewhere other than the agent's own transfer number; omit it to use the agent's transfer_to_human destination at call time. Refused if auto_transfer is true and neither this caller's destination nor the agent's own transfer_to_human is set: call add_builtin_tool with transfer_to_human (or set_builtin_config) first, or pass a destination here. Use when the operator says things like 'always put Jordan straight through to a person' or 'route calls from +61400000000 to reception'.

POST
/operations/set_caller_routing

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token from Settings > API tokens.

In: header

Header Parameters

Idempotency-Key?string

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.

Length1 <= length <= 255

Request 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_caller_routing" \  -H "Content-Type: application/json" \  -d '{    "caller_number": "string",    "auto_transfer": true,    "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
}

Update caller memory POST

Configure caller memory, remembering a caller by phone number across calls and personalising the next one. Off by default. Fields (all optional, send only what changes): mode ('off' | 'on'); greeting ('use_in_conversation' = use the name naturally mid-call | 'greet_in_opener' = personalise the first line); identity ('confirm' = soft-confirm 'Am I speaking with Sam?' | 'trust' = greet by name outright | 'silent' = use quietly); conflict ('confirm' | 'latest' | 'append', what to do when this call's details differ from what's stored); recentStore (1-20, default 5, how many past calls to remember per caller); recentInject (1-6, default 2, how many remembered calls to bring into a call). Use when the user says 'remember callers', 'greet repeat callers by name', 'don't ask returning callers who they are', or 'remember more/fewer of their past calls'. To let a pre-call lookup that finds the caller by phone number count for low-risk details such as booking times, set phoneMatchLowRisk with update_agent_settings.

Set website surface POST

Switch one of the agent's website surfaces on or off: 'text' (the embeddable chat panel, via /api/embed/chat) or 'voice' (the embeddable call pill, via /api/embed/start). The brain, prompt, tools, knowledge base, is shared with the phone agent; a surface only decides how that brain reaches people, and every piece of copy lives in Build. You still need a publishable key (create_publishable_key) with the website's origin allow-listed before a page can connect.