Skip to main content
POST
Setup contact card

Authorizations

Authorization
string
header
required

Bearer token authentication. Include your API token in the Authorization header.

Format: Authorization: Bearer <your-token>

Body

application/json
first_name
string
required

First name for the contact card. Required.

handle
string
required

Relay Handle associated with this contact card.

last_name
string

Last name for the contact card. Optional.

image_url
string

Profile image URL for the contact card.

Response

Contact card created/updated and sync attempted

first_name
string
required

First name on the contact card

last_name
string | null
required
image_url
string<uri> | null
required
is_active
boolean
required

Whether the contact card was successfully applied to the device

handle
string
required

Relay Handle associated with this contact card.

kind
enum<string>
required

Whether the Contact is a user or an agent.

Available options:
user,
agent