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 to add to the user or lead's custom data attributes. Values are strings. Numbers and booleans are converted to strings. An empty string, or any array or object value, returns a 422 error with the key context. A null value is ignored.

Example:

{
  "issue_type": "Billing",
  "priority": "High"
}

bodystring

The text of the contact's first message. When you send it, a conversation is created straight away with this text as its first message.

Example:"I need help with my invoice"

send_notificationboolean

Whether to send the SMS with the link to the Messenger. When false, no SMS is sent.

Default:true

Example:true

user_input_phonestring or null

The phone number as the contact typed it, in national format. When sent with country, used in place of phone to read the number. phone is still required.

Example:"087 234 5678"

countrystring or null

The two-letter country code used to read user_input_phone. When country is US, Intercom also looks up the carrier to detect landlines.

Example:"IE"

{
  "phone": "+1 1234567890",
  "custom_attributes": {
    "issue_type": "Billing",
    "priority": "High"
  },
  "body": "I need help with my invoice",
  "send_notification": true,
  "user_input_phone": "087 234 5678",
  "country": "IE"
}