Create Contact Request Payload

Home/

REST API Reference

Payload to create a contact

Any of:

Payload to create a contact

rolestring

The role of the contact.

Example:"user"

external_idstring

A unique identifier for the contact which is given to Intercom

Example:"625e90fc55ab113b6d92175f"

email_verifiedboolean or null

Whether the contact has proved they own this email address, for example through a confirmation link or one-time code you sent. Send it together with email. email_verified without email is rejected.

Changing a contact's email resets it to not verified. Intercom reuses leads with a verified email when an inbound email, conversation or ticket matches the address.

Example:true

emailstring

The contacts email

Example:"jdoe@example.com"

phonestring or null

The contacts phone

Example:"+353871234567"

namestring or null

The contacts name

Example:"John Doe"

avatarstring or null

An image URL containing the avatar of a contact

Example:"https://www.example.com/avatar_image.jpg"

signed_up_atinteger or null, (date-time)

(Unix timestamp in seconds) The time specified for when a contact signed up.

Example:1571672154

last_seen_atinteger or null, (date-time)

(Unix timestamp in seconds) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

Example:1571672154

owner_idstring or null

The id of an admin that has been assigned account ownership of the contact

Example:"321"

unsubscribed_from_emailsboolean or null

Whether the contact is unsubscribed from emails

Example:true

custom_attributesobject or null

The custom attributes which are set for the contact

Example:

{
  "paid_subscriber": true,
  "monthly_spend": 155.5,
  "team_mates": 1
}

{
  "role": "user",
  "external_id": "625e90fc55ab113b6d92175f",
  "email_verified": true,
  "email": "jdoe@example.com",
  "phone": "+353871234567",
  "name": "John Doe",
  "avatar": "https://www.example.com/avatar_image.jpg",
  "signed_up_at": 1571672154,
  "last_seen_at": 1571672154,
  "owner_id": "321",
  "unsubscribed_from_emails": true,
  "custom_attributes": {
    "paid_subscriber": true,
    "monthly_spend": 155.5,
    "team_mates": 1
  }
}