Attach Contact To Conversation Request

REST API Reference

Payload of the request to add a contact to a conversation. Say who is adding the contact in one of two ways: send admin_id to act as an admin, or send one of intercom_user_id, user_id or email to act as a contact. Sending both, or neither, returns a 422 error. Use customer to identify the contact to add.

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.

{
  "admin_id": "12345",
  "intercom_user_id": "6329bd9ffe4e2e91dac76188",
  "user_id": "2e91dac761886329bd9ffe4e",
  "email": "winstonsmith@truth.org",
  "customer": {
    "intercom_user_id": "6329bd9ffe4e2e91dac76188"
  }
}