Attach a contact to a conversation

Request

You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.

Contacts without an email

If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead.

If the conversation is a ticket, the access token must include the write_tickets scope. Without it, the request returns a 401 with the error code token_unauthorized.

Security

bearerAuth

Path

idstringrequired

The identifier for the conversation as given by Intercom.

Example:123

Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:Preview

Bodyapplication/json

admin_idstring

The id of the admin who is adding the new participant. Send this to act as an admin.

Example:"12345"

intercom_user_idstring

The identifier, as given by Intercom, of the contact who is adding the new participant. Send this, user_id or email to act as a contact.

Example:"6329bd9ffe4e2e91dac76188"

user_idstring

The external_id you have defined for the contact who is adding the new participant.

Example:"2e91dac761886329bd9ffe4e"

emailstring

The email of the contact who is adding the new participant.

Example:"winstonsmith@truth.org"

customer(Intercom User ID (object or null)) or (User ID (object or null)) or (Email (object or null))(customer_request)required

One of:

The contact to add as a participant. Identify them with exactly one of intercom_user_id, user_id or email.

curl -i -X POST \
  https://api.intercom.io/conversations/123/customers \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: Preview' \
  -d '{
    "admin_id": 991267731,
    "customer": {
      "intercom_user_id": "6762f19b1bb69f9f2193bbd4"
    }
  }'

Responses

Attach a contact to a conversation

Bodyapplication/json

customersArray of objectsrequired

The conversation participants after the change

Example:

[
  {
    "type": "user",
    "id": "6762f1a61bb69f9f2193bbd8"
  }
]

Response

{
  "customers": [
    { … }
  ]
}