The intercom API reference.
The intercom API reference.
curl -i -X GET \ 'https://api.intercom.io/contacts/{contact_id}/tags' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: 2.8'
{ "type": "list", "data": [ { … } ] }
curl -i -X POST \ 'https://api.intercom.io/contacts/{contact_id}/tags' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: 2.8' \ -d '{ "id": 43 }'
{ "type": "tag", "id": "43", "name": "Manual tag" }
curl -i -X DELETE \ 'https://api.intercom.io/contacts/{contact_id}/tags/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: 2.8'
{ "type": "tag", "id": "46", "name": "Manual tag" }
curl -i -X POST \ 'https://api.intercom.io/conversations/{conversation_id}/tags' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: 2.8' \ -d '{ "id": 48, "admin_id": 991266873 }'
{ "type": "tag", "id": "48", "name": "Manual tag" }
curl -i -X DELETE \ 'https://api.intercom.io/conversations/{conversation_id}/tags/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: 2.8' \ -d '{ "admin_id": 991266877 }'
{ "type": "tag", "id": "51", "name": "Manual tag" }
curl -i -X GET \ https://api.intercom.io/tags \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: 2.8'
{ "type": "list", "data": [ { … } ] }
You can use this endpoint to perform the following operations:
1. Create a new tag: You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below.
2. Update an existing tag: You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below.
3. Tag Companies: You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically.
4. Untag Companies: You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below.
5. Tag Multiple Users: You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below.
Each operation will return a tag object.
curl -i -X POST \ https://api.intercom.io/tags \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: 2.8' \ -d '{ "name": "test" }'
{ "type": "tag", "id": "67", "name": "test" }
curl -i -X GET \ 'https://api.intercom.io/tags/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: 2.8'
{ "type": "tag", "id": "75", "name": "Manual tag" }
curl -i -X DELETE \ 'https://api.intercom.io/tags/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: 2.8'
{ "type": "error.list", "request_id": "58e5295a-5add-4f73-9351-09ce7a26aa45", "errors": [ { … } ] }