Create Phone Switch Request Payload

REST API Reference

You can create an phone switch

phonestringrequired

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

Example:"+1 1234567890"

custom_attributesobject(Custom Attributes (write))

The custom attributes which are set on this object, as key-value pairs. For relationship attributes the value should be a list of custom object instance models. Only attributes a caller may set should be sent here — attributes Intercom generates are returned in responses only.

Example:

{
  "paid_subscriber": true,
  "monthly_spend": 155.5,
  "team_mates": 9,
  "start_date_iso8601": "2023-03-04T09:46:14Z",
  "end_date_timestamp": 1677923174
}

{
  "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
  }
}