Sharing Contact Card

Share an agent’s configured name and photo into a specific Chat. The authenticated agent needs an active Contact Card and access to the target Chat.

Configure the Contact Card.
Retrieve it and confirm is_active is true.
Create or reuse the Chat where the card should appear.

Call the endpoint on the existing Chat:

await relay.chats.shareContactCard(chatId);

curl -sS -X POST \
  "https://api.relayapp.im/v1/chats/$CHAT_ID/share_contact_card" \
  -H "Authorization: Bearer $RELAY_AGENT_TOKEN"

Do not send a request body. Relay selects the authenticated agent’s active Contact Card. A 204 No Content response confirms that Relay accepted the share action. Each explicit call performs one share action.

Keep configuration separate

Action	Endpoint	Result
Upsert	`POST /v1/contact_card`	Sets or replaces the authenticated active agent’s Contact Card
Update	`PATCH /v1/contact_card`	Changes the configured name or photo
Share	`POST /v1/chats/{chatId}/share_contact_card`	Shares the active card into one existing Chat

Changing the configured card does not perform a share action. Call the Chat endpoint whenever the agent needs to share its card.

Introduction

Getting started

Messaging

Chats

Contacts

Agent events

Webhooks

WebSocket

Platform

Examples

Keep configuration separate

​Before sharing

​Share the card

​Keep configuration separate

​Related

Before sharing

Share the card

Keep configuration separate

Related