Share contact card
Stage the contact card (Name & Photo) for sharing in a chat. The contact card will be piggybacked onto the next outgoing message (text or attachment) sent to this chat. This is idempotent — calling it multiple times is harmless.
⚠️ Plan requirement: Contact card sharing is only available on Dedicated Commercial and Dedicated Enterprise plans. Numbers on other plans receive a 403.
Authorization
BearerAuth API key authentication. Use your API key as the bearer token.
In: header
Path Parameters
Chat identifier. Can be: (1) phone number in E.164 format (e.g., +15551234567), (2) email address, (3) group ID (grp_xxxx), or (4) comma-separated list of phone numbers/emails for multi-recipient group chats (e.g., +15551234567,+15559876543). All values should be URL-encoded.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/chats/%2B15551234567/contact-card"{
"success": true,
"chat_id": "string",
"message": "Contact card staged. It will be sent with the next outgoing message in this chat."
}{
"error": "string",
"message": "string",
"status": 0,
"code": "string"
}{
"error": "string",
"message": "string",
"status": 0,
"code": "string"
}{
"error": "string",
"message": "string",
"status": 0,
"code": "string"
}