Delete an Agent

delete

https://{tenant}/rest/api/v1/agents/{id}

Send {"agent": "name(extension)"} as confirmation. The agent and its license seats are removed, exactly as the admin delete does. A delete is not refused for an agent that is on a call or is the last agent on a skill. Settings stored against the agent's name(extension), such as its skill levels, are left in place, and an agent created later with the same name and extension picks them up again. A refused delete (400, 404 or 409) is a problem document that, like a refused single edit, carries the results body: one REJECTED item naming the agent, with its id when it is a XIMA agent (it still exists), no facets, and the reason in errors. Nothing is deleted. A delete has no dryRun.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

200DELETED.

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.