API ReferenceBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

Attach a contact

Example Single User Request & Response

$ curl https://api.intercom.io/contacts/<id>/tags \
-X POST \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json' -d

{
    "id": "2084335"
}
HTTP/1.1 200 OK
{
  "type": "tag",
  "id": "2084335",
  "name": "Independent"
}
Example Errors

HTTP/1.1 404 NOT FOUND
{
  "type": "error.list",
  "request_id": "9a3d0816-9707-4598-977e-c009ba630148",
  "errors": [
    {
      "code": "not_found",
      "message": "Contact Not Found"
    }
  ]
}
HTTP/1.1 404 NOT FOUND
{
  "type": "error.list",
  "request_id": "5f6b2623-f844-4914-8b8d-ac01acc62a76",
  "errors": [
    {
      "code": "not_found",
      "message": "Resource Not Found"
    }
  ]
}

You can tag a single contact.

Request Path Parameter

ParameterTypeRequiredDescription
idStringYesThe unique identifier for the contact which is given by Intercom

Request Body Parameter

ParameterTypeRequiredDescription
idStringYesThe unique identifier for the tag which is given by Intercom

You can also tag multiple users

Multiple Request Body Parameter

ParameterTypeRequiredDescription
nameStringYesThe name of the tag, which will be created if not found.
usersObjectYesAn array of objects with the unique identifier of the users to be tagged.
Example Multi User Request & Response

$ curl https://api.intercom.io/tags \
-X POST \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json' -d
{
  "name": "Independent",
  "users": [
    {
      "id": "56cde0cc3deab1bd8c000100"
    },
    {
      "id": "63ced1cc3deab1bd8c11011"
    }
  ]
 }
HTTP/1.1 200 OK
{
  "type": "tag",
  "id": "2084335",
  "name": "Independent"
}

Response

This will return a Tag model for the tag that was added to the contact.