Sign in

v3

latestOpenAPI 3.0.02026-08-081996601.2 MB
Agent Aliases

Update an alias's metadata

Updates an alias's metadata fields (name, description, enabled, metadata). To replace the routing policy, use PUT /v2/agent_aliases/{alias_key}/policy. Policies are atomic and do not support partial updates.

patch/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.

Request body

namestring
descriptionstring
enabledboolean
metadataobject

Response

The updated 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.

namestring required

A human-readable name for the alias.

descriptionstring nullable

A longer description of what this alias represents.

enabledboolean required

Whether this alias is currently invocable.

metadataobject nullable

Arbitrary metadata associated with the alias.

created_atstring date-time required

Timestamp when the alias was created.

updated_atstring date-time nullable

Timestamp when the alias was last updated.

Example response

{
  "key": "support",
  "name": "Customer Support",
  "policy": {
    "rules": [
      {
        "match": "(get('$.session.metadata.tenant') == 'us') and (get('$.session.metadata.tier') == 'gold')",
        "targets": {
          "partition_by": "get('$.session.metadata.user_id', '')"
        }
      }
    ]
  }
}