Skip to main content
POST
Send a contact card
Send a contact card (vCard) over iMessage or SMS. On iPhone it lands as a tappable contact. Scope: comms_send Pass agent_id to send a hosted agent’s card (name, line, claim note). Or pass name and phone for any contact.

Request

Hosted agent card:

Body parameters

string
E.164 destination. Required unless conversation_id or contact_id is set.
string
Existing conversation to continue. Required unless to or contact_id is set.
string
Existing contact. Required unless to or conversation_id is set.
string
Hosted agent whose saved card to send. Fills name and phone when those are omitted.
string
Display name saved on the card. Required unless agent_id is set.
string
E.164 number saved on the card. Required unless agent_id is set.
string
Optional email on the card.
string
Optional organization on the card.
string
Optional note (for example a claim handle).
string
HTTPS JPEG, PNG, or GIF (max 200KB) shown as the contact photo. Hosted agent_id cards default to the agent’s photo, then the Comms mark.
string
Same image as raw base64 or a data:image/...;base64, URL.
string
Optional text sent with the card. Defaults to the contact name.
string
sms, imessage, or omit for auto.

Response

Same envelope as Send a message, plus contact_card.
Hosted Comms agents can also send this with the send_contact_card tool — they default the card to their own name, line, and photo.