Delete an alias

Deletes an alias. The underlying agents the alias points at are not affected. A platform-generated alias fronted by a widget connector cannot be deleted directly (409); it is deleted with its connector. Returns 409 if any live resources still reference this alias.

delete/v2/agent_aliases/{alias_key}

Path parameters

alias_keystring required

The unique key that identifies an alias. Alias keys are independent of agent keys. The same string can exist as both an alias key and an agent key in the same customer account. Calls to /v2/agent_aliases/{key}/... target the alias. Calls to /v2/agents/{key}/... target the agent.

Example:support

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

The alias is deleted.

Changes

No recorded changes to this endpoint across all 7 revisions of this API.