Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Workspaces

Put Live Transfer Settings

Set the live warm-transfer target (admin+): the team's own ``phone_number`` (E.164, preferred; never one of the workspace's leads) and/or a ``sip_uri``, how long it rings (``ring_timeout_seconds``, 10-60) and when transfers are allowed (``availability``: ``business_hours``, ``always`` or ``custom`` with ``hours``). Saved even without a SIP trunk (transfers then degrade to the handoff task). 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/transfer

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

enabledboolean
phone_number?string | null

The team's own E.164 line (preferred), dialled through the call's SIP trunk; never a lead's number.

Lengthlength <= 16
sip_uri?string | null

sip:user@host[:port] (or sips:), used when there is no phone number.

Lengthlength <= 255
ring_timeout_seconds?integer | null

How long the team line rings before the handoff task is used instead; absent: 25.

Formatint32
Range10 <= value <= 60
availability?TransferAvailability | null
hours?CallingHoursIn | null

Response Body

curl -X PUT "http://localhost:8000/api/v1/workspaces/current/transfer" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{    "enabled": true  }'
{
  "enabled": true,
  "phone_number": "string",
  "sip_uri": "string",
  "ring_timeout_seconds": 0,
  "availability": "business_hours",
  "hours": {},
  "sip_available": true,
  "configured": true,
  "updated_at": "2019-08-24T14:15:22Z",
  "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Put Business Hours

Replace the business hours (admin+); ``{}`` restores the defaults. At least one day must be open and each open day must fit one meeting. 422 with the reason when invalid.

Put Profile

Create or update the profile (admin+). Omitted fields are unchanged; `null` or blank text clears a field; `icp` replaces the whole ICP. 422 for an invalid website.