Messages

Send a contact card

Text someone a contact card they can save, over iMessage or SMS. Pass agent_id to send an agent's card, or name and phone for anyone else. Scope: comms_send.

post/contact-cards

Request

  • Base URL: https://osis.co/api/v1/comms
  • URL: https://osis.co/api/v1/comms/contact-cards
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Lets you retry safely. Wins over idempotency_key in the body.

Request body

OR
OR
OR
OR
OR

Example request

{
  "to": "+12125550147",
  "contact_id": "ctc_01HZX",
  "conversation_id": "conv_01HZX",
  "agent_id": "agent_01HZX",
  "name": "Jane Doe",
  "phone": "+12125550199",
  "photo_url": "https://example.com/contact.jpg",
  "default_country": "US"
}

Response

Already sent with this idempotency key. Returns the first result.

duplicateboolean

Changes

No recorded changes to this operation across all 1 revision of this API.