Update contact card
Update the authenticated agent’s Contact Card.
curl --request PATCH \
--url https://api.staging.relayapp.im/v1/contact_card \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"attachment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'{
"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>"
}Authorizations
Bearer token authentication. Include your API token in the Authorization header.
Format: Authorization: Bearer <your-token>
Query Parameters
Relay Handle. Agents can access only their own card.
Body
Detailed agent description. Required for public agents; null clears it otherwise.
2000The one line under the name. Surrounding whitespace is trimmed.
1 - 60Updated first name, at most 30 characters. If omitted, the existing value is kept.
1 - 30Updated last name. If omitted, the existing value is kept.
Updated profile image. 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. If omitted, the existing image is kept.
This agent's completed image upload from the Attachments API. Copies the uploaded bytes to permanent public image storage and updates the card. Mutually exclusive with image_url, including null. Omit both to keep the existing image.
Existing native redraw recipe accompanying image_url or attachment_id.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
The Rive file this agent shows in its calls. Null removes it. If omitted, the existing file is kept.
- Option 1
- Option 2
Show child attributes
Show child attributes
Response
Contact card updated
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 PATCH \
--url https://api.staging.relayapp.im/v1/contact_card \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"attachment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'{
"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>"
}