Set a Default Outbound Caller ID

put

https://{tenant}/rest/api/v1/agents/{id}/default-outbound-caller-id

How a new agent gets its default, once the create has saved it. An edit carrying only the caller ID: checked with the phone system first (409 when not allowed, 502 with nothing saved when the check cannot run), and it pushes no login. The caller ID the agent already has is not a change: it is not checked and nothing is written. label in the body is ignored; the phone system's label is stored. The result's defaultOutboundCallerId carries the value stored.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

A XIMA agent's id, or the exact name(extension) of a XIMA or UC agent, URL-encoded.

Query Params

dryRun

boolean

Defaults to false

Check everything a real write would and save nothing. For an edit that changes a caller ID that includes the check with the phone system; a create carries no caller ID, so its dry run never asks. A dry-run create reports no id. The bulk endpoints refuse this parameter: send dryRun in the body.

Body Params

The PUT body: a caller ID to set as the agent's default. The {label, outboundCallerId} shape GET returns is accepted so a fetched value can be sent back. Other keys are ignored.

outboundCallerId

string

required

length ≥ 1

The caller ID. Missing, empty or blank is 400 CALLER_ID_REQUIRED.

label

string

Ignored: the label stored is the one the phone system gives the caller ID.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200UPDATED, or VALID for a dry run; failures carries CALLER_ID_SAVE_FAILED if the write did not take.

400The request, or a single write's item, is invalid. Nothing was saved.

401Missing or invalid token. The older error shape. On the agent management endpoints a 413 BODY_TOO_LARGE is decided before the token is checked.

404AGENT_NOT_FOUND: no agent with that id or name(extension).

409A conflict with stored configuration, a seat limit, an ambiguous identifier, or a caller ID the agent may not use. Nothing was saved.

413BODY_TOO_LARGE: the request's Content-Length header is over 10 MiB, so it was refused before the body was parsed or the token checked. A chunked body without a Content-Length is not counted. May lack the Link header.

429WRITE_IN_PROGRESS: another agent write is running on this tenant. Agent writes run one at a time and are not queued. Nothing was saved. Retry after a short wait; parallel writes only produce more 429s.

503SETTINGS_BUSY: another settings save, from the web interface or another API, held the tenant's settings lock for too long. Nothing was saved. Retry.