Messages

Set an agent contact card

Set the name and photo people see for an agent on a dedicated line, on its card and in iMessage. The phone number is always the agent's dedicated line. Agents on a shared line return 409 dedicated_line_required. Scope: comms_send.

put/contact-cards

Request

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

Request body

agent_idstring required

The agent whose card you're setting. It must be on a dedicated line.

namestring

The name on the card and in the iMessage contact prompt. Leave it out to keep the current name.

emailstring nullable

An email for the card. Leave it out to keep the current one. Send null or an empty string to remove it.

notestring nullable

A note for the card. Leave it out to keep the current one. Send null or an empty string to remove it.

photo_urlstring uri

An HTTPS link to a JPEG, PNG, or GIF, up to 200,000 bytes.

photo_base64string

A JPEG, PNG, or GIF as base64 or a data:image/...;base64, URL. Up to 200,000 bytes.

clear_photoboolean

Remove the saved photo. Wins over photo_url and photo_base64.

Example request

{
  "agent_id": "agent_01HZX",
  "name": "Jane Doe",
  "photo_url": "https://example.com/contact.jpg"
}

Response

The saved card, and whether the line is using it yet

Changes

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