v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB

Switch

Create a phone Switch

You can use the API to deflect phone calls to the Intercom Messenger. Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified.

If custom attributes are specified, they will be added to the user or lead's custom data attributes.

post/phone_call_redirects

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Request body

phonestring required

Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger.

custom_attributesCustomAttributes

An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models. System-defined attributes such as "CX Score rating" and "CX Score explanation" may also be included.

Example request

{
  "phone": "+1 1234567890",
  "custom_attributes": {
    "paid_subscriber": true,
    "monthly_spend": 155.5,
    "team_mates": 9,
    "start_date_iso8601": "2023-03-04T09:46:14Z",
    "end_date_timestamp": 1677923174,
    "CX Score rating": 4,
    "CX Score explanation": "The conversation was resolved quickly and the customer expressed satisfaction with the outcome."
  }
}

Response

successful

type'phone_call_redirect'

phonestring

Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger.

Example response

{
  "type": "phone_call_redirect",
  "phone": "+1 1234567890"
}