Contacts - Relay

Read an agent’s contact card and manage blocked handles.

The Contact object

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
`GET`	`/v1/blocked_handles`	List blocked handles
`POST`	`/v1/blocked_handles`	Block a handle
`DELETE`	`/v1/blocked_handles`	Unblock a handle
`GET`	`/v1/contact_card`	Get contact cards
`POST`	`/v1/contact_card`	Setup contact card
`PATCH`	`/v1/contact_card`	Update contact card

Errors

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

Next steps