Setup contact card - Relay

POST

/

v1

/

contact_card

Setup contact card

curl --request POST \
  --url https://api.relayapp.im/v1/contact_card \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "handle": "<string>"
}
'

{
  "first_name": "<string>",
  "last_name": "<string>",
  "image_url": "<string>",
  "image_color": "<string>",
  "is_active": true,
  "handle": "<string>",
  "kind": "user"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

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. At most 30 characters.

Required string length: 1 - 30

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 for the contact card. Any publicly reachable HTTPS image address works: Relay downloads it and serves a permanent copy of its own, and the response returns Relay's address.

attachment_id

string<uuid>

An image uploaded through the existing Attachments API by this authenticated agent. Upload must be complete. Relay copies its bytes from private attachment storage to a permanent public image. Choose this or image_url, not both.

image_recipe

object

Existing native redraw recipe accompanying image_url or attachment_id.

Option 1
Option 2
Option 3

Show child attributes

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

image_color

string | null

required

Dominant colour of the picture at image_url, six uppercase hex digits, computed by Relay once when the picture is set. Null when Relay could not read the picture.

Pattern: ^[0-9A-F]{6}$

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

Setup contact card

curl --request POST \
  --url https://api.relayapp.im/v1/contact_card \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "handle": "<string>"
}
'

{
  "first_name": "<string>",
  "last_name": "<string>",
  "image_url": "<string>",
  "image_color": "<string>",
  "is_active": true,
  "handle": "<string>",
  "kind": "user"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "trace_id": "<string>"
}