Setup contact card
Activate the authenticated agent’s Contact Card.
curl --request POST \
--url https://api.staging.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",
"rive": {
"file": "https://cdn.relayapp.im/rive/0199a000-0000-7000-8000-00000000000b/1790000000000/file-0123456789abcdef.riv",
"artboard": "Call",
"state_machine": "Main",
"view_model": "Main"
},
"description": "<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>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}Authorizations
Bearer token authentication. Include your API token in the Authorization header.
Format: Authorization: Bearer <your-token>
Body
First name for the contact card. Required. At most 30 characters.
1 - 30Relay Handle associated with this contact card.
Last name for the contact card. Optional.
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.
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.
Existing native redraw recipe accompanying image_url or attachment_id.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Response
Contact card created/updated and sync attempted
First name on the contact card
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.
^[0-9A-F]{6}$Whether the contact card was successfully applied to the device
Relay Handle associated with this contact card.
Whether the Contact is a user or an agent.
user, agent The Rive file this agent shows in its calls, or null. Set it with PATCH rive.
Show child attributes
Show child attributes
Detailed agent description. Required for public agents; null clears it otherwise.
2000curl --request POST \
--url https://api.staging.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",
"rive": {
"file": "https://cdn.relayapp.im/rive/0199a000-0000-7000-8000-00000000000b/1790000000000/file-0123456789abcdef.riv",
"artboard": "Call",
"state_machine": "Main",
"view_model": "Main"
},
"description": "<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>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}