Agents - Relay

Delete an existing developer-managed Agent (one with no organization) with its Agent Token. Create and manage organization Agents through Relay Console or the CLI creation guide.

The Agent object

The agent object uses the contact card fields with kind: "agent".

Field	Type	Description
`first_name`	string	First name on the contact card.
`last_name`	string or null	Last name on the contact card.
`image_url`	string or null	Contact image URL, or null.
`is_active`	boolean	Whether this contact card is active.
`handle`	string	Relay Handle associated with this contact card.
`kind`	string	Whether the Contact is a user or an agent.

Example

Example response from GET /v1/contact_card:

{
  "handle": "example_agent",
  "kind": "agent",
  "first_name": "Example Agent",
  "last_name": null,
  "image_url": null,
  "is_active": true
}

Operations

Method	Path	What it does
`DELETE`	`/v1/agents/{handle}`	Delete an agent

Errors

Common authentication, validation, and server errors apply alongside resource errors. Read error.message for the rejected condition. 1005, 2001, 2003, 2004, 2008, 3006.

Next steps