diff --git a/postman/Preview/README.md b/postman/Preview/README.md index f2e4cc39..05c894ad 100644 --- a/postman/Preview/README.md +++ b/postman/Preview/README.md @@ -12,4 +12,4 @@ This directory contains the Postman collection for Intercom API version Preview. 3. Set your access token in the environment variables 4. Start making API calls! -Last updated: 2026-04-16T09:25:36.792Z +Last updated: 2026-10-05T18:52:42.049Z diff --git a/postman/Preview/intercom-api.postman_collection.json b/postman/Preview/intercom-api.postman_collection.json index 4ca3dfeb..259ab516 100644 --- a/postman/Preview/intercom-api.postman_collection.json +++ b/postman/Preview/intercom-api.postman_collection.json @@ -8,7 +8,7 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2026-04-16T09:25:36.789Z" + "updatedAt": "2026-10-05T18:52:42.046Z" }, "item": [ { @@ -292,7 +292,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"sync_behavior\": \"api\",\n \"status\": \"active\",\n \"url\": \"https://help.example.com\"\n}", + "raw": "{\n \"sync_behavior\": \"api\",\n \"status\": \"active\",\n \"url\": \"https://help.example.com\",\n \"audience_ids\": [\n 5678\n ]\n}", "urlencoded": [], "formdata": [] } @@ -356,7 +356,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"title\": \"Getting started with...\",\n \"html\": \"

Hello world!

\",\n \"url\": \"https://help.example.com/en/articles/1234-getting-started\",\n \"ai_agent_availability\": true,\n \"ai_copilot_availability\": true,\n \"locale\": \"en\",\n \"source_id\": 1234,\n \"external_id\": \"5678\"\n}", + "raw": "{\n \"title\": \"Getting started with...\",\n \"html\": \"

Hello world!

\",\n \"url\": \"https://help.example.com/en/articles/1234-getting-started\",\n \"ai_agent_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"locale\": \"en\",\n \"source_id\": 1234,\n \"external_id\": \"5678\"\n}", "urlencoded": [], "formdata": [] } @@ -421,7 +421,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"sync_behavior\": \"api\",\n \"status\": \"active\",\n \"url\": \"https://help.example.com\"\n}", + "raw": "{\n \"sync_behavior\": \"api\",\n \"status\": \"active\",\n \"url\": \"https://help.example.com\",\n \"audience_ids\": [\n 5678\n ],\n \"apply_audience_to_existing_content\": false\n}", "urlencoded": [], "formdata": [] } @@ -486,7 +486,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"title\": \"Getting started with...\",\n \"html\": \"

Hello world!

\",\n \"url\": \"https://help.example.com/en/articles/1234-getting-started\",\n \"fin_availability\": true,\n \"locale\": \"en\",\n \"source_id\": 1234,\n \"external_id\": \"5678\"\n}", + "raw": "{\n \"title\": \"Getting started with...\",\n \"html\": \"

Hello world!

\",\n \"url\": \"https://help.example.com/en/articles/1234-getting-started\",\n \"ai_agent_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"fin_availability\": true,\n \"locale\": \"en\",\n \"source_id\": 1234,\n \"external_id\": \"5678\"\n}", "urlencoded": [], "formdata": [] } @@ -965,7 +965,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"created_at_after\": \"1677253093\",\n \"created_at_before\": \"1677861493\",\n \"event_types\": [\n \"app_name_change\",\n \"message_state_change\"\n ],\n \"page\": 1,\n \"per_page\": 20\n}", + "raw": "{\n \"created_at_after\": 1677253093,\n \"created_at_before\": 1677861493,\n \"event_types\": [\n \"app_name_change\",\n \"message_state_change\"\n ],\n \"page\": 1,\n \"per_page\": 20\n}", "urlencoded": [], "formdata": [] } @@ -1043,28 +1043,55 @@ } }, "response": [] - } - ] - }, - { - "name": "Articles", - "item": [ + }, { - "name": "List all articles", + "name": "Remove an admin", "tags": [ - "Articles" + "Admins" ], "request": { "url": { - "raw": "https://api.intercom.io/articles", + "raw": "https://api.intercom.io/admins/remove", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "articles" + "admins", + "remove" + ], + "query": [ + { + "key": "admin_id", + "value": "123", + "description": "The unique identifier of the admin to remove." + }, + { + "key": "reassign_messages_admin_id", + "value": "456", + "description": "The unique identifier of a human admin to reassign the removed admin's auto-message ownership to." + }, + { + "key": "reassign_owner_admin_id", + "value": "456", + "description": "The unique identifier of a human admin to reassign the removed admin's ownership (of users and leads) to." + }, + { + "key": "reassign_articles_author_id", + "value": "456", + "description": "The unique identifier of a human admin to reassign the removed admin's article authorship to." + }, + { + "key": "reassign_conversations_admin_id", + "value": "456", + "description": "The unique identifier of a human admin with Inbox access to reassign the removed admin's conversation replies to. Pass `0` to leave conversations unassigned." + }, + { + "key": "reassign_replies_teams", + "value": "reassign_replies_teams", + "description": "A list of teams and the admin each team's conversation replies should be reassigned to." + } ], - "query": [], "variable": [] }, "auth": { @@ -1087,8 +1114,8 @@ } ] }, - "method": "GET", - "description": "You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`.\n\n> 📘 How are the articles sorted and ordered?\n>\n> Articles will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.\n", + "method": "DELETE", + "description": "You can remove a single admin (teammate) from your workspace.\nRequires the `remove_admins` OAuth scope.\n\nThis removes the admin's access to the workspace and reassigns their\nwork — auto-messages, ownership, article authorship, and conversation\nreplies — to the admins named by the `reassign_*` parameters.", "header": [ { "key": "Intercom-Version", @@ -1102,32 +1129,29 @@ "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Articles", + "item": [ { - "name": "Retrieve an article", + "name": "List all articles", "tags": [ "Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/articles/{id}", + "raw": "https://api.intercom.io/articles", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "articles", - "{id}" + "articles" ], "query": [], - "variable": [ - { - "key": "id", - "value": "123", - "disabled": false, - "description": "The unique identifier for the article which is given by Intercom." - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -1150,7 +1174,7 @@ ] }, "method": "GET", - "description": "You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/`.", + "description": "You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`.\n\n> 📘 How are the articles sorted and ordered?\n>\n> Articles will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.\n", "header": [ { "key": "Intercom-Version", @@ -1166,44 +1190,30 @@ "response": [] }, { - "name": "Search for articles", + "name": "Retrieve an article", "tags": [ "Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/articles/search", + "raw": "https://api.intercom.io/articles/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "articles", - "search" + "{id}" ], - "query": [ - { - "key": "phrase", - "value": "Getting started", - "description": "The phrase within your articles to search for." - }, - { - "key": "state", - "value": "published", - "description": "The state of the Articles returned. One of `published`, `draft` or `all`." - }, + "query": [], + "variable": [ { - "key": "help_center_id", + "key": "id", "value": "123", - "description": "The ID of the Help Center to search in." - }, - { - "key": "highlight", - "value": "highlight", - "description": "Return a highlighted version of the matching content within your articles. Refer to the response schema for more details." + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -1226,7 +1236,7 @@ ] }, "method": "GET", - "description": "You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.", + "description": "You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/`.", "header": [ { "key": "Intercom-Version", @@ -1242,22 +1252,31 @@ "response": [] }, { - "name": "Create an article", + "name": "Retrieve an article draft", "tags": [ "Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/articles", + "raw": "https://api.intercom.io/articles/{id}/draft", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "articles" + "articles", + "{id}", + "draft" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } + ] }, "auth": { "type": "bearer", @@ -1279,54 +1298,62 @@ } ] }, - "method": "POST", - "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.\n\n> 📘 Tags cannot be managed via the Articles API\n>\n> Article tags are read-only in responses. To create, update, or delete tags, use the Intercom UI or the Tags API endpoints.\n", + "method": "GET", + "description": "Fetch the staged draft of a published article by making a GET request to\n`https://api.intercom.io/articles//draft`. The response is the article\nrendered with its draft content, leaving the live article untouched.\n\nA draft exists only when a published article has unpublished changes staged\non top of it. Returns `404` when the article has no staged draft.\n\nRequires the `read_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Thanks for everything\",\n \"description\": \"Description of the Article\",\n \"body\": \"

This is the body in html

\",\n \"author_id\": 1295,\n \"state\": \"draft\",\n \"parent_id\": 18,\n \"parent_type\": \"collection\",\n \"translated_content\": {\n \"type\": \"article_translated_content\",\n \"ar\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"bg\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"bs\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ca\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"cs\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"da\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"de\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"el\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"en\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"es\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"et\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"fi\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"fr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"he\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"hr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"hu\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"id\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"it\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ja\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ko\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"lt\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"lv\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"mn\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"nb\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"nl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"pl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"pt\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ro\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ru\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"sl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"sr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"sv\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"tr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"vi\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"pt-BR\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"zh-CN\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"zh-TW\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n }\n },\n \"folder_id\": 6\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Update an article", + "name": "List article versions", "tags": [ "Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/articles/{id}", + "raw": "https://api.intercom.io/articles/{article_id}/versions", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "articles", - "{id}" + "{article_id}", + "versions" + ], + "query": [ + { + "key": "page", + "value": "1", + "description": "The page of results to fetch. Defaults to the first page." + }, + { + "key": "per_page", + "value": "25", + "description": "The number of results to return per page." + }, + { + "key": "locale", + "value": "en", + "description": "Filter versions to a specific locale. Use the locale identifier (for example `en`, `fr`). If the locale is not configured for the workspace, a `400` is returned." + } ], - "query": [], "variable": [ { - "key": "id", + "key": "article_id", "value": "123", "disabled": false, - "description": "The unique identifier for the article which is given by Intercom." + "description": "The unique identifier for the article whose versions you are listing." } ] }, @@ -1350,54 +1377,59 @@ } ] }, - "method": "PUT", - "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.\n\n> 📘 Tags cannot be managed via the Articles API\n>\n> Article tags are read-only in responses. To create, update, or delete tags, use the Intercom UI or the Tags API endpoints.\n", + "method": "GET", + "description": "Fetch the version history of an article by making a GET request to\n`https://api.intercom.io/articles//versions`. Versions are\nreturned newest-first as a paginated list of metadata. Use\n`GET /articles/{article_id}/versions/{id}` to retrieve a single version\nwith its full content.\n\nRequires the `read_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Thanks for everything\",\n \"description\": \"Description of the Article\",\n \"body\": \"

This is the body in html

\",\n \"author_id\": 1295,\n \"state\": \"draft\",\n \"parent_id\": \"18\",\n \"parent_type\": \"collection\",\n \"translated_content\": {\n \"type\": \"article_translated_content\",\n \"ar\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"bg\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"bs\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ca\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"cs\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"da\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"de\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"el\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"en\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"es\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"et\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"fi\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"fr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"he\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"hr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"hu\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"id\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"it\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ja\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ko\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"lt\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"lv\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"mn\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"nb\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"nl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"pl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"pt\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ro\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ru\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"sl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"sr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"sv\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"tr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"vi\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"pt-BR\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"zh-CN\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"zh-TW\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n }\n },\n \"folder_id\": 6\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Delete an article", + "name": "Retrieve an article version", "tags": [ "Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/articles/{id}", + "raw": "https://api.intercom.io/articles/{article_id}/versions/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "articles", + "{article_id}", + "versions", "{id}" ], - "query": [], + "query": [ + { + "key": "locale", + "value": "en", + "description": "Return the version's content for a specific locale. If the locale is not configured for the workspace, a `400` is returned." + } + ], "variable": [ { - "key": "id", + "key": "article_id", "value": "123", "disabled": false, - "description": "The unique identifier for the article which is given by Intercom." + "description": "The unique identifier for the article." + }, + { + "key": "id", + "value": "301", + "disabled": false, + "description": "The unique identifier for the version." } ] }, @@ -1421,8 +1453,8 @@ } ] }, - "method": "DELETE", - "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", + "method": "GET", + "description": "Fetch a single prior version of an article, including its body content,\nby making a GET request to\n`https://api.intercom.io/articles//versions/`. Returns\nthe version's full content; the live article remains untouched.\n\nRequires the `read_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.\n", "header": [ { "key": "Intercom-Version", @@ -1436,28 +1468,45 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Away Status Reasons", - "item": [ + }, { - "name": "List all away status reasons", + "name": "Search for articles", "tags": [ - "Away Status Reasons" + "Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/away_status_reasons", + "raw": "https://api.intercom.io/articles/search", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "away_status_reasons" + "articles", + "search" + ], + "query": [ + { + "key": "phrase", + "value": "Getting started", + "description": "The phrase within your articles to search for." + }, + { + "key": "state", + "value": "published", + "description": "The state of the Articles returned. One of `published`, `draft` or `all`." + }, + { + "key": "help_center_id", + "value": "123", + "description": "The ID of the Help Center to search in." + }, + { + "key": "highlight", + "value": "highlight", + "description": "Return a highlighted version of the matching content within your articles. Refer to the response schema for more details." + } ], - "query": [], "variable": [] }, "auth": { @@ -1481,7 +1530,7 @@ ] }, "method": "GET", - "description": "Returns a list of all away status reasons configured for the workspace, including deleted ones.", + "description": "You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.", "header": [ { "key": "Intercom-Version", @@ -1495,26 +1544,21 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Brands", - "item": [ + }, { - "name": "List all brands", + "name": "Create an article", "tags": [ - "Brands" + "Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/brands", + "raw": "https://api.intercom.io/articles", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "brands" + "articles" ], "query": [], "variable": [] @@ -1539,45 +1583,56 @@ } ] }, - "method": "GET", - "description": "Retrieves all brands for the workspace, including the default brand.\nThe default brand id always matches the workspace\n", + "method": "POST", + "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.\n\n> 📘 Tags cannot be managed via the Articles API\n>\n> Article tags are read-only in responses. To create, update, or delete tags, use the Intercom UI or the Tags API endpoints.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"title\": \"Thanks for everything\",\n \"description\": \"Description of the Article\",\n \"body\": \"

This is the body in html

\",\n \"body_markdown\": \"# Hello\\n\\nA paragraph with **bold** text.\\n\",\n \"author_id\": 1295,\n \"state\": \"draft\",\n \"parent_id\": 18,\n \"parent_type\": \"collection\",\n \"parent_ids\": [\n 18,\n 19\n ],\n \"translated_content\": {\n \"type\": \"article_translated_content\",\n \"ar\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"bg\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"bs\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"ca\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"cs\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"da\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"de\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"el\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"en\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"es\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"et\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"fi\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"fr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"he\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"hr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"hu\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"id\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"it\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"ja\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"ko\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"lt\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"lv\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"mn\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"nb\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"nl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"pl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"pt\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"ro\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"ru\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"sl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"sr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"sv\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"tr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"vi\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"pt-BR\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"zh-CN\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"zh-TW\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n }\n },\n \"folder_id\": 6,\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"scheduled_publish_at\": \"2026-12-31T09:00:00Z\",\n \"scheduled_unpublish_at\": \"2026-12-31T17:00:00Z\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a brand", + "name": "Publish an article draft", "tags": [ - "Brands" + "Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/brands/{id}", + "raw": "https://api.intercom.io/articles/{id}/draft/publish", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "brands", - "{id}" + "articles", + "{id}", + "draft", + "publish" ], "query": [], "variable": [ { "key": "id", - "value": "id", + "value": "123", "disabled": false, - "description": "The unique identifier of the brand" + "description": "The unique identifier for the article which is given by Intercom." } ] }, @@ -1601,55 +1656,58 @@ } ] }, - "method": "GET", - "description": "Fetches a specific brand by its unique identifier", + "method": "POST", + "description": "Publish a staged draft by making a POST request to\n`https://api.intercom.io/articles//draft/publish`, promoting the draft\ncontent to live.\n\nOn a single-language workspace no body is required. On a multilingual\nworkspace you must list which locales to publish via the `locales` array;\nomitting it returns `422`. Returns `422` when there is no staged draft to\npublish, or when a requested locale has no pending changes.\n\nRequires the `read_write_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, { - "key": "Accept", + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"locales\": [\n \"en\",\n \"fr\"\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - } - ] - }, - { - "name": "Calls", - "item": [ + }, { - "name": "List all calls", + "name": "Add a tag to an article", "tags": [ - "Calls" + "Articles", + "Tags" ], "request": { "url": { - "raw": "https://api.intercom.io/calls", + "raw": "https://api.intercom.io/articles/{article_id}/tags", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "calls" + "articles", + "{article_id}", + "tags" ], - "query": [ - { - "key": "page", - "value": "1", - "description": "The page of results to fetch. Defaults to first page" - }, + "query": [], + "variable": [ { - "key": "per_page", - "value": "25", - "description": "How many results to display per page. Defaults to 25. Max 25." + "key": "article_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -1671,45 +1729,54 @@ } ] }, - "method": "GET", - "description": "Retrieve a paginated list of calls.\n", + "method": "POST", + "description": "Apply an existing tag to an article. Returns the tag that was applied.\n\nThe tag must already exist in the workspace (create tags with the Tags API),\nand the authenticating teammate must have the `manage_knowledge_base_content`\npermission.\n\nRequires the `read_write_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"1234\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Get a call", + "name": "Update an article", "tags": [ - "Calls" + "Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/calls/{id}", + "raw": "https://api.intercom.io/articles/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "calls", + "articles", "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "id", + "value": "123", "disabled": false, - "description": "The id of the call to retrieve" + "description": "The unique identifier for the article which is given by Intercom." } ] }, @@ -1733,46 +1800,55 @@ } ] }, - "method": "GET", - "description": "Retrieve a single call by id.", + "method": "PUT", + "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.\n\n> 📘 Tags cannot be managed via the Articles API\n>\n> Article tags are read-only in responses. To create, update, or delete tags, use the Intercom UI or the Tags API endpoints.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"title\": \"Thanks for everything\",\n \"description\": \"Description of the Article\",\n \"body\": \"

This is the body in html

\",\n \"body_markdown\": \"## Updated heading\\n\\nNew content.\\n\",\n \"author_id\": 1295,\n \"state\": \"draft\",\n \"parent_id\": \"18\",\n \"parent_type\": \"collection\",\n \"parent_ids\": [\n 18,\n 19\n ],\n \"translated_content\": {\n \"type\": \"article_translated_content\",\n \"ar\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"bg\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"bs\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"ca\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"cs\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"da\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"de\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"el\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"en\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"es\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"et\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"fi\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"fr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"he\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"hr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"hu\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"id\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"it\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"ja\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"ko\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"lt\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"lv\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"mn\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"nb\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"nl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"pl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"pt\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"ro\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"ru\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"sl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"sr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"sv\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"tr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"vi\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"pt-BR\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"zh-CN\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"zh-TW\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n }\n },\n \"folder_id\": 6,\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"scheduled_publish_at\": \"2026-12-31T09:00:00Z\",\n \"scheduled_unpublish_at\": \"2026-12-31T17:00:00Z\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Get call recording by call id", + "name": "Stage an article draft", "tags": [ - "Calls" + "Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/calls/{id}/recording", + "raw": "https://api.intercom.io/articles/{id}/draft", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "calls", + "articles", "{id}", - "recording" + "draft" ], "query": [], "variable": [ { "key": "id", - "value": "id", + "value": "123", "disabled": false, - "description": "The id of the call" + "description": "The unique identifier for the article which is given by Intercom." } ] }, @@ -1796,46 +1872,54 @@ } ] }, - "method": "GET", - "description": "Redirects to a signed URL for the call's recording if it exists.", + "method": "PUT", + "description": "Stage changes to a published article as a draft by making a PUT request to\n`https://api.intercom.io/articles//draft`. The live article remains\nunchanged until the draft is published.\n\nThe article must already be published; staging a draft on an article that\nhas never been published returns `422`.\n\nOnly versioned text content (such as `title` and `body`) is staged.\nNon-versioned fields like AI availability are ignored, leaving the live\nvalues untouched.\n\nRequires the `read_write_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"title\": \"Thanks for everything\",\n \"description\": \"Description of the Article\",\n \"body\": \"

This is the body in html

\",\n \"body_markdown\": \"## Updated heading\\n\\nNew content.\\n\",\n \"author_id\": 1295,\n \"state\": \"draft\",\n \"parent_id\": \"18\",\n \"parent_type\": \"collection\",\n \"parent_ids\": [\n 18,\n 19\n ],\n \"translated_content\": {\n \"type\": \"article_translated_content\",\n \"ar\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"bg\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"bs\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"ca\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"cs\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"da\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"de\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"el\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"en\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"es\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"et\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"fi\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"fr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"he\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"hr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"hu\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"id\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"it\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"ja\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"ko\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"lt\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"lv\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"mn\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"nb\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"nl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"pl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"pt\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"ro\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"ru\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"sl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"sr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"sv\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"tr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"vi\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"pt-BR\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"zh-CN\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n },\n \"zh-TW\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"body_markdown\": \"# How to create a new article\\n\\nThis is the body of the article.\\n\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"has_unpublished_changes\": false,\n \"draft_updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"created_by_id\": 5017691,\n \"updated_by_id\": 5017691\n }\n },\n \"folder_id\": 6,\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true,\n \"scheduled_publish_at\": \"2026-12-31T09:00:00Z\",\n \"scheduled_unpublish_at\": \"2026-12-31T17:00:00Z\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Get call transcript by call id", + "name": "Delete an article", "tags": [ - "Calls" + "Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/calls/{id}/transcript", + "raw": "https://api.intercom.io/articles/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "calls", - "{id}", - "transcript" + "articles", + "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "id", + "value": "123", "disabled": false, - "description": "The id of the call" + "description": "The unique identifier for the article which is given by Intercom." } ] }, @@ -1859,8 +1943,8 @@ } ] }, - "method": "GET", - "description": "Returns the transcript for the specified call as a downloadable text file.\n", + "method": "DELETE", + "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", "header": [ { "key": "Intercom-Version", @@ -1876,29 +1960,37 @@ "response": [] }, { - "name": "Collect Fin Voice call by ID", + "name": "Remove a tag from an article", "tags": [ - "Calls" + "Articles", + "Tags" ], "request": { "url": { - "raw": "https://api.intercom.io/fin_voice/collect/{id}", + "raw": "https://api.intercom.io/articles/{article_id}/tags/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "fin_voice", - "collect", + "articles", + "{article_id}", + "tags", "{id}" ], "query": [], "variable": [ + { + "key": "article_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + }, { "key": "id", - "value": "id", + "value": "7522907", "disabled": false, - "description": "The external reference ID" + "description": "The unique identifier of the tag to remove, as given by Intercom." } ] }, @@ -1922,9 +2014,13 @@ } ] }, - "method": "GET", - "description": "Retrieve information about a Fin Voice call using the external reference ID.", + "method": "DELETE", + "description": "Remove a tag from an article. Returns the tag that was removed, with null\n`applied_at` and `applied_by`.\n\nThe authenticating teammate must have the `manage_knowledge_base_content`\npermission.\n\nRequires the `read_write_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.\n", "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, { "key": "Accept", "value": "application/json" @@ -1933,33 +2029,40 @@ "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Audiences", + "item": [ { - "name": "Collect Fin Voice call by external ID", + "name": "List all audiences", "tags": [ - "Calls" + "Audiences" ], "request": { "url": { - "raw": "https://api.intercom.io/fin_voice/external_id/{external_id}", + "raw": "https://api.intercom.io/audiences", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "fin_voice", - "external_id", - "{external_id}" + "audiences" ], - "query": [], - "variable": [ + "query": [ { - "key": "external_id", - "value": "external_id", - "disabled": false, - "description": "The external call identifier from the call provider" + "key": "page", + "value": "1", + "description": "The page of results to fetch. Defaults to first page." + }, + { + "key": "per_page", + "value": "50", + "description": "The number of results to return per page. Defaults to 50. Maximum is 50." } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -1982,8 +2085,12 @@ ] }, "method": "GET", - "description": "Retrieve information about a Fin Voice call using the external call identifier.", + "description": "You can fetch a list of all audiences for the workspace.", "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, { "key": "Accept", "value": "application/json" @@ -1994,29 +2101,28 @@ "response": [] }, { - "name": "Collect Fin Voice call by phone number", + "name": "Retrieve an audience", "tags": [ - "Calls" + "Audiences" ], "request": { "url": { - "raw": "https://api.intercom.io/fin_voice/phone_number/{phone_number}", + "raw": "https://api.intercom.io/audiences/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "fin_voice", - "phone_number", - "{phone_number}" + "audiences", + "{id}" ], "query": [], "variable": [ { - "key": "phone_number", - "value": "phone_number", + "key": "id", + "value": "123", "disabled": false, - "description": "Phone number in E.164 format" + "description": "The unique identifier for the audience." } ] }, @@ -2041,8 +2147,12 @@ ] }, "method": "GET", - "description": "Retrieve information about a Fin Voice call using the phone number.\n\nReturns the most recent matched call for the given phone number, ordered by creation date.\n", + "description": "You can fetch the details of a single audience by making a GET request to `https://api.intercom.io/audiences/{id}`.", "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, { "key": "Accept", "value": "application/json" @@ -2053,31 +2163,22 @@ "response": [] }, { - "name": "Collect Fin Voice calls by conversation ID", + "name": "Create an audience", "tags": [ - "Calls" + "Audiences" ], "request": { "url": { - "raw": "https://api.intercom.io/fin_voice/conversation/{conversation_id}", + "raw": "https://api.intercom.io/audiences", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "fin_voice", - "conversation", - "{conversation_id}" + "audiences" ], "query": [], - "variable": [ - { - "key": "conversation_id", - "value": "conversation_id", - "disabled": false, - "description": "The Intercom conversation identifier" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -2099,36 +2200,56 @@ } ] }, - "method": "GET", - "description": "Retrieve information about Fin Voice calls associated with a conversation.\n\nReturns all matched calls for the given conversation ID. A conversation may have multiple associated calls.\n", + "method": "POST", + "description": "You can create a new audience by making a POST request to `https://api.intercom.io/audiences`.", "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VIP Customers\",\n \"predicates\": [\n {\n \"attribute\": \"company.name\",\n \"type\": \"string\",\n \"comparison\": \"contains\",\n \"value\": \"Acme\"\n }\n ],\n \"role_predicates\": [\n {\n \"attribute\": \"role\",\n \"type\": \"role\",\n \"comparison\": \"eq\",\n \"value\": \"user\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List calls with transcripts", + "name": "Update an audience", "tags": [ - "Calls" + "Audiences" ], "request": { "url": { - "raw": "https://api.intercom.io/calls/search", + "raw": "https://api.intercom.io/audiences/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "calls", - "search" + "audiences", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the audience." + } + ] }, "auth": { "type": "bearer", @@ -2150,8 +2271,8 @@ } ] }, - "method": "POST", - "description": "Retrieve calls by a list of conversation ids and include transcripts when available.\nA maximum of 20 `conversation_ids` can be provided. If none are provided or more than 20 are provided, a 400 error is returned.\n", + "method": "PUT", + "description": "You can update the details of a single audience by making a PUT request to `https://api.intercom.io/audiences/{id}`.", "header": [ { "key": "Intercom-Version", @@ -2168,7 +2289,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"conversation_ids\": \"\"\n}", + "raw": "{\n \"name\": \"Enterprise Accounts\",\n \"predicates\": [\n {\n \"attribute\": \"custom_attributes.plan\",\n \"type\": \"string\",\n \"comparison\": \"eq\",\n \"value\": \"enterprise\"\n }\n ],\n \"role_predicates\": [\n {\n \"attribute\": \"role\",\n \"type\": \"role\",\n \"comparison\": \"eq\",\n \"value\": \"user\"\n }\n ]\n}", "urlencoded": [], "formdata": [] } @@ -2176,27 +2297,34 @@ "response": [] }, { - "name": "Register a Fin Voice call", + "name": "Delete an audience", "tags": [ - "Calls" + "Audiences" ], "request": { "url": { - "raw": "https://api.intercom.io/fin_voice/register", + "raw": "https://api.intercom.io/audiences/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "fin_voice", - "register" + "audiences", + "{id}" ], "query": [], - "variable": [] - }, - "auth": { - "type": "bearer", - "bearer": [ + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the audience." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ { "key": "bearerToken", "value": "{{bearerToken}}", @@ -2214,80 +2342,52 @@ } ] }, - "method": "POST", - "description": "Register a Fin Voice call with Intercom. This endpoint creates an external reference\nthat links an external call identifier to an Intercom call and conversation.\n\nThe call can be from different sources:\n- AWS Connect (default)\n- Five9\n- Zoom Phone\n", + "method": "DELETE", + "description": "You can delete a single audience by making a DELETE request to `https://api.intercom.io/audiences/{id}`.", "header": [ { - "key": "Content-Type", - "value": "application/json" + "key": "Intercom-Version", + "value": "Preview" }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"phone_number\": \"+1234567890\",\n \"call_id\": \"call-123-abc\",\n \"source\": \"aws_connect\",\n \"data\": {\n \"key\": \"value\"\n }\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] } ] }, { - "name": "Companies", + "name": "Auth Tokens", "item": [ { - "name": "Retrieve companies", + "name": "Update an auth token", "tags": [ - "Companies" + "Auth Tokens" ], "request": { "url": { - "raw": "https://api.intercom.io/companies", + "raw": "https://api.intercom.io/auth_tokens/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies" + "auth_tokens", + "{id}" ], - "query": [ - { - "key": "name", - "value": "my company", - "description": "The `name` of the company to filter by." - }, + "query": [], + "variable": [ { - "key": "company_id", + "key": "id", "value": "12345", - "description": "The `company_id` of the company to filter by." - }, - { - "key": "tag_id", - "value": "678910", - "description": "The `tag_id` of the company to filter by." - }, - { - "key": "segment_id", - "value": "98765", - "description": "The `segment_id` of the company to filter by." - }, - { - "key": "page", - "value": "1", - "description": "The page of results to fetch. Defaults to first page" - }, - { - "key": "per_page", - "value": "15", - "description": "How many results to display per page. Defaults to 15" + "disabled": false, + "description": "The unique identifier for the auth token." } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -2309,47 +2409,59 @@ } ] }, - "method": "GET", - "description": "You can fetch a single company by passing in `company_id` or `name`.\n\n `https://api.intercom.io/companies?name={name}`\n\n `https://api.intercom.io/companies?company_id={company_id}`\n\nYou can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter.\n\n `https://api.intercom.io/companies?tag_id={tag_id}`\n\n `https://api.intercom.io/companies?segment_id={segment_id}`\n", + "method": "PATCH", + "description": "Updates the metadata of a stored third-party credential. A field you omit keeps its current value. The credential value itself cannot be changed here and is never returned. Only credentials with a `token_type` of `text` can be updated; any other type responds with `400`. A credential the list endpoint does not return is also not updatable, and responds with `404`.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Fulfilment API key\",\n \"request_header_key\": \"Authorization\",\n \"token_prefix\": \"Bearer\",\n \"description\": \"Used by the order status connector\",\n \"domain\": \"api.fulfilment.example.com\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a company by ID", + "name": "List all auth tokens", "tags": [ - "Companies" + "Auth Tokens" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{id}", + "raw": "https://api.intercom.io/auth_tokens", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", - "{id}" + "auth_tokens" ], - "query": [], - "variable": [ + "query": [ { - "key": "id", - "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", - "disabled": false, - "description": "The unique identifier for the company which is given by Intercom" + "key": "per_page", + "value": "per_page", + "description": "The number of results to return per page. Defaults to 20, minimum 1, maximum 50." + }, + { + "key": "starting_after", + "value": "starting_after", + "description": "The cursor value from `pages.next.starting_after` in a previous response. Used to paginate through results." } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -2372,7 +2484,7 @@ ] }, "method": "GET", - "description": "You can fetch a single company.", + "description": "Returns a paginated list of the workspace's stored third-party credentials. Use this to discover the id of a credential you want a data connector to authenticate with — that id is not otherwise available over REST. Only metadata is returned; credential values are never exposed. The list is not exhaustive: credentials a teammate created are listed, as are those created by some Intercom integrations, but credentials installed by an app package, those created by most other integrations, and those minted for an individual teammate's MCP access are not.\n", "header": [ { "key": "Intercom-Version", @@ -2388,30 +2500,28 @@ "response": [] }, { - "name": "List attached contacts", + "name": "Retrieve an auth token", "tags": [ - "Companies", - "Contacts" + "Auth Tokens" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{id}/contacts", + "raw": "https://api.intercom.io/auth_tokens/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", - "{id}", - "contacts" + "auth_tokens", + "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "value": "12345", "disabled": false, - "description": "The unique identifier for the company which is given by Intercom" + "description": "The unique identifier for the auth token." } ] }, @@ -2436,7 +2546,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of all contacts that belong to a company.", + "description": "Returns the metadata for a single stored third-party credential. A credential that the list endpoint does not return is also not retrievable here, and responds with 404.\n", "header": [ { "key": "Intercom-Version", @@ -2452,31 +2562,22 @@ "response": [] }, { - "name": "List attached segments for companies", + "name": "Create an auth token", "tags": [ - "Companies" + "Auth Tokens" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{id}/segments", + "raw": "https://api.intercom.io/auth_tokens", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", - "{id}", - "segments" + "auth_tokens" ], "query": [], - "variable": [ - { - "key": "id", - "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", - "disabled": false, - "description": "The unique identifier for the company which is given by Intercom" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -2498,45 +2599,52 @@ } ] }, - "method": "GET", - "description": "You can fetch a list of all segments that belong to a company.", + "method": "POST", + "description": "Stores a third-party credential in your workspace so a data connector can authenticate outbound requests with it. Only credentials with a `token_type` of `text` can be created here — the credential value is sent as a request header. The value you supply is stored encrypted and is never returned by any endpoint, including this one.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Fulfilment API key\",\n \"token_value\": \"sk_live_9f3c2a7b41e8\",\n \"request_header_key\": \"Authorization\",\n \"token_prefix\": \"Bearer\",\n \"description\": \"Used by the order status connector\",\n \"domain\": \"api.fulfilment.example.com\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Away Status Reasons", + "item": [ { - "name": "Scroll over all companies", + "name": "List all away status reasons", "tags": [ - "Companies" + "Away Status Reasons" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/scroll", + "raw": "https://api.intercom.io/away_status_reasons", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", - "scroll" - ], - "query": [ - { - "key": "scroll_param", - "value": "scroll_param", - "description": "" - } + "away_status_reasons" ], + "query": [], "variable": [] }, "auth": { @@ -2560,7 +2668,7 @@ ] }, "method": "GET", - "description": " The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset.\n\n- Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.\n- If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail\n- If the end of the scroll is reached, \"companies\" will be empty and the scroll parameter will expire\n\n{% admonition type=\"info\" name=\"Scroll Parameter\" %}\n You can get the first page of companies by simply sending a GET request to the scroll endpoint.\n For subsequent requests you will need to use the scroll parameter from the response.\n{% /admonition %}\n{% admonition type=\"danger\" name=\"Scroll network timeouts\" %}\n Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message:\n \"Request failed due to an internal network error. Please restart the scroll operation.\"\n If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll.\n{% /admonition %}\n", + "description": "Returns a list of all away status reasons configured for the workspace, including deleted ones.", "header": [ { "key": "Intercom-Version", @@ -2574,24 +2682,39 @@ "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Banners", + "item": [ { - "name": "Create or Update a company", + "name": "List banners for a contact", "tags": [ - "Companies" + "Banners", + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/companies", + "raw": "https://api.intercom.io/contacts/{id}/banners", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies" + "contacts", + "{id}", + "banners" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a contact." + } + ] }, "auth": { "type": "bearer", @@ -2613,65 +2736,57 @@ } ] }, - "method": "POST", - "description": "You can create or update a company.\n\nCompanies will be only visible in Intercom when there is at least one associated user.\n\nCompanies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated.\n\n{% admonition type=\"warning\" name=\"Using `company_id`\" %}\n You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company.\n{% /admonition %}\n", + "method": "GET", + "description": "Returns the banners a contact currently matches, so you can display them on\nsurfaces outside the Messenger (native mobile apps, kiosks, embedded tools).\n\nEach banner in the response includes a `view_id`. Use it to record a dismissal\nwith the dismiss endpoint. A returned banner is treated as shown: requesting\nthis endpoint records an impression for each banner returned, so call it at the\npoint you are about to display the banners, not speculatively.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Intercom\",\n \"company_id\": \"625e90fc55ab113b6d92175f\",\n \"plan\": \"Enterprise\",\n \"size\": \"100\",\n \"website\": \"https://www.example.com\",\n \"industry\": \"Manufacturing\",\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 9\n },\n \"remote_created_at\": 1394531169,\n \"monthly_spend\": 1000,\n \"update_last_request_at\": true\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "List all companies", + "name": "Dismiss a banner for a contact", "tags": [ - "Companies" + "Banners", + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/list", + "raw": "https://api.intercom.io/contacts/{id}/banners/{view_id}/dismiss", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", - "list" + "contacts", + "{id}", + "banners", + "{view_id}", + "dismiss" ], - "query": [ - { - "key": "page", - "value": "1", - "description": "The page of results to fetch. Defaults to first page" - }, + "query": [], + "variable": [ { - "key": "per_page", - "value": "15", - "description": "How many results to return per page. Defaults to 15" + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a contact." }, { - "key": "order", - "value": "desc", - "description": "`asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc" + "key": "view_id", + "value": "view_id", + "disabled": false, + "description": "The `view_id` of the banner to dismiss, as returned by the list banners endpoint." } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -2694,7 +2809,7 @@ ] }, "method": "POST", - "description": "You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first.\n\nNote that the API does not include companies who have no associated users in list responses.\n\nWhen using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies).\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", + "description": "Records that a contact has dismissed a banner. Dismissals are shared across\nsurfaces, so a banner dismissed through this endpoint will also stop appearing\nin the web Messenger for that contact, and vice versa.\n\nThe request is idempotent: dismissing an already-dismissed banner succeeds and\nreturns the same response.\n", "header": [ { "key": "Intercom-Version", @@ -2708,34 +2823,29 @@ "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Brands", + "item": [ { - "name": "Attach a Contact to a Company", + "name": "List all brands", "tags": [ - "Companies", - "Contacts" + "Brands" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/companies", + "raw": "https://api.intercom.io/brands", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{id}", - "companies" + "brands" ], "query": [], - "variable": [ - { - "key": "id", - "value": "id", - "disabled": false, - "description": "The unique identifier for the contact which is given by Intercom" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -2757,54 +2867,45 @@ } ] }, - "method": "POST", - "description": "You can attach a company to a single contact.", + "method": "GET", + "description": "Retrieves all brands for the workspace, including the default brand.\nThe default brand id always matches the workspace\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"58a430d35458202d41b1e65b\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Update a company", + "name": "Retrieve a brand", "tags": [ - "Companies" + "Brands" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{id}", + "raw": "https://api.intercom.io/brands/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", + "brands", "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "value": "id", "disabled": false, - "description": "The unique identifier for the company which is given by Intercom" + "description": "The unique identifier of the brand" } ] }, @@ -2828,8 +2929,8 @@ } ] }, - "method": "PUT", - "description": "You can update a single company using the Intercom provisioned `id`.\n\n{% admonition type=\"warning\" name=\"Using `company_id`\" %}\n When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company.\n{% /admonition %}\n", + "method": "GET", + "description": "Fetches a specific brand by its unique identifier", "header": [ { "key": "Intercom-Version", @@ -2843,32 +2944,40 @@ "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Calls", + "item": [ { - "name": "Delete a company", + "name": "List all calls", "tags": [ - "Companies" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{id}", + "raw": "https://api.intercom.io/calls", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", - "{id}" + "calls" ], - "query": [], - "variable": [ + "query": [ { - "key": "id", - "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", - "disabled": false, - "description": "The unique identifier for the company which is given by Intercom" + "key": "page", + "value": "1", + "description": "The page of results to fetch. Defaults to first page" + }, + { + "key": "per_page", + "value": "25", + "description": "How many results to display per page. Defaults to 25. Max 25." } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -2890,8 +2999,8 @@ } ] }, - "method": "DELETE", - "description": "You can delete a single company.", + "method": "GET", + "description": "Retrieve a paginated list of calls.\n", "header": [ { "key": "Intercom-Version", @@ -2907,37 +3016,28 @@ "response": [] }, { - "name": "Detach a contact from a company", + "name": "Get a call", "tags": [ - "Companies", - "Contacts" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{contact_id}/companies/{id}", + "raw": "https://api.intercom.io/calls/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{contact_id}", - "companies", + "calls", "{id}" ], "query": [], "variable": [ - { - "key": "contact_id", - "value": "58a430d35458202d41b1e65b", - "disabled": false, - "description": "The unique identifier for the contact which is given by Intercom" - }, { "key": "id", - "value": "58a430d35458202d41b1e65b", + "value": "id", "disabled": false, - "description": "The unique identifier for the company which is given by Intercom" + "description": "The id of the call to retrieve" } ] }, @@ -2961,8 +3061,8 @@ } ] }, - "method": "DELETE", - "description": "You can detach a company from a single contact.", + "method": "GET", + "description": "Retrieve a single call by id.", "header": [ { "key": "Intercom-Version", @@ -2976,37 +3076,31 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Contacts", - "item": [ + }, { - "name": "List attached companies for contact", + "name": "Get call recording by call id", "tags": [ - "Contacts", - "Companies" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/companies", + "raw": "https://api.intercom.io/calls/{id}/recording", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", + "calls", "{id}", - "companies" + "recording" ], "query": [], "variable": [ { "key": "id", - "value": "63a07ddf05a32042dffac965", + "value": "id", "disabled": false, - "description": "The unique identifier for the contact which is given by Intercom" + "description": "The id of the call" } ] }, @@ -3031,7 +3125,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of companies that are associated to a contact.", + "description": "Redirects to a signed URL for the call's recording if it exists.", "header": [ { "key": "Intercom-Version", @@ -3047,30 +3141,29 @@ "response": [] }, { - "name": "List attached segments for contact", + "name": "Get call transcript by call id", "tags": [ - "Contacts", - "Segments" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{contact_id}/segments", + "raw": "https://api.intercom.io/calls/{id}/transcript", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{contact_id}", - "segments" + "calls", + "{id}", + "transcript" ], "query": [], "variable": [ { - "key": "contact_id", - "value": "63a07ddf05a32042dffac965", + "key": "id", + "value": "id", "disabled": false, - "description": "The unique identifier for the contact which is given by Intercom" + "description": "The id of the call" } ] }, @@ -3095,7 +3188,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of segments that are associated to a contact.", + "description": "Returns the transcript for the specified call as a JSON array of turns. Each turn carries a `speaker_name` when the speaker could be resolved. Clients should fall back to `speaker_label` when `speaker_name` is absent.\n", "header": [ { "key": "Intercom-Version", @@ -3111,30 +3204,29 @@ "response": [] }, { - "name": "List subscriptions for a contact", + "name": "Collect Fin Voice call by ID", "tags": [ - "Contacts", - "Subscription Types" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/fin_voice/collect/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{contact_id}", - "subscriptions" + "fin_voice", + "collect", + "{id}" ], "query": [], "variable": [ { - "key": "contact_id", - "value": "63a07ddf05a32042dffac965", + "key": "id", + "value": "id", "disabled": false, - "description": "The unique identifier for the contact which is given by Intercom" + "description": "The external reference ID" } ] }, @@ -3159,12 +3251,8 @@ ] }, "method": "GET", - "description": "You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type.\nThis will return a list of Subscription Type objects that the contact is associated with.\n\nThe data property will show a combined list of:\n\n 1.Opt-out subscription types that the user has opted-out from.\n 2.Opt-in subscription types that the user has opted-in to receiving.\n", + "description": "Retrieve information about a Fin Voice call using the external reference ID.", "header": [ - { - "key": "Intercom-Version", - "value": "Preview" - }, { "key": "Accept", "value": "application/json" @@ -3175,30 +3263,29 @@ "response": [] }, { - "name": "List tags attached to a contact", + "name": "Collect Fin Voice call by external ID", "tags": [ - "Contacts", - "Tags" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/fin_voice/external_id/{external_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{contact_id}", - "tags" + "fin_voice", + "external_id", + "{external_id}" ], "query": [], "variable": [ { - "key": "contact_id", - "value": "63a07ddf05a32042dffac965", + "key": "external_id", + "value": "external_id", "disabled": false, - "description": "The unique identifier for the contact which is given by Intercom" + "description": "The external call identifier from the call provider" } ] }, @@ -3223,12 +3310,8 @@ ] }, "method": "GET", - "description": "You can fetch a list of all tags that are attached to a specific contact.", + "description": "Retrieve information about a Fin Voice call using the external call identifier.", "header": [ - { - "key": "Intercom-Version", - "value": "Preview" - }, { "key": "Accept", "value": "application/json" @@ -3239,28 +3322,29 @@ "response": [] }, { - "name": "Get a contact", + "name": "Collect Fin Voice call by phone number", "tags": [ - "Contacts" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}", + "raw": "https://api.intercom.io/fin_voice/phone_number/{phone_number}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{id}" + "fin_voice", + "phone_number", + "{phone_number}" ], "query": [], "variable": [ { - "key": "id", - "value": "63a07ddf05a32042dffac965", + "key": "phone_number", + "value": "phone_number", "disabled": false, - "description": "id" + "description": "Phone number in E.164 format" } ] }, @@ -3285,12 +3369,8 @@ ] }, "method": "GET", - "description": "You can fetch the details of a single contact.", + "description": "Retrieve information about a Fin Voice call using the phone number.\n\nReturns the most recent matched call for the given phone number, ordered by creation date.\n", "header": [ - { - "key": "Intercom-Version", - "value": "Preview" - }, { "key": "Accept", "value": "application/json" @@ -3301,22 +3381,31 @@ "response": [] }, { - "name": "List all contacts", + "name": "Collect Fin Voice calls by conversation ID", "tags": [ - "Contacts" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts", + "raw": "https://api.intercom.io/fin_voice/conversation/{conversation_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts" + "fin_voice", + "conversation", + "{conversation_id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "conversation_id", + "value": "conversation_id", + "disabled": false, + "description": "The Intercom conversation identifier" + } + ] }, "auth": { "type": "bearer", @@ -3339,12 +3428,8 @@ ] }, "method": "GET", - "description": "You can fetch a list of all contacts (ie. users or leads) in your workspace.\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `50` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", + "description": "Retrieve information about Fin Voice calls associated with a conversation.\n\nReturns all matched calls for the given conversation ID. A conversation may have multiple associated calls.\n", "header": [ - { - "key": "Intercom-Version", - "value": "Preview" - }, { "key": "Accept", "value": "application/json" @@ -3355,35 +3440,27 @@ "response": [] }, { - "name": "Get a contact by External ID", + "name": "List calls with transcripts", "tags": [ - "Contacts" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/find_by_external_id/{external_id}", + "raw": "https://api.intercom.io/calls/search", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "find_by_external_id", - "{external_id}" + "calls", + "search" ], "query": [], - "variable": [ - { - "key": "external_id", - "value": "cdd29344-5e0c-4ef0-ac56-f9ba2979bc27", - "disabled": false, - "description": "The external ID of the user that you want to retrieve" - } - ] - }, - "auth": { - "type": "bearer", - "bearer": [ + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ { "key": "bearerToken", "value": "{{bearerToken}}", @@ -3401,37 +3478,46 @@ } ] }, - "method": "GET", - "description": "You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads.", + "method": "POST", + "description": "Retrieve calls by a list of conversation ids and include transcripts when available.\nA maximum of 20 `conversation_ids` can be provided. If none are provided or more than 20 are provided, a 400 error is returned.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"conversation_ids\": []\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Merge a lead and a user", + "name": "Register a Fin Voice call", "tags": [ - "Contacts" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/merge", + "raw": "https://api.intercom.io/fin_voice/register", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "merge" + "fin_voice", + "register" ], "query": [], "variable": [] @@ -3457,12 +3543,8 @@ ] }, "method": "POST", - "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", + "description": "Register a Fin Voice call with Intercom. This endpoint creates an external reference\nthat links an external call identifier to an Intercom call and conversation.\n\nThe call can be from different sources:\n- AWS Connect (default)\n- Five9\n- Zoom Phone\n", "header": [ - { - "key": "Intercom-Version", - "value": "Preview" - }, { "key": "Content-Type", "value": "application/json" @@ -3474,30 +3556,65 @@ ], "body": { "mode": "raw", - "raw": "{\n \"from\": \"5d70dd30de4efd54f42fd526\",\n \"into\": \"5ba682d23d7cf92bef87bfd4\"\n}", + "raw": "{\n \"phone_number\": \"+1234567890\",\n \"call_id\": \"call-123-abc\",\n \"source\": \"aws_connect\",\n \"data\": {\n \"key\": \"value\"\n }\n}", "urlencoded": [], "formdata": [] } }, "response": [] - }, + } + ] + }, + { + "name": "Companies", + "item": [ { - "name": "Search contacts", + "name": "Retrieve companies", "tags": [ - "Contacts" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/search", + "raw": "https://api.intercom.io/companies", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "search" + "companies" + ], + "query": [ + { + "key": "name", + "value": "my company", + "description": "The `name` of the company to filter by." + }, + { + "key": "company_id", + "value": "12345", + "description": "The `company_id` of the company to filter by." + }, + { + "key": "tag_id", + "value": "678910", + "description": "The `tag_id` of the company to filter by." + }, + { + "key": "segment_id", + "value": "98765", + "description": "The `segment_id` of the company to filter by." + }, + { + "key": "page", + "value": "1", + "description": "The page of results to fetch. Defaults to first page" + }, + { + "key": "per_page", + "value": "15", + "description": "How many results to display per page. Defaults to 15" + } ], - "query": [], "variable": [] }, "auth": { @@ -3520,48 +3637,47 @@ } ] }, - "method": "POST", - "description": "You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want.\n\nTo search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`.\n\nThis will accept a query object in the body which will define your filters in order to search for contacts.\n\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `50` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n### Contact Creation Delay\n\nIf a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiple's there can be:\n* There's a limit of max 2 nested filters\n* There's a limit of max 15 filters for each AND or OR group\n\n### Searching for Timestamp Fields\n\nAll timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second.\nFor example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards.\nIf you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM).\nThis behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly.\n\n### Accepted Fields\n\nMost key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foorbar\"`).\n\n| Field | Type |\n| ---------------------------------- | ------------------------------ |\n| id | String |\n| role | String
Accepts user or lead |\n| name | String |\n| avatar | String |\n| owner_id | Integer |\n| email | String |\n| email_domain | String |\n| phone | String |\n| formatted_phone | String |\n| external_id | String |\n| created_at | Date (UNIX Timestamp) |\n| signed_up_at | Date (UNIX Timestamp) |\n| updated_at | Date (UNIX Timestamp) |\n| last_seen_at | Date (UNIX Timestamp) |\n| last_contacted_at | Date (UNIX Timestamp) |\n| last_replied_at | Date (UNIX Timestamp) |\n| last_email_opened_at | Date (UNIX Timestamp) |\n| last_email_clicked_at | Date (UNIX Timestamp) |\n| language_override | String |\n| browser | String |\n| browser_language | String |\n| os | String |\n| location.country | String |\n| location.region | String |\n| location.city | String |\n| unsubscribed_from_emails | Boolean |\n| marked_email_as_spam | Boolean |\n| has_hard_bounced | Boolean |\n| ios_last_seen_at | Date (UNIX Timestamp) |\n| ios_app_version | String |\n| ios_device | String |\n| ios_app_device | String |\n| ios_os_version | String |\n| ios_app_name | String |\n| ios_sdk_version | String |\n| android_last_seen_at | Date (UNIX Timestamp) |\n| android_app_version | String |\n| android_device | String |\n| android_app_name | String |\n| andoid_sdk_version | String |\n| segment_id | String |\n| tag_id | String |\n| custom_attributes.{attribute_name} | String |\n\n### Accepted Operators\n\n{% admonition type=\"warning\" name=\"Searching based on `created_at`\" %}\n You cannot use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :------------------------------- | :--------------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In
Shortcut for `OR` queries
Values must be in Array |\n| NIN | All | Not In
Shortcut for `OR !` queries
Values must be in Array |\n| > | Integer
Date (UNIX Timestamp) | Greater than |\n| < | Integer
Date (UNIX Timestamp) | Lower than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "method": "GET", + "description": "You can fetch a single company by passing in `company_id` or `name`.\n\n `https://api.intercom.io/companies?name={name}`\n\n `https://api.intercom.io/companies?company_id={company_id}`\n\nYou can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter.\n\n `https://api.intercom.io/companies?tag_id={tag_id}`\n\n `https://api.intercom.io/companies?segment_id={segment_id}`\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"query\": {\n \"field\": \"created_at\",\n \"operator\": \"AND\",\n \"value\": \"73732934\"\n },\n \"pagination\": {\n \"per_page\": 2,\n \"starting_after\": \"your-cursor-from-response\"\n }\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Create contact", + "name": "Retrieve a company by ID", "tags": [ - "Contacts" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts", + "raw": "https://api.intercom.io/companies/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts" + "companies", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } + ] }, "auth": { "type": "bearer", @@ -3583,55 +3699,47 @@ } ] }, - "method": "POST", - "description": "You can create a new contact (ie. user or lead).", + "method": "GET", + "description": "You can fetch a single company.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"role\": \"user\",\n \"external_id\": \"625e90fc55ab113b6d92175f\",\n \"email\": \"jdoe@example.com\",\n \"phone\": \"+353871234567\",\n \"name\": \"John Doe\",\n \"avatar\": \"https://www.example.com/avatar_image.jpg\",\n \"signed_up_at\": 1571672154,\n \"last_seen_at\": 1571672154,\n \"owner_id\": 123,\n \"unsubscribed_from_emails\": true,\n \"language_override\": \"en\",\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 1\n }\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Archive contact", + "name": "List attached contacts", "tags": [ + "Companies", "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/archive", + "raw": "https://api.intercom.io/companies/{id}/contacts", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", + "companies", "{id}", - "archive" + "contacts" ], "query": [], "variable": [ { "key": "id", - "value": "63a07ddf05a32042dffac965", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", "disabled": false, - "description": "id" + "description": "The unique identifier for the company which is given by Intercom" } ] }, @@ -3655,8 +3763,8 @@ } ] }, - "method": "POST", - "description": "You can archive a single contact.", + "method": "GET", + "description": "You can fetch a list of all contacts that belong to a company.", "header": [ { "key": "Intercom-Version", @@ -3672,29 +3780,29 @@ "response": [] }, { - "name": "Unarchive contact", + "name": "List attached segments for companies", "tags": [ - "Contacts" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/unarchive", + "raw": "https://api.intercom.io/companies/{id}/segments", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", + "companies", "{id}", - "unarchive" + "segments" ], "query": [], "variable": [ { "key": "id", - "value": "63a07ddf05a32042dffac965", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", "disabled": false, - "description": "id" + "description": "The unique identifier for the company which is given by Intercom" } ] }, @@ -3718,8 +3826,8 @@ } ] }, - "method": "POST", - "description": "You can unarchive a single contact.", + "method": "GET", + "description": "You can fetch a list of all segments that belong to a company.", "header": [ { "key": "Intercom-Version", @@ -3735,31 +3843,29 @@ "response": [] }, { - "name": "Block contact", + "name": "Scroll over all companies", "tags": [ - "Contacts" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/block", + "raw": "https://api.intercom.io/companies/scroll", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{id}", - "block" + "companies", + "scroll" ], - "query": [], - "variable": [ + "query": [ { - "key": "id", - "value": "63a07ddf05a32042dffac965", - "disabled": false, - "description": "id" + "key": "scroll_param", + "value": "scroll_param", + "description": "" } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -3781,8 +3887,8 @@ } ] }, - "method": "POST", - "description": "Block a single contact.
**Note:** conversations of the contact will also be archived during the process.
More details in [FAQ How do I block Inbox spam?](https://www.intercom.com/help/en/articles/8838656-inbox-faqs)", + "method": "GET", + "description": " The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset.\n\n- Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.\n- If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail\n- If the end of the scroll is reached, \"companies\" will be empty and the scroll parameter will expire\n\n{% admonition type=\"info\" name=\"Scroll Parameter\" %}\n You can get the first page of companies by simply sending a GET request to the scroll endpoint.\n For subsequent requests you will need to use the scroll parameter from the response.\n{% /admonition %}\n{% admonition type=\"danger\" name=\"Scroll network timeouts\" %}\n Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message:\n \"Request failed due to an internal network error. Please restart the scroll operation.\"\n If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", @@ -3798,29 +3904,29 @@ "response": [] }, { - "name": "Update a contact", + "name": "Get a bulk companies job", "tags": [ - "Contacts", - "Custom Object Instances" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}", + "raw": "https://api.intercom.io/companies/bulk/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", + "companies", + "bulk", "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "63a07ddf05a32042dffac965", + "value": "job_v2_1", "disabled": false, - "description": "id" + "description": "The unique identifier for the bulk job." } ] }, @@ -3844,56 +3950,39 @@ } ] }, - "method": "PUT", - "description": "You can update an existing contact (ie. user or lead).\n\n{% admonition type=\"info\" %}\n This endpoint handles both **contact updates** and **custom object associations**.\n\n See _`update a contact with an association to a custom object instance`_ in the request/response examples to see the custom object association format.\n{% /admonition %}\n", + "method": "GET", + "description": "You can check the status of a bulk companies job. The `state` field indicates the overall job progress: `pending`, `running`, `completed`, or `completed_with_errors`.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"role\": \"\",\n \"external_id\": \"\",\n \"email\": \"jdoe@example.com\",\n \"phone\": \"+353871234567\",\n \"name\": \"John Doe\",\n \"avatar\": \"https://www.example.com/avatar_image.jpg\",\n \"signed_up_at\": 1571672154,\n \"last_seen_at\": 1571672154,\n \"owner_id\": 123,\n \"unsubscribed_from_emails\": true,\n \"language_override\": \"en\",\n \"custom_attributes\": \"\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Delete a contact", + "name": "Create or Update a company", "tags": [ - "Contacts" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}", + "raw": "https://api.intercom.io/companies", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{id}" + "companies" ], "query": [], - "variable": [ - { - "key": "id", - "value": "id", - "disabled": false, - "description": "id" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -3915,54 +4004,48 @@ } ] }, - "method": "DELETE", - "description": "You can delete a single contact.", + "method": "POST", + "description": "You can create or update a company.\n\nCompanies will be only visible in Intercom when there is at least one associated user.\n\nCompanies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated.\n\n{% admonition type=\"warning\" name=\"Using `company_id`\" %}\n You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Intercom\",\n \"company_id\": \"625e90fc55ab113b6d92175f\",\n \"plan\": \"Enterprise\",\n \"size\": \"100\",\n \"website\": \"https://www.example.com\",\n \"industry\": \"Manufacturing\",\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 9\n },\n \"remote_created_at\": 1394531169,\n \"monthly_spend\": 1000,\n \"update_last_request_at\": true\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - } - ] - }, - { - "name": "Content Snippets", - "item": [ + }, { - "name": "List all content snippets", + "name": "Search companies", "tags": [ - "Content Snippets" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/content_snippets", + "raw": "https://api.intercom.io/companies/search", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "content_snippets" - ], - "query": [ - { - "key": "page", - "value": "page", - "description": "The page of results to fetch." - }, - { - "key": "per_page", - "value": "per_page", - "description": "The number of results to return per page. Max value of 50." - } + "companies", + "search" ], + "query": [], "variable": [] }, "auth": { @@ -3985,47 +4068,65 @@ } ] }, - "method": "GET", - "description": "You can fetch a list of all content snippets for a workspace.", + "method": "POST", + "description": "You can search for companies by the value of their attributes in order to fetch exactly the companies you want.\n\nTo search for companies, send a `POST` request to `https://api.intercom.io/companies/search`, with a query object in the body defining your filters.\n\nNote that the API does not include companies who have no associated users in search results.\n\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `15` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiple's there can be:\n* There's a limit of max 2 nested filters\n* There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed as part of the Companies Model are searchable. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foobar\"`).\n\n| Field | Type |\n| ---------------------------------- | ------------------------------ |\n| company_id | String |\n| name | String |\n| created_at | Date (UNIX Timestamp) |\n| updated_at | Date (UNIX Timestamp) |\n| remote_created_at | Date (UNIX Timestamp) |\n| last_request_at | Date (UNIX Timestamp) |\n| monthly_spend | Integer |\n| session_count | Integer |\n| user_count | Integer |\n| tag_id | String |\n| custom_attributes.{attribute_name} | String |\n\nThe `plan.id` and `plan.name` fields are not searchable and return a `400` error with code `invalid_field`.\n\n### Accepted Operators\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). Searching by `tag_id` supports only the `=` and `!=` operators. The `IN` and `NIN` operators are not supported for Date fields.\n\n| Operator | Valid Types | Description |\n| :------- | :------------------------------- | :--------------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All except Date and tag_id | In
Shortcut for `OR` queries
Values must be in Array |\n| NIN | All except Date and tag_id | Not In
Shortcut for `OR !` queries
Values must be in Array |\n| > | Integer
Date (UNIX Timestamp) | Greater than |\n| < | Integer
Date (UNIX Timestamp) | Lower than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n\n### Sorting\n\nPass an optional `sort` object with a `field` and an `order` (`ascending` or `descending`; defaults to `descending`) to order the results. An invalid `order` returns a `400` error with code `invalid_sort_order`. `tag_id` can be used as a filter but not as a sort field.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"query\": {\n \"field\": \"created_at\",\n \"operator\": \"AND\",\n \"value\": \"73732934\"\n },\n \"pagination\": {\n \"per_page\": 2,\n \"starting_after\": \"your-cursor-from-response\"\n },\n \"sort\": {\n \"field\": \"created_at\",\n \"order\": \"descending\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a content snippet", + "name": "List all companies", "tags": [ - "Content Snippets" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/content_snippets/{id}", + "raw": "https://api.intercom.io/companies/list", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "content_snippets", - "{id}" + "companies", + "list" ], - "query": [], - "variable": [ + "query": [ { - "key": "id", - "value": "id", - "disabled": false, - "description": "The unique identifier for the content snippet." + "key": "page", + "value": "1", + "description": "The page of results to fetch. Defaults to first page" + }, + { + "key": "per_page", + "value": "15", + "description": "How many results to return per page. Defaults to 15" + }, + { + "key": "order", + "value": "desc", + "description": "`asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc" } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -4047,8 +4148,8 @@ } ] }, - "method": "GET", - "description": "You can fetch a single content snippet by its id.", + "method": "POST", + "description": "You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first.\n\nNote that the API does not include companies who have no associated users in list responses.\n\nWhen using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies).\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", @@ -4064,22 +4165,32 @@ "response": [] }, { - "name": "Create a content snippet", + "name": "Attach a Contact to a Company", "tags": [ - "Content Snippets" + "Companies", + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/content_snippets", + "raw": "https://api.intercom.io/contacts/{id}/companies", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "content_snippets" + "contacts", + "{id}", + "companies" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } + ] }, "auth": { "type": "bearer", @@ -4102,7 +4213,7 @@ ] }, "method": "POST", - "description": "You can create a new content snippet.", + "description": "You can attach a company to a single contact.", "header": [ { "key": "Intercom-Version", @@ -4119,7 +4230,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"title\": \"How to reset your password\",\n \"json_blocks\": [\n {\n \"type\": \"paragraph\",\n \"text\": \"Navigate to Settings > Security > Reset password.\"\n }\n ],\n \"locale\": \"en\"\n}", + "raw": "{\n \"id\": \"58a430d35458202d41b1e65b\"\n}", "urlencoded": [], "formdata": [] } @@ -4127,30 +4238,23 @@ "response": [] }, { - "name": "Update a content snippet", + "name": "Bulk create or update companies", "tags": [ - "Content Snippets" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/content_snippets/{id}", + "raw": "https://api.intercom.io/companies/bulk", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "content_snippets", - "{id}" + "companies", + "bulk" ], "query": [], - "variable": [ - { - "key": "id", - "value": "id", - "disabled": false, - "description": "The unique identifier for the content snippet." - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -4172,8 +4276,8 @@ } ] }, - "method": "PUT", - "description": "You can update an existing content snippet.", + "method": "POST", + "description": "You can bulk create or update companies by submitting an array of company objects. Each company is matched on the `company_id` you have defined for it: a new company is created if none exists with that `company_id`, otherwise the matching company is updated. This mirrors the single [Create or update a company](/docs/references/preview/rest-api/api.intercom.io/companies/createorupdatecompany) endpoint.\n\nThe endpoint creates an async job that processes the items in the background. Use the returned job ID with `GET /companies/bulk/{id}` to check the job status.\n\n{% admonition type=\"info\" name=\"Handling failures\" %}\n If an item fails validation, that item is rejected and the job's `state` ends as `completed_with_errors`. The other companies in the same request are still processed. The job `state` from `GET /companies/bulk/{id}` is the signal that one or more items were rejected.\n{% /admonition %}\n\n{% admonition type=\"info\" name=\"Limits\" %}\n - Maximum of 100 companies per request.\n - You can append tasks to an existing job by including `job.id` in the request body.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", @@ -4190,45 +4294,31 @@ ], "body": { "mode": "raw", - "raw": "{\n \"title\": \"How to reset your password\",\n \"json_blocks\": [\n {\n \"type\": \"paragraph\",\n \"text\": \"Navigate to Settings > Security > Reset password.\"\n }\n ],\n \"locale\": \"en\"\n}", + "raw": "{\n \"companies\": [\n {\n \"company_id\": \"625e90fc55ab113b6d92175f\",\n \"name\": \"Acme Corp\",\n \"plan\": \"Enterprise\",\n \"size\": 100,\n \"website\": \"https://www.example.com\",\n \"industry\": \"Manufacturing\",\n \"custom_attributes\": \"\",\n \"remote_created_at\": 1394531169,\n \"monthly_spend\": 1000,\n \"update_last_request_at\": true\n }\n ],\n \"job\": {\n \"id\": \"job_v2_1\"\n }\n}", "urlencoded": [], "formdata": [] } }, "response": [] - } - ] - }, - { - "name": "Conversations", - "item": [ + }, { - "name": "List all conversations", + "name": "Bulk delete companies", "tags": [ - "Conversations" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations", + "raw": "https://api.intercom.io/companies/bulk/delete", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations" - ], - "query": [ - { - "key": "per_page", - "value": "per_page", - "description": "How many results per page" - }, - { - "key": "starting_after", - "value": "starting_after", - "description": "String used to get the next page of conversations." - } + "companies", + "bulk", + "delete" ], + "query": [], "variable": [] }, "auth": { @@ -4251,61 +4341,54 @@ } ] }, - "method": "GET", - "description": "You can fetch a list of all conversations.\n\nYou can optionally request the result page size and the cursor to start after to fetch the result.\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", + "method": "POST", + "description": "You can bulk delete companies by submitting an array of companies, each identified by its Intercom company `id`. Deleting a company detaches all of its associated contacts but keeps the company record itself — the same archival behaviour as the single [Delete a company](/docs/references/preview/rest-api/api.intercom.io/companies/deletecompany) endpoint.\n\nThe endpoint creates an async job that processes the deletes in the background. Use the returned job ID with `GET /companies/bulk/{id}` to check the job status.\n\n{% admonition type=\"info\" name=\"Limits\" %}\n - Maximum of 100 companies per request.\n - You can append tasks to an existing job by including `job.id` in the request body.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"companies\": [\n {\n \"id\": \"531ee472cce572a6ec000006\"\n }\n ],\n \"job\": {\n \"id\": \"job_v2_1\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a conversation", + "name": "Update a company", "tags": [ - "Conversations" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}", + "raw": "https://api.intercom.io/companies/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", + "companies", "{id}" ], - "query": [ - { - "key": "display_as", - "value": "plaintext", - "description": "Set to plaintext to retrieve conversation messages in plain text. This affects both the body and subject fields." - }, - { - "key": "include_translations", - "value": "true", - "description": "If set to true, conversation parts will be translated to the detected language of the conversation." - }, - { - "key": "include_email_history", - "value": "true", - "description": "If set to true, the source of the conversation will include the email history." - } - ], + "query": [], "variable": [ { "key": "id", - "value": "123", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", "disabled": false, - "description": "The id of the conversation to target" + "description": "The unique identifier for the company which is given by Intercom" } ] }, @@ -4329,8 +4412,8 @@ } ] }, - "method": "GET", - "description": "\nYou can fetch the details of a single conversation.\n\nThis will return a single Conversation model with all its conversation parts.\n\n{% admonition type=\"warning\" name=\"Hard limit of 500 parts\" %}\nThe maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts.\n{% /admonition %}\n\nFor AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671).\n", + "method": "PUT", + "description": "You can update a single company using the Intercom provisioned `id`.\n\n{% admonition type=\"warning\" name=\"Using `company_id`\" %}\n When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", @@ -4346,31 +4429,23 @@ "response": [] }, { - "name": "List handling events", + "name": "Bulk update companies", "tags": [ - "Conversations" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}/handling_events", + "raw": "https://api.intercom.io/companies/bulk", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{id}", - "handling_events" + "companies", + "bulk" ], "query": [], - "variable": [ - { - "key": "id", - "value": "123", - "disabled": false, - "description": "The identifier for the conversation as given by Intercom." - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -4392,57 +4467,54 @@ } ] }, - "method": "GET", - "description": "List all pause/resume events for a conversation. These events track when teammates paused or resumed handling a conversation.\n\nRequires the `read_conversations` OAuth scope.\n", + "method": "PUT", + "description": "You can bulk update companies by submitting an array of company objects with the fields to update. Each company must include an `id` field identifying the company to update by its Intercom company `id`. An unknown `id` fails that item and never creates a company.\n\nOnly the fields listed in the request schema below can be set. Any other fields in a company object are ignored.\n\nThe endpoint creates an async job that processes the updates in the background. Use the returned job ID with `GET /companies/bulk/{id}` to check the job status.\n\n{% admonition type=\"info\" name=\"Limits\" %}\n - Maximum of 100 companies per request.\n - You can append tasks to an existing job by including `job.id` in the request body.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"companies\": [\n {\n \"id\": \"531ee472cce572a6ec000006\",\n \"name\": \"Acme Corp\",\n \"plan\": \"Enterprise\",\n \"size\": 100,\n \"website\": \"https://www.example.com\",\n \"industry\": \"Manufacturing\",\n \"custom_attributes\": \"\",\n \"remote_created_at\": 1394531169,\n \"monthly_spend\": 1000,\n \"update_last_request_at\": true\n }\n ],\n \"job\": {\n \"id\": \"job_v2_1\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List side conversations", + "name": "Delete a company", "tags": [ - "Conversations" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}/side_conversations", + "raw": "https://api.intercom.io/companies/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{id}", - "side_conversations" - ], - "query": [ - { - "key": "page", - "value": "page", - "description": "The page number of results to return (starting from 1)." - }, - { - "key": "per_page", - "value": "per_page", - "description": "The number of side conversations to return per page (max 50)." - } + "companies", + "{id}" ], + "query": [], "variable": [ { "key": "id", - "value": "123", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", "disabled": false, - "description": "The identifier for the conversation as given by Intercom." + "description": "The unique identifier for the company which is given by Intercom" } ] }, @@ -4466,8 +4538,8 @@ } ] }, - "method": "GET", - "description": "List side conversations for a given conversation. Side conversations are internal threads created by teammates from within a conversation.\n\nEach side conversation includes its conversation parts (messages). Results are paginated.\n\nRequires the `read_conversations` OAuth scope.\n", + "method": "DELETE", + "description": "Delete a single company.\n\nThe company record is kept in your workspace, but all contacts are detached. The contacts themselves are not deleted. Detaching contacts is permanent and can't be reversed. A `company.deleted` webhook is sent when the company is deleted. These changes may take some time to be reflected in your workspace.\n\n{% admonition type=\"warning\" %}\nThird-party integrations that sync companies into Intercom (for example, Salesforce or Chargebee) will recreate any company deleted through this endpoint on their next sync. To prevent recreation, remove or filter the company at the source integration before deleting it via the API.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", @@ -4483,39 +4555,39 @@ "response": [] }, { - "name": "List all deleted conversation IDs", + "name": "Detach a contact from a company", "tags": [ - "Conversations" + "Companies", + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/deleted", + "raw": "https://api.intercom.io/contacts/{contact_id}/companies/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "deleted" - ], - "query": [ - { - "key": "page", - "value": "1", - "description": "The page of results to fetch. Defaults to first page" - }, + "contacts", + "{contact_id}", + "companies", + "{id}" + ], + "query": [], + "variable": [ { - "key": "per_page", - "value": "per_page", - "description": "How many results per page" + "key": "contact_id", + "value": "58a430d35458202d41b1e65b", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" }, { - "key": "order", - "value": "desc", - "description": "`asc` or `desc`. Returns the conversation IDs in ascending or descending order. Defaults to desc" + "key": "id", + "value": "58a430d35458202d41b1e65b", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -4537,8 +4609,8 @@ } ] }, - "method": "GET", - "description": "List all deleted conversation IDs.\n\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `20` results per page. You can navigate to next pages using the `page` param.\n{% /admonition %}\n", + "method": "DELETE", + "description": "You can detach a company from a single contact.", "header": [ { "key": "Intercom-Version", @@ -4552,24 +4624,39 @@ "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Contacts", + "item": [ { - "name": "Creates a conversation", + "name": "List attached companies for contact", "tags": [ - "Conversations" + "Contacts", + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations", + "raw": "https://api.intercom.io/contacts/{id}/companies", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations" + "contacts", + "{id}", + "companies" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } + ] }, "auth": { "type": "bearer", @@ -4591,49 +4678,65 @@ } ] }, - "method": "POST", - "description": "You can create a conversation that has been initiated by a contact (ie. user or lead).\nThe conversation can be an in-app message only.\n\n{% admonition type=\"info\" name=\"Sending for visitors\" %}\nYou can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`.\nThis visitor will be automatically converted to a contact with a lead role once the conversation is created.\n{% /admonition %}\n\nThis will return the Message model that has been created.\n\n", + "method": "GET", + "description": "You can fetch a list of companies that are associated to a contact.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"from\": {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n \"body\": \"Hello\",\n \"subject\": \"Thanks for everything\",\n \"attachment_urls\": \"\",\n \"created_at\": 1671028894\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Search conversations", + "name": "List granted companies for a contact (Preview)", "tags": [ - "Conversations" + "Contacts", + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/search", + "raw": "https://api.intercom.io/contacts/{contact_id}/granted_companies", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "search" + "contacts", + "{contact_id}", + "granted_companies" ], - "query": [], - "variable": [] + "query": [ + { + "key": "page", + "value": "1", + "description": "The page number to retrieve, starting at 1." + }, + { + "key": "per_page", + "value": "50", + "description": "The number of company ids to return per page. Values above 150 are reduced to 150." + }, + { + "key": "order", + "value": "asc", + "description": "The direction to sort the company ids in. Any other value is treated as `desc`." + } + ], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } + ] }, "auth": { "type": "bearer", @@ -4655,55 +4758,47 @@ } ] }, - "method": "POST", - "description": "You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`.\n\nThis will accept a query object in the body which will define your filters in order to search for conversations.\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiple's there can be:\n- There's a limit of max 2 nested filters\n- There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed in the conversation model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foorbar\"`).\nThe `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `\"I need support\"` body - the query should contain a `=` operator with the value `\"support\"` for such conversation to be returned. A query with a `=` operator and a `\"need support\"` value will not yield a result.\n\n| Field | Type |\n| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| source.type | String
Accepted fields are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. |\n| source.id | String |\n| source.delivered_as | String |\n| source.subject | String |\n| source.body | String |\n| source.author.id | String |\n| source.author.type | String |\n| source.author.name | String |\n| source.author.email | String |\n| source.url | String |\n| contact_ids | String |\n| teammate_ids | String |\n| admin_assignee_id | String |\n| team_assignee_id | String |\n| channel_initiated | String |\n| open | Boolean |\n| read | Boolean |\n| state | String |\n| waiting_since | Date (UNIX timestamp) |\n| snoozed_until | Date (UNIX timestamp) |\n| tag_ids | String |\n| priority | String |\n| statistics.time_to_assignment | Integer |\n| statistics.time_to_admin_reply | Integer |\n| statistics.time_to_first_close | Integer |\n| statistics.time_to_last_close | Integer |\n| statistics.median_time_to_reply | Integer |\n| statistics.first_contact_reply_at | Date (UNIX timestamp) |\n| statistics.first_assignment_at | Date (UNIX timestamp) |\n| statistics.first_admin_reply_at | Date (UNIX timestamp) |\n| statistics.first_close_at | Date (UNIX timestamp) |\n| statistics.last_assignment_at | Date (UNIX timestamp) |\n| statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) |\n| statistics.last_contact_reply_at | Date (UNIX timestamp) |\n| statistics.last_admin_reply_at | Date (UNIX timestamp) |\n| statistics.last_close_at | Date (UNIX timestamp) |\n| statistics.last_closed_by_id | String |\n| statistics.count_reopens | Integer |\n| statistics.count_assignments | Integer |\n| statistics.count_conversation_parts | Integer |\n| conversation_rating.requested_at | Date (UNIX timestamp) |\n| conversation_rating.replied_at | Date (UNIX timestamp) |\n| conversation_rating.score | Integer |\n| conversation_rating.remark | String |\n| conversation_rating.contact_id | String |\n| conversation_rating.admin_d | String |\n| ai_agent_participated | Boolean |\n| ai_agent.resolution_state | String |\n| ai_agent.last_answer_type | String |\n| ai_agent.rating | Integer |\n| ai_agent.rating_remark | String |\n| ai_agent.source_type | String |\n| ai_agent.source_title | String |\n\n### Accepted Operators\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "method": "GET", + "description": "List the companies a contact has been granted access to.\n\nA granted company lets the contact read that company's tickets in the customer portal. It is separate from company membership — granting a company does not attach the contact to it, and [`GET /contacts/{id}/companies`](/docs/references/preview/rest-api/api.intercom.io/contacts/listcompaniesforacontact) does not include grants.\n\n`company_ids` holds the `company_id` values you set on your companies, so the list round-trips with the `company_ids` you send to `PUT /contacts/{contact_id}/granted_companies`. The list is sorted by company id and paginated.\n\nReturns an empty list when granted companies are not enabled for the workspace.\n\nRequires the `read_users_companies` OAuth scope. Set `Intercom-Version: Preview`.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"query\": {\n \"field\": \"created_at\",\n \"operator\": \"AND\",\n \"value\": \"73732934\"\n },\n \"pagination\": {\n \"per_page\": 2,\n \"starting_after\": \"your-cursor-from-response\"\n }\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Reply to a conversation", + "name": "List attached segments for contact", "tags": [ - "Conversations" + "Contacts", + "Segments" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}/reply", + "raw": "https://api.intercom.io/contacts/{contact_id}/segments", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{id}", - "reply" + "contacts", + "{contact_id}", + "segments" ], "query": [], "variable": [ { - "key": "id", - "value": "123 or \"last\"", + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "The Intercom provisioned identifier for the conversation or the string \"last\" to reply to the last part of the conversation" + "description": "The unique identifier for the contact which is given by Intercom" } ] }, @@ -4727,55 +4822,47 @@ } ] }, - "method": "POST", - "description": "You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins.", + "method": "GET", + "description": "You can fetch a list of segments that are associated to a contact.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"message_type\": \"comment\",\n \"type\": \"admin\",\n \"body\": \"Hello there!\",\n \"created_at\": 1590000000,\n \"attachment_urls\": \"\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"admin_id\": \"3156780\",\n \"attachment_files\": [\n {\n \"content_type\": \"application/json\",\n \"data\": \"ewogICJ0ZXN0IjogMQp9\",\n \"name\": \"test.json\"\n }\n ]\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Manage a conversation", + "name": "List subscriptions for a contact", "tags": [ - "Conversations" + "Contacts", + "Subscription Types" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}/parts", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{id}", - "parts" + "contacts", + "{contact_id}", + "subscriptions" ], "query": [], "variable": [ { - "key": "id", - "value": "123", + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "The identifier for the conversation as given by Intercom." + "description": "The unique identifier for the contact which is given by Intercom" } ] }, @@ -4799,55 +4886,47 @@ } ] }, - "method": "POST", - "description": "For managing conversations you can:\n- Close a conversation\n- Snooze a conversation to reopen on a future date\n- Open a conversation which is `snoozed` or `closed`\n- Assign a conversation to an admin and/or team.\n", + "method": "GET", + "description": "You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type.\nThis will return a list of Subscription Type objects that the contact is associated with.\n\nThe data property will show a combined list of:\n\n 1.Opt-out subscription types that the user has opted-out from.\n 2.Opt-in subscription types that the user has opted-in to receiving.\n\n**Note:** This endpoint only returns subscriptions where the contact has explicitly configured their preference. Subscriptions that are in the default state — where the contact has not made an explicit opt-in or opt-out choice — are not included in the response.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"message_type\": \"assignment\",\n \"type\": \"admin\",\n \"admin_id\": \"12345\",\n \"body\": \"Let me pass you over to one of my colleagues.\",\n \"snoozed_until\": 1673609604,\n \"assignee_id\": \"4324241\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Attach a contact to a conversation", + "name": "List tags attached to a contact", "tags": [ - "Conversations" + "Contacts", + "Tags" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}/customers", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{id}", - "customers" + "contacts", + "{contact_id}", + "tags" ], "query": [], "variable": [ { - "key": "id", - "value": "123", + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "The identifier for the conversation as given by Intercom." + "description": "The unique identifier for the contact which is given by Intercom" } ] }, @@ -4871,48 +4950,50 @@ } ] }, - "method": "POST", - "description": "You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.\n\n{% admonition type=\"warning\" name=\"Contacts without an email\" %}\nIf 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`.\n{% /admonition %}\n\n", + "method": "GET", + "description": "You can fetch a list of all tags that are attached to a specific contact.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"admin_id\": \"12345\",\n \"customer\": {\n \"intercom_user_id\": \"6329bd9ffe4e2e91dac76188\",\n \"customer\": {\n \"intercom_user_id\": \"6329bd9ffe4e2e91dac76188\",\n \"user_id\": \"2e91dac761886329bd9ffe4e\",\n \"email\": \"sam.sung@example.com\"\n },\n \"user_id\": \"6329bd9ffe4e2e91dac76188\",\n \"email\": \"winstonsmith@truth.org\"\n }\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Redact a conversation part", + "name": "List deleted contacts", "tags": [ - "Conversations" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/redact", + "raw": "https://api.intercom.io/contacts/deleted", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "redact" + "contacts", + "deleted" + ], + "query": [ + { + "key": "per_page", + "value": "per_page", + "description": "The number of results per page. Defaults to `10`, with a maximum of `150`." + }, + { + "key": "page", + "value": "page", + "description": "The page of results to fetch. Defaults to `1`." + } ], - "query": [], "variable": [] }, "auth": { @@ -4935,55 +5016,51 @@ } ] }, - "method": "POST", - "description": "You can redact a conversation part or the source message of a conversation (as seen in the source object).\n\n{% admonition type=\"info\" name=\"Redacting parts and messages\" %}\nIf you are redacting a conversation part, it must have a `body`. If you are redacting a source message, it must have been created by a contact. We will return a `conversation_part_not_redactable` error if these criteria are not met.\n{% /admonition %}\n\n", + "method": "GET", + "description": "Fetch a paginated list of the contacts in your workspace that are no longer active,\nso you can recover ones whose `id`, `email`, or `external_id` you no longer have and\nthen permanently delete them. Each entry carries a `status` describing why the contact\nis inactive: `archived`, `blocked`, `merged`, `pending_deletion`, or `permanently_deleted`.\n`merged_into_id` is present only when `status` is `merged`, and `external_id` and `email`\nare `null` for `permanently_deleted` contacts.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"source\",\n \"conversation_id\": \"19894788788\",\n \"conversation_part_id\": \"19381789428\",\n \"source_id\": \"19894781231\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Convert a conversation to a ticket", + "name": "Get a contact", "tags": [ - "Conversations" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}/convert", + "raw": "https://api.intercom.io/contacts/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{id}", - "convert" + "contacts", + "{id}" + ], + "query": [ + { + "key": "include_merge_history", + "value": "include_merge_history", + "description": "Pass `true` to include the contact's merge history in the response. Only returned for contacts with a `user` role." + } ], - "query": [], "variable": [ { "key": "id", - "value": "123", + "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "The id of the conversation to target" + "description": "id" } ] }, @@ -5007,63 +5084,51 @@ } ] }, - "method": "POST", - "description": "You can convert a conversation to a ticket.", + "method": "GET", + "description": "You can fetch the details of a single contact.\n\n{% admonition type=\"info\" name=\"Merged contacts return 410 Gone\" %}\n If a contact has been merged into another contact via the Merge endpoint (`POST /contacts/merge`), requesting it by its original ID will return **HTTP 410 Gone** with a `Link` header pointing to the canonical (merged-into) contact.\n\n **Response headers:**\n ```\n Link: ; rel=\"canonical\"\n ```\n\n **Response body:**\n ```json\n {\n \"type\": \"error.list\",\n \"errors\": [{ \"code\": \"contact_merged\", \"message\": \"This contact has been merged. See the 'Link' header for the canonical contact.\" }]\n }\n ```\n\n The `Link` header contains the path to the final merge target, resolving multi-hop merge chains (up to 3 hops).\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"ticket_type_id\": \"1234\",\n \"ticket_state_id\": \"123\",\n \"attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n }\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Update a conversation", + "name": "List all contact activities", "tags": [ - "Conversations", - "Custom Object Instances" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}", + "raw": "https://api.intercom.io/contacts/activities", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{id}" + "contacts", + "activities" ], "query": [ { - "key": "display_as", - "value": "plaintext", - "description": "Set to plaintext to retrieve conversation messages in plain text. This affects both the body and subject fields." - } - ], - "variable": [ + "key": "per_page", + "value": "per_page", + "description": "The number of results to return per page. Defaults to 50, minimum 1, maximum 150." + }, { - "key": "id", - "value": "123", - "disabled": false, - "description": "The id of the conversation to target" + "key": "starting_after", + "value": "starting_after", + "description": "The cursor value from `pages.next.starting_after` in a previous response. Used to paginate through results." } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -5085,64 +5150,45 @@ } ] }, - "method": "PUT", - "description": "\nYou can update an existing conversation.\n\n{% admonition type=\"info\" name=\"Replying and other actions\" %}\nIf you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints.\n{% /admonition %}\n\n{% admonition type=\"info\" %}\n This endpoint handles both **conversation updates** and **custom object associations**.\n\n See _`update a conversation with an association to a custom object instance`_ in the request/response examples to see the custom object association format.\n{% /admonition %}\n\n", + "method": "GET", + "description": "You can fetch a list of contact activity events for your workspace, such as when contacts are created, role updated, merged, or deleted. Events are returned oldest first.\n\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `50` results per page, with a maximum of `150`.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"read\": true,\n \"title\": \"Conversation Title\",\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 9,\n \"start_date_iso8601\": \"2023-03-04T09:46:14Z\",\n \"end_date_timestamp\": 1677923174,\n \"CX Score rating\": 4,\n \"CX Score explanation\": \"The conversation was resolved quickly and the customer expressed satisfaction with the outcome.\"\n },\n \"company_id\": \"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Update a conversation part", + "name": "List all contacts", "tags": [ - "Conversations" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{conversation_id}/conversation_parts/{id}", + "raw": "https://api.intercom.io/contacts", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{conversation_id}", - "conversation_parts", - "{id}" + "contacts" ], - "query": [], - "variable": [ - { - "key": "conversation_id", - "value": "123", - "disabled": false, - "description": "The identifier for the conversation as given by Intercom." - }, + "query": [ { - "key": "id", - "value": "456", - "disabled": false, - "description": "The identifier for the conversation part." + "key": "include_merge_history", + "value": "include_merge_history", + "description": "Pass `true` to include a `merge_history` array on each contact in the response. Only returned for contacts with a `user` role." } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -5164,60 +5210,52 @@ } ] }, - "method": "PUT", - "description": "You can update properties of a conversation part. Currently supports updating the send state of an external reply or marking a part as seen by an admin.\n\n{% admonition type=\"warning\" name=\"Experimental\" %}\n This is an experimental endpoint. It requires a valid HMAC secret for authentication in addition to the standard bearer token.\n{% /admonition %}\n", + "method": "GET", + "description": "You can fetch a list of all contacts (ie. users or leads) in your workspace.\n{% admonition type=\"info\" name=\"Merged contacts\" %}\n Contacts that have been merged (via POST /contacts/merge) will not appear in list results. Only the target contact from the merge remains accessible.\n{% /admonition %}\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `10` results per page, with a maximum of `150`.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"send_state\": \"sent\",\n \"info_message\": \"Message delivered successfully\",\n \"seen\": true,\n \"admin_id\": \"991267694\",\n \"experimental\": true,\n \"secret\": \"hmac_secret_value\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Delete a conversation", + "name": "Get a contact by External ID", "tags": [ - "Conversations" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}", + "raw": "https://api.intercom.io/contacts/find_by_external_id/{external_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{id}" + "contacts", + "find_by_external_id", + "{external_id}" ], "query": [ { - "key": "retain_metrics", - "value": "true", - "description": "If true (default), deletes the conversation while retaining reporting data. If false, deletes the conversation and all associated reporting data. Setting to false requires the `delete_conversations_and_metrics` OAuth scope." + "key": "include_merge_history", + "value": "include_merge_history", + "description": "Pass `true` to include the contact's merge history in the response. Only returned for contacts with a `user` role." } ], "variable": [ { - "key": "id", - "value": "id", + "key": "external_id", + "value": "cdd29344-5e0c-4ef0-ac56-f9ba2979bc27", "disabled": false, - "description": "id" + "description": "The external ID of the user that you want to retrieve" } ] }, @@ -5241,8 +5279,8 @@ } ] }, - "method": "DELETE", - "description": "{% admonition type=\"warning\" name=\"Irreversible operation\" %}\nDeleting a conversation is permanent and cannot be reversed.\n{% /admonition %}\n\nYou can delete a single conversation. The behavior depends on the `retain_metrics` parameter:\n\n- **With `retain_metrics=true` (default)**: Deletes the conversation while retaining reporting data. The conversation will still appear in reporting, though some data may be incomplete due to the deletion.\n\n- **With `retain_metrics=false`**: Deletes the conversation and all associated reporting data. The conversation will be completely removed from both the inbox and all reporting.\n\n{% admonition type=\"info\" name=\"Required scope for retain_metrics=false\" %}\nUsing `retain_metrics=false` requires the `delete_conversations_and_metrics` OAuth scope.\n{% /admonition %}\n\nFor more info, see [this help center article](https://www.intercom.com/help/en/articles/13885146-deleting-a-conversation).\n", + "method": "GET", + "description": "You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads.\n\n{% admonition type=\"info\" name=\"Merged contacts return 410 Gone\" %}\n If the contact with this external ID has been merged into another contact, the API returns **HTTP 410 Gone** with a `Link` header pointing to the canonical (merged-into) contact. See `GET /contacts/{id}` for details on the response format.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", @@ -5258,36 +5296,45 @@ "response": [] }, { - "name": "Detach a contact from a group conversation", + "name": "Get contact merge history", "tags": [ - "Conversations" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{conversation_id}/customers/{contact_id}", + "raw": "https://api.intercom.io/contacts/{id}/merge_history", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{conversation_id}", - "customers", - "{contact_id}" + "contacts", + "{id}", + "merge_history" ], - "query": [], - "variable": [ + "query": [ { - "key": "conversation_id", - "value": "123", - "disabled": false, - "description": "The identifier for the conversation as given by Intercom." + "key": "cursor", + "value": "cursor", + "description": "A cursor for pagination. Pass the `next_cursor` value from a previous response to fetch the next page." }, { - "key": "contact_id", - "value": "123", + "key": "per_page", + "value": "per_page", + "description": "The number of results to return per page (default 50, max 150)." + }, + { + "key": "order", + "value": "order", + "description": "The order to return results in. Defaults to descending." + } + ], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "The identifier for the contact as given by Intercom." + "description": "The id of the contact to fetch merge history for." } ] }, @@ -5311,54 +5358,48 @@ } ] }, - "method": "DELETE", - "description": "You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.\n\n{% admonition type=\"warning\" name=\"Contacts without an email\" %}\nIf 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`.\n{% /admonition %}\n\n", + "method": "GET", + "description": "Retrieve the paginated list of contacts that have been merged into a given contact.\n\nOnly available for contacts with a `user` role. Returns a `404` if the contact is not found or has a `lead` role.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"admin_id\": \"5017690\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] - } - ] - }, - { - "name": "Custom Channel Events", - "item": [ + }, { - "name": "Notify Intercom of a new conversation created in a custom channel", + "name": "Get a bulk update job", "tags": [ - "Custom Channel Events" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_channel_events/notify_new_conversation", + "raw": "https://api.intercom.io/contacts/bulk/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_channel_events", - "notify_new_conversation" + "contacts", + "bulk", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "job_v2_1", + "disabled": false, + "description": "The unique identifier for the bulk job." + } + ] }, "auth": { "type": "bearer", @@ -5380,48 +5421,45 @@ } ] }, - "method": "POST", - "description": "Notifies Intercom that a new conversation was created in your custom channel/platform. This triggers conversation creation and workflow automations within Intercom for your custom channel integration.\n> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.\n", + "method": "GET", + "description": "You can check the status of a bulk contact update job. The `state` field indicates the overall job progress: `pending`, `running`, `completed`, or `completed_with_errors`.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"event_id\": \"\",\n \"external_conversation_id\": \"\",\n \"contact\": {\n \"type\": \"user\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Notify Intercom of a new message in a custom channel conversation", + "name": "Merge two contacts", "tags": [ - "Custom Channel Events" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_channel_events/notify_new_message", + "raw": "https://api.intercom.io/contacts/merge", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_channel_events", - "notify_new_message" + "contacts", + "merge" + ], + "query": [ + { + "key": "include_merge_history", + "value": "include_merge_history", + "description": "Pass `true` to include the merge history of the resulting contact in the response. Only returned for contacts with a `user` role." + } ], - "query": [], "variable": [] }, "auth": { @@ -5445,7 +5483,7 @@ ] }, "method": "POST", - "description": "Notifies Intercom that a new message was sent in a conversation on your custom channel/platform. This allows Intercom to process the message and trigger any relevant workflow automations.\n> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.\n", + "description": "You can merge one contact into another. Both lead-into-user and user-into-user merges are supported: the source contact (`from`) may have a `role` of `lead` or `user`, and the destination contact (`into`) must have a `role` of `user`.\n\n{% admonition type=\"warning\" name=\"User-to-user merges\" %}\n When you merge a user into another user, the source user's attribute values (standard and custom) are discarded and are not moved onto the target user. The target user keeps its own attribute values. Records associated with the source, such as conversations, notes, and tags, are still reassigned to the target.\n\n Merging a user into another user requires the `merge_users` OAuth scope on your access token, in addition to the scope required for lead-into-user merges. Tokens without this scope receive a `401 Unauthorized` when the source contact is a user.\n{% /admonition %}\n\n{% admonition type=\"warning\" name=\"Merged contacts are not retrievable via the API\" %}\n Once a merge is completed, the source contact (`from`) is permanently removed from the active contact list. This means:\n - **GET /contacts/{id}** — Requesting the source contact by its original ID will return `410 Gone` with a `Link` header pointing to the canonical (merged-into) contact.\n - **POST /contacts/search** — The source contact will not appear in search results, including queries filtered by `updated_at`.\n - **GET /contacts** — The source contact will not appear in list results.\n\n Only the target contact (`into`) remains accessible. If your application stores contact IDs, update them to use the target contact's ID after a merge.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", @@ -5462,7 +5500,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"event_id\": \"\",\n \"external_conversation_id\": \"\",\n \"contact\": {\n \"type\": \"user\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"body\": \"\"\n}", + "raw": "{\n \"from\": \"5d70dd30de4efd54f42fd526\",\n \"into\": \"5ba682d23d7cf92bef87bfd4\",\n \"skip_duplicate_validation\": false\n}", "urlencoded": [], "formdata": [] } @@ -5470,20 +5508,21 @@ "response": [] }, { - "name": "Notify Intercom of a quick reply response in a custom channel conversation", + "name": "Preview a contact merge", "tags": [ - "Custom Channel Events" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_channel_events/notify_quick_reply_selected", + "raw": "https://api.intercom.io/contacts/merge/preview", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_channel_events", - "notify_quick_reply_selected" + "contacts", + "merge", + "preview" ], "query": [], "variable": [] @@ -5509,7 +5548,7 @@ ] }, "method": "POST", - "description": "Notifies Intercom that a user selected a quick reply option in your custom channel/platform. This allows Intercom to process the response and trigger any relevant workflow automations.\n> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.\n", + "description": "Preview the result of merging one contact into another without applying the merge. This is a read-only dry run: it reports whether the merge is allowed and, if so, exactly what would change, **without modifying any data**.\n\nSend the same `from` and `into` contact IDs you would pass to [Merge two contacts](/docs/references/preview/rest-api/api.intercom.io/contacts/mergecontact). As with the merge endpoint, `from` may have a `role` of `lead` or `user`, and `into` must have a `role` of `user`. You can optionally pass `custom_attribute_names` to include specific custom attributes in the previewed attribute changes.\n\n- When `allowed` is `true`, the response contains a `summary`: every attribute change (with the resulting value on the surviving contact) and, for each object type, two counts — `from`, how many are on the source contact and would move to the destination, and `into`, how many the destination already has. Counts are reported for conversations, tickets, phone calls, notes, and tags. `conversations` counts non-ticket conversations only; tickets are reported separately under `tickets`, and `phone_calls` is present only for phone-channel merges.\n- When `allowed` is `false`, the response contains `reasons`. Each reason has a stable `code` you can branch on and a human-readable `message` you can display.\n\n{% admonition type=\"warning\" name=\"Previewing non-duplicate contacts\" %}\nBy default a merge requires the two contacts to share an identifier (email or phone). Set `skip_duplicate_validation` to `true` to preview a merge of contacts that don't, the same rule the merge endpoint enforces.\n{% /admonition %}\n\nWhen `allowed` is `false`, `reasons[].code` is one of:\n\n| code | meaning |\n| --- | --- |\n| `source_same_as_target` | The source contact (`from`) and the destination contact (`into`) are the same contact. A contact can't be merged into itself. |\n| `invalid_merge_role_pair` | The `from`/`into` roles aren't mergeable. `into` must be a user. |\n| `no_shared_identifier` | The contacts share no email or phone. Set `skip_duplicate_validation` to preview anyway. |\n| `facebook_user` | Facebook contacts can't be merged. |\n| `external_lead_channel_not_allowed` | The source is an external-channel lead that isn't eligible for merging. |\n| `mailing_list` | Contacts created from a mailing list can't be merged. |\n| `user_to_lead` | `into` is a lead or visitor. A user can only be merged into another user. |\n| `whatsapp_data_cannot_be_merged` | The WhatsApp number on the source contact can't be reassigned to the destination. |\n| `telegram_data_cannot_be_merged` | The Telegram sender on the source contact can't be reassigned to the destination. |\n| `source_has_telegram_data` | The source contact has Telegram data, which user-into-user merges don't yet support moving. |\n| `phone_data_cannot_be_merged` | The phone data on the source contact can't be reassigned to the destination. |\n", "header": [ { "key": "Intercom-Version", @@ -5526,7 +5565,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"event_id\": \"\",\n \"external_conversation_id\": \"\",\n \"contact\": {\n \"type\": \"user\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"quick_reply_option_id\": \"\"\n}", + "raw": "{\n \"from\": \"6762f0d51bb69f9f2193bb7f\",\n \"into\": \"6762f0d51bb69f9f2193bb80\",\n \"skip_duplicate_validation\": \"\",\n \"custom_attribute_names\": []\n}", "urlencoded": [], "formdata": [] } @@ -5534,22 +5573,28 @@ "response": [] }, { - "name": "Notify Intercom of an attribute collector response in a custom channel conversation", + "name": "Search contacts", "tags": [ - "Custom Channel Events" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_channel_events/notify_attribute_collected", + "raw": "https://api.intercom.io/contacts/search", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_channel_events", - "notify_attribute_collected" + "contacts", + "search" + ], + "query": [ + { + "key": "include_merge_history", + "value": "include_merge_history", + "description": "Pass `true` to include a `merge_history` array on each contact in the response. Only returned for contacts with a `user` role." + } ], - "query": [], "variable": [] }, "auth": { @@ -5573,7 +5618,7 @@ ] }, "method": "POST", - "description": "Notifies Intercom that a user provided a response to an attribute collector in your custom channel/platform. This allows Intercom to process the attribute and trigger any relevant workflow automations.\n> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.\n", + "description": "You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want.\n\nTo search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`.\n\nThis will accept a query object in the body which will define your filters in order to search for contacts.\n\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `50` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n### Merged Contacts\n\nContacts that have been merged (via POST /contacts/merge) are excluded from search results. If a contact was recently merged into another, it will no longer appear in queries filtered by `updated_at` or any other field. Only the target contact from the merge remains searchable.\n\n### Contact Creation Delay\n\nIf a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiple's there can be:\n* There's a limit of max 2 nested filters\n* There's a limit of max 15 filters for each AND or OR group\n\n### Searching for Timestamp Fields\n\nStandard timestamp fields and Date custom attributes behave differently.\n\n**Standard timestamp fields** (`created_at`, `updated_at`, `last_seen_at` etc.) are filtered on the exact second, in UTC. `=` matches only Contacts whose value is that exact second, and `>`, `<`, `>=` and `<=` compare against the exact instant you pass - the value is not rounded or truncated. These fields report a type of `datetime` on the Data Attributes endpoint. Note that `!=` also matches Contacts with no value set for the field.\n\n**Date custom attributes** are matched by calendar day, and the day boundary is always UTC regardless of your workspace's timezone. `=` matches the whole UTC day, `>` matches from the start of the *next* UTC day, and `<` matches everything before the start of that day. The `!=`, `>=`, `<=`, `IN` and `NIN` operators are not supported on these fields and return an error.\n\n**Example.** Searching for `created_at` greater than `1577869200` (January 1st, 2020 9:00 AM UTC) returns Contacts created after that exact instant. Passing the same value for a Date custom attribute truncates it to `1577836800` (January 1st, 2020 12:00 AM UTC), so those results begin from January 2nd, 2020 12:00 AM UTC.\n\nOnly search queries behave this way. Responses always carry the full UNIX timestamp, and sorting uses the full value.\n\n### Accepted Fields\n\nMost key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foorbar\"`).\n\n| Field | Type |\n| ---------------------------------- | ------------------------------ |\n| id | String |\n| role | String
Accepts user or lead |\n| name | String |\n| avatar | String |\n| owner_id | Integer |\n| email | String |\n| email_domain | String |\n| phone | String |\n| formatted_phone | String |\n| external_id | String |\n| created_at | Datetime (Unix timestamp in seconds) |\n| signed_up_at | Datetime (Unix timestamp in seconds) |\n| updated_at | Datetime (Unix timestamp in seconds) |\n| last_seen_at | Datetime (Unix timestamp in seconds) |\n| last_contacted_at | Datetime (Unix timestamp in seconds) |\n| last_replied_at | Datetime (Unix timestamp in seconds) |\n| last_email_opened_at | Datetime (Unix timestamp in seconds) |\n| last_email_clicked_at | Datetime (Unix timestamp in seconds) |\n| language_override | String |\n| browser | String |\n| browser_language | String |\n| os | String |\n| location.country | String |\n| location.region | String |\n| location.city | String |\n| unsubscribed_from_emails | Boolean |\n| marked_email_as_spam | Boolean |\n| has_hard_bounced | Boolean |\n| ios_last_seen_at | Datetime (Unix timestamp in seconds) |\n| ios_app_version | String |\n| ios_device | String |\n| ios_app_device | String |\n| ios_os_version | String |\n| ios_app_name | String |\n| ios_sdk_version | String |\n| android_last_seen_at | Datetime (Unix timestamp in seconds) |\n| android_app_version | String |\n| android_device | String |\n| android_app_name | String |\n| andoid_sdk_version | String |\n| segment_id | String |\n| tag_id | String |\n| custom_attributes.{attribute_name} | Matches the attribute's own type
(String, Integer, Float, Boolean or Date) |\n\n### Accepted Operators\n\n{% admonition type=\"warning\" name=\"Operators not supported on Date custom attributes\" %}\n Date custom attributes do not support the `!=`, `>=`, or `<=` operators. Using them returns an error. Standard timestamp fields (`created_at`, `updated_at` etc.) do support these operators, and are filtered on the exact second.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). Which operators are valid depends on the field's type - see the \"Valid Types\" column below. Searching by `tag_id` supports only the `=` and `!=` operators.\n\n| Operator | Valid Types | Description |\n| :------- | :---------------------------------- | :----------------------------------------------------------------------|\n| = | All | Equals |\n| != | All except Date | Doesn't Equal
Also matches Contacts with no value set |\n| IN | All except Date, Datetime and tag_id | In
Shortcut for `OR` queries
Values must be in Array |\n| NIN | All except Date, Datetime and tag_id | Not In
Shortcut for `OR !` queries
Values must be in Array |\n| > | Integer
Datetime
Date | Greater than
On Date custom attributes, matches from the start of the next day |\n| < | Integer
Datetime
Date | Lower than
On Date custom attributes, matches before the start of the day |\n| >= | Integer
Datetime | Greater than or equal to
Not supported on Date custom attributes |\n| <= | Integer
Datetime | Lower than or equal to
Not supported on Date custom attributes |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", "header": [ { "key": "Intercom-Version", @@ -5590,40 +5635,29 @@ ], "body": { "mode": "raw", - "raw": "{\n \"event_id\": \"\",\n \"external_conversation_id\": \"\",\n \"contact\": {\n \"type\": \"user\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attribute\": {\n \"id\": \"\",\n \"value\": \"\"\n }\n}", + "raw": "{\n \"query\": {\n \"field\": \"created_at\",\n \"operator\": \"AND\",\n \"value\": \"73732934\"\n },\n \"pagination\": {\n \"per_page\": 2,\n \"starting_after\": \"your-cursor-from-response\"\n },\n \"sort\": {\n \"field\": \"created_at\",\n \"order\": \"descending\"\n }\n}", "urlencoded": [], "formdata": [] } }, "response": [] - } - ] - }, - { - "name": "Custom Object Instances", - "item": [ + }, { - "name": "Get Custom Object Instance by External ID", + "name": "Create contact", "tags": [ - "Custom Object Instances" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "raw": "https://api.intercom.io/contacts", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}" - ], - "query": [ - { - "key": "external_id", - "value": "external_id" - } + "contacts" ], + "query": [], "variable": [] }, "auth": { @@ -5646,46 +5680,55 @@ } ] }, - "method": "GET", - "description": "Fetch a Custom Object Instance by external_id.", + "method": "POST", + "description": "You can create a new contact (ie. user or lead).", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null - }, - "response": [] + "body": { + "mode": "raw", + "raw": "{\n \"role\": \"user\",\n \"external_id\": \"625e90fc55ab113b6d92175f\",\n \"email\": \"jdoe@example.com\",\n \"email_verified\": true,\n \"phone\": \"+353871234567\",\n \"name\": \"John Doe\",\n \"avatar\": \"https://www.example.com/avatar_image.jpg\",\n \"signed_up_at\": 1571672154,\n \"last_seen_at\": 1571672154,\n \"owner_id\": \"321\",\n \"unsubscribed_from_emails\": true,\n \"language_override\": \"en\",\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 1\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] }, { - "name": "Get Custom Object Instance by ID", + "name": "Archive contact", "tags": [ - "Custom Object Instances" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "raw": "https://api.intercom.io/contacts/{id}/archive", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}", - "{id}" + "contacts", + "{id}", + "archive" ], "query": [], "variable": [ { "key": "id", - "value": "id", + "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "The id or external_id of the custom object instance" + "description": "id" } ] }, @@ -5709,8 +5752,8 @@ } ] }, - "method": "GET", - "description": "Fetch a Custom Object Instance by id.", + "method": "POST", + "description": "You can archive a single contact.", "header": [ { "key": "Intercom-Version", @@ -5726,23 +5769,31 @@ "response": [] }, { - "name": "Create or Update a Custom Object Instance", + "name": "Unarchive contact", "tags": [ - "Custom Object Instances" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "raw": "https://api.intercom.io/contacts/{id}/unarchive", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}" + "contacts", + "{id}", + "unarchive" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } + ] }, "auth": { "type": "bearer", @@ -5765,53 +5816,47 @@ ] }, "method": "POST", - "description": "Create or update a custom object instance", + "description": "You can unarchive a single contact.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"external_id\": \"\",\n \"external_created_at\": 1571672154,\n \"external_updated_at\": 1571672154,\n \"custom_attributes\": \"\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Delete a Custom Object Instance by External ID", + "name": "Block contact", "tags": [ - "Custom Object Instances" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "raw": "https://api.intercom.io/contacts/{id}/block", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}" + "contacts", + "{id}", + "block" ], - "query": [ + "query": [], + "variable": [ { - "key": "external_id", - "value": "external_id" + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -5833,8 +5878,8 @@ } ] }, - "method": "DELETE", - "description": "Delete a single Custom Object instance by external_id.", + "method": "POST", + "description": "Block a single contact.
**Note:** conversations of the contact will also be archived during the process.
More details in [FAQ How do I block Inbox spam?](https://www.intercom.com/help/en/articles/8838656-inbox-faqs)", "header": [ { "key": "Intercom-Version", @@ -5850,31 +5895,23 @@ "response": [] }, { - "name": "Delete a Custom Object Instance by ID", + "name": "Bulk create contacts", "tags": [ - "Custom Object Instances" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "raw": "https://api.intercom.io/contacts/bulk", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}", - "{id}" + "contacts", + "bulk" ], "query": [], - "variable": [ - { - "key": "id", - "value": "id", - "disabled": false, - "description": "The Intercom defined id of the custom object instance" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -5896,54 +5933,49 @@ } ] }, - "method": "DELETE", - "description": "Delete a single Custom Object instance using the Intercom defined id.", + "method": "POST", + "description": "You can bulk create contacts by submitting an array of contact objects. This is a **strict create** and never updates an existing contact.\n\nThe endpoint creates an async job that processes the items in the background. Use the returned job ID with `GET /contacts/bulk/{id}` to check the job status.\n\nOnly the fields listed in the request schema below can be set. Any other fields in a contact object are ignored.\n\n{% admonition type=\"info\" name=\"Handling existing contacts\" %}\n If a contact already exists with the given `external_id` or `email` (including an archived contact), that item is rejected and the job's `state` ends as `completed_with_errors`. New contacts in the same request are still created. The job `state` from `GET /contacts/bulk/{id}` is the signal that one or more items were rejected.\n\n Created contacts aren't returned with IDs in the response. Look them up afterwards with [Get a contact by External ID](/docs/references/preview/rest-api/api.intercom.io/contacts/showcontactbyexternalid) or [Search contacts](/docs/references/preview/rest-api/api.intercom.io/contacts/searchcontacts).\n{% /admonition %}\n\n{% admonition type=\"info\" name=\"Limits\" %}\n - Maximum of 100 contacts per request.\n - You can append tasks to an existing job by including `job.id` in the request body.\n - Tag application is best-effort and processed asynchronously: unknown tag IDs are skipped, and per-tag results are not returned in the job status.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"contacts\": [\n {\n \"external_id\": \"abc123\",\n \"email\": \"joe@example.com\",\n \"email_verified\": true,\n \"name\": \"Joe Bloggs\",\n \"role\": \"user\",\n \"phone\": \"\",\n \"avatar\": \"https://www.example.com/avatar_image.jpg\",\n \"language_override\": \"fr\",\n \"custom_attributes\": \"\",\n \"signed_up_at\": \"\",\n \"last_seen_at\": \"\",\n \"owner_id\": \"321\",\n \"unsubscribed_from_emails\": true,\n \"companies\": [\n {\n \"company_id\": \"6\",\n \"name\": \"Blue Sun\"\n }\n ],\n \"tags\": {\n \"add\": [\n {\n \"id\": \"123\"\n }\n ]\n }\n }\n ],\n \"job\": {\n \"id\": \"job_v2_1\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - } - ] - }, - { - "name": "Data Attributes", - "item": [ + }, { - "name": "List all data attributes", + "name": "Bulk delete contacts", "tags": [ - "Data Attributes" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/data_attributes", + "raw": "https://api.intercom.io/contacts/bulk/delete", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "data_attributes" - ], - "query": [ - { - "key": "model", - "value": "company", - "description": "Specify the data attribute model to return." - }, - { - "key": "include_archived", - "value": "include_archived", - "description": "Include archived attributes in the list. By default we return only non archived data attributes." - } + "contacts", + "bulk", + "delete" ], + "query": [], "variable": [] }, "auth": { @@ -5966,39 +5998,58 @@ } ] }, - "method": "GET", - "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "method": "POST", + "description": "You can delete contacts in bulk by submitting an array of contact `id`s.\n\nThe endpoint creates an async job that processes the deletes in the background. Use the returned job ID with `GET /contacts/bulk/{id}` to check the job status.\n\n{% admonition type=\"warning\" name=\"Permanent deletion\" %}\n A contact that doesn't exist, or can't be deleted, fails that item and the job's `state` ends as `completed_with_errors` (visible via `GET /contacts/bulk/{id}`) without failing the rest of the batch.\n{% /admonition %}\n\n{% admonition type=\"info\" name=\"Limits\" %}\n - Maximum of 100 contacts per request.\n - You can append tasks to an existing job by including `job.id` in the request body.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"contacts\": [\n {\n \"id\": \"abc123\"\n }\n ],\n \"job\": {\n \"id\": \"job_v2_1\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Create a data attribute", + "name": "Replace granted companies for a contact (Preview)", "tags": [ - "Data Attributes" + "Contacts", + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/data_attributes", + "raw": "https://api.intercom.io/contacts/{contact_id}/granted_companies", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "data_attributes" + "contacts", + "{contact_id}", + "granted_companies" ], "query": [], - "variable": [] + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } + ] }, "auth": { "type": "bearer", @@ -6020,8 +6071,8 @@ } ] }, - "method": "POST", - "description": "You can create a data attributes for a `contact` or a `company`.", + "method": "PUT", + "description": "Replace the full set of companies a contact has been granted access to.\n\nThis is a replacement, not an append. The `company_ids` you send become the contact's entire granted set — any company id you leave out is dropped. To add a company, send the existing ids plus the new one; to remove one, send the existing ids minus that one; to drop every grant, send an empty array.\n\nIdentify companies by the `company_id` you set on them, the same values [`GET /contacts/{contact_id}/granted_companies`](/docs/references/preview/rest-api/api.intercom.io/contacts/listgrantedcompaniesforacontact) returns. Duplicates in the request are collapsed. A contact can be granted at most 100 companies.\n\nThe response echoes the stored set, so a `200` is confirmation of exactly what the contact can now read.\n\n{% admonition type=\"info\" name=\"Requires granted companies to be enabled\" %}\n This endpoint returns `404` with the code `granted_companies_not_enabled` unless granted companies are enabled for the workspace. Contact Intercom Support to enable it.\n{% /admonition %}\n\nRequires the `write_users_companies` OAuth scope. Set `Intercom-Version: Preview`.\n", "header": [ { "key": "Intercom-Version", @@ -6038,7 +6089,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"data_type\": \"\",\n \"options\": [\n {\n \"value\": \"1-10\"\n },\n {\n \"value\": \"11-50\"\n }\n ]\n}", + "raw": "{\n \"company_ids\": [\n \"acme-corp\",\n \"1234\"\n ]\n}", "urlencoded": [], "formdata": [] } @@ -6046,28 +6097,35 @@ "response": [] }, { - "name": "Update a data attribute", + "name": "Update a contact", "tags": [ - "Data Attributes" + "Contacts", + "Custom Object Instances" ], "request": { "url": { - "raw": "https://api.intercom.io/data_attributes/{id}", + "raw": "https://api.intercom.io/contacts/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "data_attributes", + "contacts", "{id}" ], - "query": [], + "query": [ + { + "key": "include_merge_history", + "value": "include_merge_history", + "description": "Pass `true` to include the contact's merge history in the response. Only returned for contacts with a `user` role." + } + ], "variable": [ { "key": "id", - "value": "1", + "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "The data attribute id" + "description": "id" } ] }, @@ -6092,7 +6150,7 @@ ] }, "method": "PUT", - "description": "\nYou can update a data attribute.\n\n> 🚧 Updating the data type is not possible\n>\n> It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.\n", + "description": "You can update an existing contact (ie. user or lead).\n\n{% admonition type=\"info\" %}\n This endpoint handles both **contact updates** and **custom object associations**.\n\n See _`update a contact with an association to a custom object instance`_ in the request/response examples to see the custom object association format.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", @@ -6109,43 +6167,31 @@ ], "body": { "mode": "raw", - "raw": "{\n \"options\": [\n {\n \"value\": \"1-10\"\n },\n {\n \"value\": \"11-50\"\n }\n ]\n}", + "raw": "{\n \"role\": \"\",\n \"external_id\": \"\",\n \"email\": \"jdoe@example.com\",\n \"email_verified\": true,\n \"phone\": \"+353871234567\",\n \"name\": \"John Doe\",\n \"avatar\": \"https://www.example.com/avatar_image.jpg\",\n \"signed_up_at\": 1571672154,\n \"last_seen_at\": 1571672154,\n \"owner_id\": \"321\",\n \"unsubscribed_from_emails\": true,\n \"language_override\": \"en\",\n \"custom_attributes\": \"\"\n}", "urlencoded": [], "formdata": [] } }, "response": [] - } - ] - }, - { - "name": "Data Connectors", - "item": [ + }, { - "name": "Update a data connector", + "name": "Bulk update contacts", "tags": [ - "Data Connectors" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/data_connectors/{id}", + "raw": "https://api.intercom.io/contacts/bulk", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "data_connectors", - "{id}" + "contacts", + "bulk" ], "query": [], - "variable": [ - { - "key": "id", - "value": "12345", - "disabled": false, - "description": "The unique identifier of the data connector." - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -6167,8 +6213,8 @@ } ] }, - "method": "PATCH", - "description": "Update an existing data connector. Only provided fields are changed. Set `state` to `live` or `draft` to change the connector's state.\n", + "method": "PUT", + "description": "You can bulk update contacts by submitting an array of contact objects with the fields to update. Each contact must include an `id` field identifying the contact to update. You can also add or remove tags on each contact by including a `tags` object.\n\nOnly the fields listed in the request schema below can be set. Any other fields in a contact object are ignored.\n\nThe endpoint creates an async job that processes the updates in the background. Use the returned job ID with `GET /contacts/bulk/{id}` to check the job status.\n\n{% admonition type=\"info\" name=\"Limits\" %}\n - Maximum of 100 contacts per request.\n - You can append tasks to an existing job by including `job.id` in the request body.\n - Tag application is best-effort and processed asynchronously: unknown tag IDs are skipped, and per-tag results are not returned in the job status.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", @@ -6185,7 +6231,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"name\": \"Updated Connector Name\",\n \"description\": \"Updated description\",\n \"state\": \"draft\",\n \"http_method\": \"post\",\n \"url\": \"https://api.example.com/orders/{{order_id}}/status\",\n \"body\": \"\",\n \"direct_fin_usage\": false,\n \"audiences\": [\n \"leads\",\n \"users\"\n ],\n \"headers\": [\n {\n \"name\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"data_inputs\": [\n {\n \"name\": \"order_id\",\n \"type\": \"string\",\n \"description\": \"The order ID to look up\",\n \"required\": true,\n \"default_value\": \"\"\n }\n ],\n \"customer_authentication\": false,\n \"bypass_authentication\": false,\n \"validate_missing_attributes\": true,\n \"mock_response\": {\n \"order\": {\n \"id\": 12345,\n \"status\": \"shipped\"\n }\n },\n \"token_ids\": [\n \"1234\",\n \"5678\"\n ]\n}", + "raw": "{\n \"contacts\": [\n {\n \"id\": \"abc123\",\n \"external_id\": \"abc123\",\n \"email\": \"joe@example.com\",\n \"email_verified\": true,\n \"name\": \"Joe Bloggs\",\n \"phone\": \"\",\n \"avatar\": \"https://www.example.com/avatar_image.jpg\",\n \"owner_id\": \"321\",\n \"unsubscribed_from_emails\": true,\n \"language_override\": \"fr\",\n \"custom_attributes\": \"\",\n \"companies\": [\n {\n \"company_id\": \"6\",\n \"name\": \"Blue Sun\",\n \"remove\": true\n }\n ],\n \"tags\": {\n \"add\": [\n {\n \"id\": \"123\"\n }\n ],\n \"remove\": [\n {\n \"id\": \"789\"\n }\n ]\n }\n }\n ],\n \"job\": {\n \"id\": \"job_v2_1\"\n }\n}", "urlencoded": [], "formdata": [] } @@ -6193,33 +6239,39 @@ "response": [] }, { - "name": "List all data connectors", + "name": "Remove a granted company from a contact (Preview)", "tags": [ - "Data Connectors" + "Contacts", + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/data_connectors", + "raw": "https://api.intercom.io/contacts/{contact_id}/granted_companies/{company_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "data_connectors" + "contacts", + "{contact_id}", + "granted_companies", + "{company_id}" ], - "query": [ + "query": [], + "variable": [ { - "key": "per_page", - "value": "per_page", - "description": "The number of results to return per page. Defaults to 20, minimum 1, maximum 50." + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" }, { - "key": "starting_after", - "value": "starting_after", - "description": "The cursor value from `pages.next.starting_after` in a previous response. Used to paginate through results." + "key": "company_id", + "value": "acme-corp", + "disabled": false, + "description": "The `company_id` you set on the company, as returned in `company_ids`." } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -6241,8 +6293,8 @@ } ] }, - "method": "GET", - "description": "Returns a paginated list of all data connectors for the workspace, ordered by most recently updated first. Data connectors allow workflows and AI agents to make HTTP requests to external APIs.\n", + "method": "DELETE", + "description": "Remove a single company from a contact's granted set, leaving the contact's other grants in place.\n\nIdentify the company by the `company_id` you set on it, the same value [`GET /contacts/{contact_id}/granted_companies`](/docs/references/preview/rest-api/api.intercom.io/contacts/listgrantedcompaniesforacontact) returns. A `company_id` containing a dot or a slash is supported — URL-encode a slash as `%2F`.\n\nThis endpoint is not idempotent. Removing a company the contact is not currently granted returns `404` with the code `company_not_found`, so repeating a successful call returns `404` rather than `204`. Treat the first `204` as the confirmation.\n\n{% admonition type=\"info\" name=\"Requires granted companies to be enabled\" %}\n This endpoint returns `404` with the code `granted_companies_not_enabled` unless granted companies are enabled for the workspace. Contact Intercom Support to enable it.\n{% /admonition %}\n\nRequires the `write_users_companies` OAuth scope. Set `Intercom-Version: Preview`.\n", "header": [ { "key": "Intercom-Version", @@ -6258,9 +6310,3689 @@ "response": [] }, { - "name": "Retrieve a data connector", + "name": "Delete a contact", "tags": [ - "Data Connectors" + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "You can delete a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Content", + "item": [ + { + "name": "Search knowledge base contents", + "tags": [ + "Content" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/content/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "content", + "search" + ], + "query": [ + { + "key": "query", + "value": "billing", + "description": "A free-text search term matched against the title and body of each content item. When omitted, returns the most recent content items." + }, + { + "key": "page", + "value": "1", + "description": "The page number to fetch. Defaults to 1. Values below 1 are clamped to 1." + }, + { + "key": "per_page", + "value": "10", + "description": "Number of results per page. Defaults to 10. Maximum 50." + }, + { + "key": "states", + "value": "published,draft", + "description": "Filter by publication state. Accepts a comma-separated list or repeated params." + }, + { + "key": "locales", + "value": "en,fr", + "description": "Filter by locale codes (e.g. `en`, `fr`, `de`). Accepts a comma-separated list or repeated params." + }, + { + "key": "tag_ids", + "value": "1,2,3", + "description": "Filter by tag IDs. Pairs with `tag_operator` to control match semantics. Accepts a comma-separated list or repeated params." + }, + { + "key": "tag_operator", + "value": "IN", + "description": "Match operator paired with `tag_ids`. `IN` returns content matching any of the given tags; `NIN` excludes content matching any of them." + }, + { + "key": "any_tag_ids", + "value": "1,2,3", + "description": "Filter by tag IDs using OR semantics — returns content matching any of the given tags. Alternative to `tag_ids` + `tag_operator`. Accepts a comma-separated list or repeated params." + }, + { + "key": "folder_ids", + "value": "10,20", + "description": "Filter by folder IDs. Must be sent together with `folder_entity_type`. Accepts a comma-separated list or repeated params." + }, + { + "key": "folder_entity_type", + "value": "folder", + "description": "Required when `folder_ids` is provided. Identifies the entity type the folder IDs refer to." + }, + { + "key": "content_types", + "value": "article,snippet", + "description": "Restrict the search to specific content types. When provided, this REPLACES the default content type set rather than filtering on top of it. Accepts a comma-separated list or repeated params." + }, + { + "key": "copilot_state", + "value": "on", + "description": "Filter by whether the content is enabled for Copilot." + }, + { + "key": "fin_service_state", + "value": "on", + "description": "Filter by whether the content is enabled for Fin AI Agent (customer-facing service)." + }, + { + "key": "fin_sales_state", + "value": "on", + "description": "Filter by whether the content is enabled for Fin Sales Agent." + }, + { + "key": "created_by_ids", + "value": "991267464,991267465", + "description": "Filter by the admin IDs that created the content. Accepts a comma-separated list or repeated params." + }, + { + "key": "last_updated_by_ids", + "value": "991267464,991267465", + "description": "Filter by the admin IDs that last updated the content. Accepts a comma-separated list or repeated params." + }, + { + "key": "created_at_after", + "value": "1677253093", + "description": "Return content created at or after this time. Unix epoch seconds." + }, + { + "key": "created_at_before", + "value": "1677861493", + "description": "Return content created at or before this time. Unix epoch seconds." + }, + { + "key": "updated_at_after", + "value": "1677253093", + "description": "Return content last updated at or after this time. Unix epoch seconds." + }, + { + "key": "updated_at_before", + "value": "1677861493", + "description": "Return content last updated at or before this time. Unix epoch seconds." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Search the knowledge base contents — articles, snippets, external pages, uploaded files, and internal articles — using a keyword query.\n\nEach result row has a `type` discriminator. Most types (`content_snippet`, `external_content`, `file_source_content`, `internal_article`) return a flat `{ type, id, title }` shape. Help center articles return a nested shape with a `contents[]` array, one entry per locale.\n\nRequires the `read_content` OAuth scope.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Run a bulk action on Knowledge Hub content (Preview)", + "tags": [ + "Content" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/content/bulk_actions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "content", + "bulk_actions" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Asynchronously run a bulk action over up to 1,000 Knowledge Hub content items.\n\nSix actions are supported:\n * `publish` and `unpublish` — apply to `article_content` only.\n * `delete` — permanently delete content (excludes synced sources and `external_content`).\n * `set_availability` — toggle Fin AI Agent, Copilot, and Sales Agent availability flags.\n * `set_audience` — manage segment membership on content.\n * `update_tags` — apply and/or remove existing tags on content. Unlike the other\n actions, `update_tags` addresses articles by the parent `article` id, not\n `article_content`. Tags must already exist and not be archived; supply at least one of\n `add_tag_ids` / `remove_tag_ids`.\n\nThe endpoint validates the request, enqueues background work, and returns 202 with a\nplaceholder envelope. Items whose `type` is not in the action's allowlist are silently\ndropped before processing. Articles imported from synced sources (Confluence, Notion,\nZendesk, Salesforce Knowledge, etc.) are silently skipped on `delete` — they can only be\nremoved by disconnecting the underlying import source.\n\nRequires the `write_content` OAuth scope. Set `Intercom-Version: Preview`.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"action\": \"publish\",\n \"content_ids\": [\n {\n \"type\": \"article_content\",\n \"id\": \"12345678\"\n }\n ],\n \"availability\": {\n \"ai_agent\": \"\",\n \"copilot\": \"\",\n \"sales_agent\": \"\"\n },\n \"audience\": {\n \"add_segment_ids\": [\n 100\n ],\n \"remove_segment_ids\": [\n 200\n ],\n \"remove_all\": false\n },\n \"tags\": {\n \"add_tag_ids\": [\n 100\n ],\n \"remove_tag_ids\": [\n 200\n ]\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Content Snippets", + "item": [ + { + "name": "List all content snippets", + "tags": [ + "Content Snippets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/content_snippets", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "content_snippets" + ], + "query": [ + { + "key": "page", + "value": "page", + "description": "The page of results to fetch." + }, + { + "key": "per_page", + "value": "per_page", + "description": "The number of results to return per page. Max value of 50." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all content snippets for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a content snippet", + "tags": [ + "Content Snippets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/content_snippets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "content_snippets", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the content snippet." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a single content snippet by its id.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create a content snippet", + "tags": [ + "Content Snippets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/content_snippets", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "content_snippets" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can create a new content snippet.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"title\": \"How to reset your password\",\n \"json_blocks\": [\n {\n \"type\": \"paragraph\",\n \"text\": \"Navigate to Settings > Security > Reset password.\"\n }\n ],\n \"body_markdown\": \"# Hello\\n\\nSome content.\\n\",\n \"locale\": \"en\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Add a tag to a content snippet", + "tags": [ + "Content Snippets", + "Tags" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/content_snippets/{content_snippet_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "content_snippets", + "{content_snippet_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "content_snippet_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the content snippet." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Apply an existing tag to a content snippet. Returns the tag that was applied.\n\nThe tag must already exist in the workspace (create tags with the Tags API),\nand the authenticating teammate must have the `manage_knowledge_base_content`\npermission.\n\nRequires the `read_write_content_snippets` OAuth scope. Set `Intercom-Version: Preview`.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"1234\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Update a content snippet", + "tags": [ + "Content Snippets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/content_snippets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "content_snippets", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the content snippet." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "You can update an existing content snippet.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"title\": \"How to reset your password\",\n \"json_blocks\": [\n {\n \"type\": \"paragraph\",\n \"text\": \"Navigate to Settings > Security > Reset password.\"\n }\n ],\n \"body_markdown\": \"## Updated heading\\n\\nNew content.\\n\",\n \"locale\": \"en\",\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete a content snippet", + "tags": [ + "Content Snippets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/content_snippets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "content_snippets", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the content snippet." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "You can delete a single content snippet by its id.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Remove a tag from a content snippet", + "tags": [ + "Content Snippets", + "Tags" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/content_snippets/{content_snippet_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "content_snippets", + "{content_snippet_id}", + "tags", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "content_snippet_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the content snippet." + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier of the tag to remove, as given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "Remove a tag from a content snippet. Returns the tag that was removed, with\nnull `applied_at` and `applied_by`.\n\nThe authenticating teammate must have the `manage_knowledge_base_content`\npermission.\n\nRequires the `read_write_content_snippets` OAuth scope. Set `Intercom-Version: Preview`.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Conversation Participants", + "item": [ + { + "name": "Attach a contact to a conversation", + "tags": [ + "Conversation Participants" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/customers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "customers" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.\n\n{% admonition type=\"warning\" name=\"Contacts without an email\" %}\nIf 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`.\n{% /admonition %}\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"12345\",\n \"customer\": {\n \"intercom_user_id\": \"6329bd9ffe4e2e91dac76188\",\n \"customer\": {\n \"intercom_user_id\": \"6329bd9ffe4e2e91dac76188\",\n \"user_id\": \"2e91dac761886329bd9ffe4e\",\n \"email\": \"sam.sung@example.com\"\n },\n \"user_id\": \"6329bd9ffe4e2e91dac76188\",\n \"email\": \"winstonsmith@truth.org\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Detach a contact from a group conversation", + "tags": [ + "Conversation Participants" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{conversation_id}/customers/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{conversation_id}", + "customers", + "{contact_id}" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + }, + { + "key": "contact_id", + "value": "123", + "disabled": false, + "description": "The identifier for the contact as given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "You can remove participants who are contacts from a group conversation, on behalf of an admin.\n\n{% admonition type=\"warning\" name=\"Removing the last participant\" %}\nYou cannot remove the last remaining contact from a conversation.\n{% /admonition %}\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"5017690\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Conversation Parts", + "item": [ + { + "name": "Redact a conversation part", + "tags": [ + "Conversation Parts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/redact", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "redact" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can redact a conversation part or the source message of a conversation (as seen in the source object).\n\n{% admonition type=\"info\" name=\"Redacting parts and messages\" %}\nIf you are redacting a conversation part, it must have a `body`. If you are redacting a source message, it must have been created by a contact. We will return a `conversation_part_not_redactable` error if these criteria are not met.\n{% /admonition %}\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"source\",\n \"conversation_id\": \"19894788788\",\n \"conversation_part_id\": \"19381789428\",\n \"source_id\": \"19894781231\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Update a conversation part", + "tags": [ + "Conversation Parts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{conversation_id}/conversation_parts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{conversation_id}", + "conversation_parts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + }, + { + "key": "id", + "value": "456", + "disabled": false, + "description": "The identifier for the conversation part." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "You can update properties of a conversation part. Currently supports updating the send state of an external reply or marking a part as seen by an admin.\n\n{% admonition type=\"warning\" name=\"Experimental\" %}\n This is an experimental endpoint. It requires a valid HMAC secret for authentication in addition to the standard bearer token.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"send_state\": \"sent\",\n \"info_message\": \"Message delivered successfully\",\n \"seen\": true,\n \"admin_id\": \"991267694\",\n \"experimental\": true,\n \"secret\": \"hmac_secret_value\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Conversations", + "item": [ + { + "name": "List all conversations", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations" + ], + "query": [ + { + "key": "per_page", + "value": "per_page", + "description": "How many results per page" + }, + { + "key": "starting_after", + "value": "starting_after", + "description": "String used to get the next page of conversations." + }, + { + "key": "include_monitors", + "value": "true", + "description": "If set to true, the response will include a `monitor_evaluations` array on each conversation with any QA monitor results that flagged it." + }, + { + "key": "include_scorecards", + "value": "true", + "description": "If set to true, the response will include a `scorecards` array on each conversation with any QA scorecard results." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all conversations.\n\nYou can optionally request the result page size and the cursor to start after to fetch the result.\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text. This affects both the body and subject fields. Inline links are rendered as `label (url)`, preserving the link URL alongside the visible text." + }, + { + "key": "include_translations", + "value": "true", + "description": "If set to true, conversation parts will be translated to the detected language of the conversation." + }, + { + "key": "include_email_history", + "value": "true", + "description": "If set to true, the source of the conversation will include the email history." + }, + { + "key": "include_monitors", + "value": "true", + "description": "If set to true, the response will include a `monitor_evaluations` array with any QA monitor results that flagged this conversation." + }, + { + "key": "include_scorecards", + "value": "true", + "description": "If set to true, the response will include a `scorecards` array with any QA scorecard results for this conversation." + }, + { + "key": "include_part_types", + "value": "comment,note", + "description": "A comma-separated list of conversation part types to return, such as `assignment`, `note` or `snoozed`. Cannot be combined with `exclude_part_types`." + }, + { + "key": "exclude_part_types", + "value": "assignment", + "description": "A comma-separated list of conversation part types to leave out, such as `assignment`, `note` or `snoozed`. Cannot be combined with `include_part_types`." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "\nYou can fetch the details of a single conversation.\n\nThis will return a single Conversation model with all its conversation parts.\n\n{% admonition type=\"warning\" name=\"Hard limit of 500 parts\" %}\nThe maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. `include_part_types` and `exclude_part_types` are applied before this limit, so filtering returns the 500 most recent matching parts. `conversation_parts.total_count` counts the parts in this response, after filtering — it is not the conversation's total part count.\n{% /admonition %}\n\nFor AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671).\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List handling events", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/handling_events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "handling_events" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "List all pause/resume events for a conversation. These events track when teammates paused or resumed handling a conversation.\n\nRequires the `read_conversations` OAuth scope.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List team handling segments", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/team_handling_segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "team_handling_segments" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "List the periods teammates actively handled a conversation, attributed to the team assigned to the conversation at the time. A period is split where the team changes. Teammate identity is not included; join with List handling events by time to recover it.\n\nPeriods with no team assigned are returned with `team` set to `null`. `ended_at` is `null` while a period is still open.\n\nRequires the `read_conversations` OAuth scope, and the caller must be able to access the conversation.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List HITL events", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/hitl_events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "hitl_events" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "List the human-in-the-loop (HITL) events for a conversation. When Fin is unsure of an answer it can consult a teammate before replying, proposing a draft that the teammate approves, steers with free-text feedback, or takes over. Each consultation is returned as a series of events, oldest first, across every consultation on the conversation.\n\nRequires the `read_conversations` OAuth scope, and the caller must be able to access the conversation.\n\nEvents are only recorded once a consultation has ended, so a consultation still awaiting a teammate does not appear.\n\nWhich fields appear in `data` depends on `event_type`:\n\n| `event_type` | `data` fields |\n|---|---|\n| `fin_consultation_started` | `channel`, `rule_threshold_percent`, `confidence_percent`, `sharp_ask`, `ask_rationale`, `issue_summary`, `customer_question` |\n| `fin_draft_proposed` | `draft` |\n| `fin_teammate_input_received` | `round_index`, `teammate_input`, `reviewer_admin_id`, `regeneration_outcome` |\n| `fin_draft_revised` | `round_index`, `revised_draft`, `regeneration_outcome` |\n| `fin_consultation_finished` | `outcome`, `approved_draft_type`, `final_draft`, `sent_text`, `reviewer_admin_id`, `duration_seconds`, `rounds_count`, `payload_truncated` |\n\nA consultation always produces a `fin_consultation_started` and a `fin_consultation_finished` event. `fin_draft_proposed` appears when Fin proposed a draft. `fin_teammate_input_received` appears once per round of teammate feedback, and `fin_draft_revised` once per round where Fin produced a revised draft in response.\n\nNotes on interpreting the response:\n\n- `hitl_cycle_id` identifies the consultation, so it is the same on every event of one consultation. It is not unique per event. A conversation can hold several consultations — a consultation that replaces an outstanding one finishes with an `outcome` of `superseded`.\n- `conversation_part_id` links an event to a conversation part where one exists. It is `null` in ordinary cases: teammate feedback given through the inbox creates no conversation part, a revised draft has no part of its own, and a consultation that escalated or was superseded sent no reply.\n- `created_at` on `fin_draft_proposed` is approximate. It reports when the consultation started, which is when the draft was proposed.\n- `rule_id`, `rule_name` and `rule_threshold_percent` are recorded when the consultation begins and are not updated afterwards, so a rule that has since been renamed or retuned will not match its current settings. They are `null` for consultations not triggered by a rule.\n- `reviewer_admin_id` identifies the teammate involved in that event: on `fin_teammate_input_received` the teammate who gave the feedback, and on `fin_consultation_finished` the teammate who approved the draft or took over. On a consultation with several rounds these can be different teammates.\n- `rounds_count` counts every round of teammate feedback the consultation had. Only the ten most recent rounds are retained, so a heavily steered consultation returns fewer `fin_teammate_input_received` events than `rounds_count`.\n- Redacting a conversation removes this data. Depending on how it was redacted, the conversation either returns no events or returns events whose text fields are all `null`.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List side conversations", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/side_conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "side_conversations" + ], + "query": [ + { + "key": "page", + "value": "page", + "description": "The page number of results to return (starting from 1)." + }, + { + "key": "per_page", + "value": "per_page", + "description": "The number of side conversations to return per page (max 50)." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "List side conversations for a given conversation. Side conversations are internal threads created by teammates from within a conversation.\n\nEach side conversation includes its conversation parts (messages). Results are paginated.\n\nRequires the `read_conversations` OAuth scope.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List all deleted conversation IDs", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/deleted", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "deleted" + ], + "query": [ + { + "key": "page", + "value": "1", + "description": "The page of results to fetch. Defaults to first page" + }, + { + "key": "per_page", + "value": "per_page", + "description": "How many results per page" + }, + { + "key": "order", + "value": "desc", + "description": "`asc` or `desc`. Returns the conversation IDs in ascending or descending order. Defaults to desc" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "List all deleted conversation IDs.\n\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `20` results per page. You can navigate to next pages using the `page` param.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Creates a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can create a conversation that has been initiated by a contact (ie. user or lead).\nThe conversation can be an in-app message only.\n\n{% admonition type=\"info\" name=\"Sending for visitors\" %}\nYou can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`.\nThis visitor will be automatically converted to a contact with a lead role once the conversation is created.\n{% /admonition %}\n\nThis will return the Message model that has been created.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"from\": {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n \"body\": \"Hello\",\n \"subject\": \"Thanks for everything\",\n \"attachment_urls\": [],\n \"created_at\": 1671028894,\n \"brand_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Search conversations", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "search" + ], + "query": [ + { + "key": "include_monitors", + "value": "true", + "description": "If set to true, the response will include a `monitor_evaluations` array on each conversation with any QA monitor results that flagged it." + }, + { + "key": "include_scorecards", + "value": "true", + "description": "If set to true, the response will include a `scorecards` array on each conversation with any QA scorecard results." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`.\n\nThis will accept a query object in the body which will define your filters in order to search for conversations.\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiple's there can be:\n- There's a limit of max 2 nested filters\n- There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed in the conversation model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foorbar\"`).\nThe `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `\"I need support\"` body - the query should contain a `=` operator with the value `\"support\"` for such conversation to be returned. A query with a `=` operator and a `\"need support\"` value will not yield a result.\n\n| Field | Type |\n| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| source.type | String
Accepted fields are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. |\n| source.id | String |\n| source.delivered_as | String |\n| source.subject | String |\n| source.body | String |\n| source.author.id | String |\n| source.author.type | String |\n| source.author.name | String |\n| source.author.email | String |\n| source.url | String |\n| contact_ids | String |\n| teammate_ids | String |\n| admin_assignee_id | Integer |\n| team_assignee_id | Integer |\n| channel_initiated | String |\n| open | Boolean |\n| read | Boolean |\n| state | String |\n| waiting_since | Date (UNIX timestamp) |\n| snoozed_until | Date (UNIX timestamp) |\n| tag_ids | String |\n| priority | String |\n| statistics.time_to_assignment | Integer |\n| statistics.time_to_admin_reply | Integer |\n| statistics.time_to_first_close | Integer |\n| statistics.time_to_last_close | Integer |\n| statistics.median_time_to_reply | Integer |\n| statistics.first_contact_reply_at | Date (UNIX timestamp) |\n| statistics.first_assignment_at | Date (UNIX timestamp) |\n| statistics.first_admin_reply_at | Date (UNIX timestamp) |\n| statistics.first_close_at | Date (UNIX timestamp) |\n| statistics.last_assignment_at | Date (UNIX timestamp) |\n| statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) |\n| statistics.last_contact_reply_at | Date (UNIX timestamp) |\n| statistics.last_admin_reply_at | Date (UNIX timestamp) |\n| statistics.last_close_at | Date (UNIX timestamp) |\n| statistics.last_closed_by_id | String |\n| statistics.count_reopens | Integer |\n| statistics.count_assignments | Integer |\n| statistics.count_conversation_parts | Integer |\n| conversation_rating.requested_at | Date (UNIX timestamp) |\n| conversation_rating.replied_at | Date (UNIX timestamp) |\n| conversation_rating.score | Integer |\n| conversation_rating.remark | String |\n| conversation_rating.contact_id | String |\n| conversation_rating.admin_d | String |\n| ai_agent_participated | Boolean |\n| ai_agent.resolution_state | String |\n| ai_agent.last_answer_type | String |\n| ai_agent.rating | Integer |\n| ai_agent.rating_remark | String |\n| ai_agent.source_type | String |\n| ai_agent.source_title | String |\n\n### Accepted Operators\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": {\n \"field\": \"created_at\",\n \"operator\": \"AND\",\n \"value\": \"73732934\"\n },\n \"pagination\": {\n \"per_page\": 2,\n \"starting_after\": \"your-cursor-from-response\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Reply to a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "reply" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123 or \"last\"", + "disabled": false, + "description": "The Intercom provisioned identifier for the conversation or the string \"last\" to reply to the last part of the conversation" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins.\n\n{% admonition type=\"warning\" name=\"Bot replies to inbound email\" %}\nBy default, bot or Operator replies to an inbound email conversation aren't sent to your customer. The reply is stored as an unnotifiable bot comment, and no `seen` receipt is generated until an email is actually delivered.\n\nTo send these replies as outbound emails, reach out to your accounts team to enable the email-reply feature flag for your workspace.\n{% /admonition %}\n\n{% admonition type=\"info\" name=\"Managing a conversation\" %}\nTo close, open, snooze or assign a conversation, use [Manage a conversation](/docs/references/preview/rest-api/api.intercom.io/conversations/manageconversation).\n{% /admonition %}", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"message_type\": \"comment\",\n \"type\": \"admin\",\n \"body\": \"Hello there!\",\n \"created_at\": 1590000000,\n \"attachment_urls\": [],\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"admin_id\": \"3156780\",\n \"attachment_files\": [\n {\n \"content_type\": \"application/json\",\n \"data\": \"ewogICJ0ZXN0IjogMQp9\",\n \"name\": \"test.json\"\n }\n ],\n \"skip_notifications\": true,\n \"skip_unsnooze\": true\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Manage a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/parts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "parts" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "For managing conversations you can:\n- Close a conversation\n- Snooze a conversation to reopen on a future date\n- Open a conversation which is `snoozed` or `closed`\n- Assign a conversation to an admin and/or team.\n\n{% admonition type=\"info\" name=\"Sending messages\" %}\nTo send a comment, note or quick reply, use [Reply to a conversation](/docs/references/preview/rest-api/api.intercom.io/conversations/replyconversation).\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"message_type\": \"assignment\",\n \"type\": \"admin\",\n \"admin_id\": \"12345\",\n \"body\": \"Let me pass you over to one of my colleagues.\",\n \"snoozed_until\": 1673609604,\n \"assignee_id\": \"4324241\",\n \"skip_reopen\": true\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Merge a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/merge", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "merge" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the secondary (source) conversation to merge away." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Merge a secondary (source) conversation into a primary (target) conversation.\nThe secondary conversation is closed and linked to the primary, which\nbecomes the surviving thread. Returns the primary conversation on success.\n\nRequires `write_conversations` OAuth scope. When the secondary is a ticket,\n`write_tickets` scope is also required.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merge_into_conversation_id\": 456\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Convert a conversation to a ticket", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "convert" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can convert a conversation to a ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ticket_type_id\": \"1234\",\n \"ticket_state_id\": \"123\",\n \"attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Update a conversation", + "tags": [ + "Conversations", + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text. This affects both the body and subject fields. Inline links are rendered as `label (url)`, preserving the link URL alongside the visible text." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "\nYou can update an existing conversation.\n\n{% admonition type=\"info\" name=\"Replying and other actions\" %}\nIf you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints.\n{% /admonition %}\n\n{% admonition type=\"info\" %}\n This endpoint handles both **conversation updates** and **custom object associations**.\n\n See _`update a conversation with an association to a custom object instance`_ in the request/response examples to see the custom object association format.\n{% /admonition %}\n\n{% admonition type=\"danger\" name=\"Breaking change: duplicate custom attribute names\" %}\nThe `PUT /conversations/{id}` endpoint now returns a `400 INVALID_PARAMETER` error when the request includes `custom_attributes` and your workspace contains multiple non-archived conversation custom attributes with the same name. Previously, the update would silently apply to a non-deterministic attribute.\n\nTo resolve, rename or archive the duplicate attribute so each name is unique, then retry the request. You can do this through:\n\n- The Conversation Attributes API — list with `GET /conversations/attributes`, then rename with `PUT /conversations/attributes/{id}` or archive with `DELETE /conversations/attributes/{id}`\n- Your workspace settings (Settings → Data → Conversations)\n{% /admonition %}\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"read\": true,\n \"title\": \"Conversation Title\",\n \"priority\": \"high\",\n \"admin_id\": \"394051\",\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 9,\n \"start_date_iso8601\": \"2023-03-04T09:46:14Z\",\n \"end_date_timestamp\": 1677923174,\n \"CX Score rating\": 4,\n \"CX Score explanation\": \"The conversation was resolved quickly and the customer expressed satisfaction with the outcome.\"\n },\n \"company_id\": \"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}" + ], + "query": [ + { + "key": "retain_metrics", + "value": "true", + "description": "If true (default), deletes the conversation while retaining reporting data. If false, deletes the conversation and all associated reporting data. Setting to false requires the `delete_conversations_and_metrics` OAuth scope." + } + ], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "{% admonition type=\"warning\" name=\"Irreversible operation\" %}\nDeleting a conversation is permanent and cannot be reversed.\n{% /admonition %}\n\nYou can delete a single conversation. The behavior depends on the `retain_metrics` parameter:\n\n- **With `retain_metrics=true` (default)**: Deletes the conversation while retaining reporting data. The conversation will still appear in reporting, though some data may be incomplete due to the deletion.\n\n- **With `retain_metrics=false`**: Deletes the conversation and all associated reporting data. The conversation will be completely removed from both the inbox and all reporting.\n\n{% admonition type=\"info\" name=\"Required scope for retain_metrics=false\" %}\nUsing `retain_metrics=false` requires the `delete_conversations_and_metrics` OAuth scope.\n{% /admonition %}\n\nFor more info, see [this help center article](https://www.intercom.com/help/en/articles/13885146-deleting-a-conversation).\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Conversations Attributes", + "item": [ + { + "name": "List all conversation attributes", + "tags": [ + "Conversations Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "attributes" + ], + "query": [ + { + "key": "include_archived", + "value": "include_archived", + "description": "Include archived attributes in the list. Default `false`." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all conversation attributes for your workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Get a conversation attribute", + "tags": [ + "Conversations Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "attributes", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "3", + "disabled": false, + "description": "The conversation attribute id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Retrieve a single conversation attribute by ID.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create a conversation attribute", + "tags": [ + "Conversations Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "attributes" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Create a new conversation attribute.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"api_test_attr\",\n \"description\": \"Created via API test\",\n \"data_type\": \"string\",\n \"required\": false,\n \"visible_to_team_ids\": [],\n \"multiline\": false,\n \"options\": [\n {\n \"label\": \"High\"\n }\n ],\n \"reference\": {\n \"type\": \"one\",\n \"object_type_id\": \"\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Add an option to a list conversation attribute", + "tags": [ + "Conversations Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/attributes/{id}/options", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "attributes", + "{id}", + "options" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "2", + "disabled": false, + "description": "The conversation attribute id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Add a new option to a list-type conversation attribute. Returns the full attribute with the updated options array.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"label\": \"High\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Update a conversation attribute", + "tags": [ + "Conversations Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "attributes", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "8", + "disabled": false, + "description": "The conversation attribute id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "Update an existing conversation attribute.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"api_test_renamed\",\n \"description\": \"Updated via API\",\n \"multiline\": false,\n \"required\": false,\n \"visible_to_team_ids\": [],\n \"reference\": {\n \"type\": \"one\",\n \"object_type_id\": \"\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Update an option on a list conversation attribute", + "tags": [ + "Conversations Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/attributes/{id}/options/{option_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "attributes", + "{id}", + "options", + "{option_id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "2", + "disabled": false, + "description": "The conversation attribute id" + }, + { + "key": "option_id", + "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "disabled": false, + "description": "The UUID of the list option to update (from the `id` field in the options array)" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "Update the label of a single option on a list-type conversation attribute. Returns the full attribute with the updated options array.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"label\": \"Renamed\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete (archive) a conversation attribute", + "tags": [ + "Conversations Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "attributes", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "8", + "disabled": false, + "description": "The conversation attribute id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "Archive a conversation attribute (soft delete). The attribute is marked as archived but not permanently deleted.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Archive an option on a list conversation attribute", + "tags": [ + "Conversations Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/attributes/{id}/options/{option_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "attributes", + "{id}", + "options", + "{option_id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "2", + "disabled": false, + "description": "The conversation attribute id" + }, + { + "key": "option_id", + "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "disabled": false, + "description": "The UUID of the list option to archive (from the `id` field in the options array)" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "Archive a single option on a list-type conversation attribute (soft delete). The option remains in the response with `archived: true`. Returns the full attribute with the updated options array.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Custom Object Instances", + "item": [ + { + "name": "List Custom Object Instances", + "tags": [ + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}" + ], + "query": [ + { + "key": "references_contact_id", + "value": "references_contact_id", + "description": "Return instances associated with the given contact ID." + }, + { + "key": "references_conversation_id", + "value": "references_conversation_id", + "description": "Return instances associated with the given conversation ID." + }, + { + "key": "external_id", + "value": "external_id", + "description": "Return the single instance with this external ID. When provided, the response is a single object rather than a list." + }, + { + "key": "page", + "value": "page", + "description": "Page number of results to fetch." + }, + { + "key": "per_page", + "value": "per_page", + "description": "Number of results per page. Maximum 150." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "List instances of a custom object type. Three modes are supported:\n- **No filter** — returns all instances for the type.\n- **`references_contact_id`** — returns instances associated with the given contact.\n- **`references_conversation_id`** — returns instances associated with the given conversation.\n\nWhen **`external_id`** is provided, returns a single matching instance (not a list).", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Get Custom Object Instance by ID", + "tags": [ + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The id or external_id of the custom object instance" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Fetch a Custom Object Instance by id.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create or Update a Custom Object Instance", + "tags": [ + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Create or update a custom object instance", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"external_id\": \"\",\n \"external_created_at\": 1571672154,\n \"external_updated_at\": 1571672154,\n \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete a Custom Object Instance by External ID", + "tags": [ + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}" + ], + "query": [ + { + "key": "external_id", + "value": "external_id" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "Delete a single Custom Object instance by external_id.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Delete a Custom Object Instance by ID", + "tags": [ + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The Intercom defined id of the custom object instance" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "Delete a single Custom Object instance using the Intercom defined id.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Data Attributes", + "item": [ + { + "name": "List all data attributes", + "tags": [ + "Data Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_attributes" + ], + "query": [ + { + "key": "model", + "value": "company", + "description": "Specify the data attribute model to return. For conversation attributes, use `GET /conversations/attributes` instead." + }, + { + "key": "include_archived", + "value": "include_archived", + "description": "Include archived attributes in the list. By default we return only non archived data attributes." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all data attributes belonging to a workspace for contacts or companies.\n\n{% admonition type=\"warning\" name=\"Conversation attributes removed\" %}\nConversation attributes are no longer returned by this endpoint. Calling without a `model` parameter no longer includes them in the response, and `model=conversation` returns a `422` error. Use [GET /conversations/attributes](/docs/references/preview/rest-api/api.intercom.io/conversations-attributes/listconversationattributes) instead.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create a data attribute", + "tags": [ + "Data Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_attributes" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can create a data attributes for a `contact` or a `company`.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data_type\": \"\",\n \"options\": [\n {\n \"value\": \"1-10\"\n },\n {\n \"value\": \"11-50\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Update a data attribute", + "tags": [ + "Data Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/data_attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_attributes", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "1", + "disabled": false, + "description": "The data attribute id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "\nYou can update a data attribute.\n\n> 🚧 Updating the data type is not possible\n>\n> It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"options\": [\n {\n \"value\": \"1-10\"\n },\n {\n \"value\": \"11-50\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Data Connectors", + "item": [ + { + "name": "Update a data connector", + "tags": [ + "Data Connectors" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/data_connectors/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_connectors", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "12345", + "disabled": false, + "description": "The unique identifier of the data connector." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PATCH", + "description": "Update an existing data connector. Only provided fields are changed. Set `state` to `live` or `draft` to change the connector's state.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Updated Connector Name\",\n \"description\": \"Updated description\",\n \"state\": \"draft\",\n \"http_method\": \"post\",\n \"url\": \"https://api.example.com/orders/{{order_id}}/status\",\n \"body\": \"\",\n \"direct_fin_usage\": false,\n \"audiences\": [\n \"leads\",\n \"users\"\n ],\n \"headers\": [\n {\n \"name\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"data_inputs\": [\n {\n \"name\": \"order_id\",\n \"type\": \"string\",\n \"description\": \"The order ID to look up\",\n \"required\": true,\n \"default_value\": \"\"\n }\n ],\n \"customer_authentication\": false,\n \"bypass_authentication\": false,\n \"validate_missing_attributes\": true,\n \"mock_response\": {\n \"order\": {\n \"id\": 12345,\n \"status\": \"shipped\"\n }\n },\n \"token_ids\": [\n \"1234\",\n \"5678\"\n ]\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "List all data connectors", + "tags": [ + "Data Connectors" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/data_connectors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_connectors" + ], + "query": [ + { + "key": "per_page", + "value": "per_page", + "description": "The number of results to return per page. Defaults to 20, minimum 1, maximum 50." + }, + { + "key": "starting_after", + "value": "starting_after", + "description": "The cursor value from `pages.next.starting_after` in a previous response. Used to paginate through results." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Returns a paginated list of all data connectors for the workspace, ordered by most recently updated first. Data connectors allow workflows and AI agents to make HTTP requests to external APIs.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a data connector", + "tags": [ + "Data Connectors" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/data_connectors/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_connectors", + "{id}" + ], + "query": [ + { + "key": "state_version", + "value": "state_version", + "description": "Which version of the data connector to return. Defaults to live." + } + ], + "variable": [ + { + "key": "id", + "value": "12345", + "disabled": false, + "description": "The unique identifier of the data connector." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can retrieve the full detail of a single data connector by its ID.\n\nThe response includes configuration, data inputs, response fields, and object mappings.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List execution results for a data connector", + "tags": [ + "Data Connectors" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/data_connectors/{data_connector_id}/execution_results", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_connectors", + "{data_connector_id}", + "execution_results" + ], + "query": [ + { + "key": "per_page", + "value": "per_page", + "description": "The number of results per page (1-30, default 10)." + }, + { + "key": "starting_after", + "value": "starting_after", + "description": "Cursor for pagination. Use the value from `pages.next.starting_after` in a previous response." + }, + { + "key": "success", + "value": "success", + "description": "Filter by success status. Use `true`, `false`, or omit for all." + }, + { + "key": "error_type", + "value": "error_type", + "description": "Filter by error type." + }, + { + "key": "start_ts", + "value": "start_ts", + "description": "Unix timestamp for start of time range (default 1 hour ago)." + }, + { + "key": "end_ts", + "value": "end_ts", + "description": "Unix timestamp for end of time range (default now)." + }, + { + "key": "include_bodies", + "value": "include_bodies", + "description": "Include request/response bodies in the response (default false)." + } + ], + "variable": [ + { + "key": "data_connector_id", + "value": "data_connector_id", + "disabled": false, + "description": "The unique identifier for the data connector." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Retrieve paginated execution logs for a specific data connector.\nResults from the last hour are returned by default. Use `start_ts` and `end_ts` to customize the time range.\n\nRequest/response bodies are excluded by default. Use `include_bodies=true` to include them.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve an execution result", + "tags": [ + "Data Connectors" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/data_connectors/{data_connector_id}/execution_results/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_connectors", + "{data_connector_id}", + "execution_results", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "data_connector_id", + "value": "data_connector_id", + "disabled": false, + "description": "The unique identifier for the data connector." + }, + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the execution result." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Retrieve details for a specific data connector execution result.\nAlways includes request/response bodies and the sanitised request URL.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create a data connector", + "tags": [ + "Data Connectors" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/data_connectors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_connectors" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Create a new data connector. The connector is created in `draft` state. Configure its URL, headers, data inputs, and other settings, then set it to `live` when ready.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Get Order Status\",\n \"description\": \"Looks up order status from an external service\",\n \"http_method\": \"get\",\n \"url\": \"https://api.example.com/orders/{{order_id}}/status\",\n \"body\": \"\",\n \"direct_fin_usage\": false,\n \"audiences\": [\n \"leads\",\n \"visitors\"\n ],\n \"headers\": [\n {\n \"name\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"data_inputs\": [\n {\n \"name\": \"order_id\",\n \"type\": \"string\",\n \"description\": \"The order ID to look up\",\n \"required\": true,\n \"default_value\": \"\"\n }\n ],\n \"customer_authentication\": false,\n \"bypass_authentication\": false,\n \"validate_missing_attributes\": false,\n \"mock_response\": {\n \"order\": {\n \"id\": 12345,\n \"status\": \"shipped\"\n }\n },\n \"token_ids\": [\n \"1234\",\n \"5678\"\n ]\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete a data connector", + "tags": [ + "Data Connectors" ], "request": { "url": { @@ -6270,22 +10002,1897 @@ "api.intercom.io" ], "path": [ - "data_connectors", + "data_connectors", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "12345", + "disabled": false, + "description": "The unique identifier of the data connector" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "Delete an existing data connector. The connector must be in `draft` state and must not be in use by any workflows or AI agents.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Data Events", + "item": [ + { + "name": "List all data events", + "tags": [ + "Data Events" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "events" + ], + "query": [ + { + "key": "filter", + "value": "filter" + }, + { + "key": "type", + "value": "type", + "description": "The value must be user" + }, + { + "key": "summary", + "value": "summary", + "description": "summary flag" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "\n> 🚧\n>\n> Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days\n\nThe events belonging to a customer can be listed by sending a GET request to `https://api.intercom.io/events` with a user or lead identifier along with a `type` parameter. The identifier parameter can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter value must be `user`.\n\n- `https://api.intercom.io/events?type=user&user_id={user_id}`\n- `https://api.intercom.io/events?type=user&email={email}`\n- `https://api.intercom.io/events?type=user&intercom_user_id={id}` (this call can be used to list leads)\n\nThe `email` parameter value should be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending.\n\nYou can optionally define the result page size as well with the `per_page` parameter.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Submit a data event", + "tags": [ + "Data Events" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "events" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "\nYou will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`.\n\nWhen using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.\n\nWith the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`).\n\n**NB: For the JSON object types, please note that we do not currently support nested JSON structure.**\n\n| Type | Description | Example |\n| :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- |\n| String | The value is a JSON String | `\"source\":\"desktop\"` |\n| Number | The value is a JSON Number | `\"load\": 3.67` |\n| Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `\"contact_date\": 1392036272` |\n| Link | The value is a HTTP or HTTPS URI. | `\"article\": \"https://example.org/ab1de.html\"` |\n| Rich Link | The value is a JSON object that contains `url` and `value` keys. | `\"article\": {\"url\": \"https://example.org/ab1de.html\", \"value\":\"the dude abides\"}` |\n| Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `\"price\": {\"amount\": 34999, \"currency\": \"eur\"}` |\n\n**Lead Events**\n\nWhen submitting events for Leads, you will need to specify the Lead's `id`.\n\n**Metadata behaviour**\n\n- We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.\n- It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.\n- There might be up to 24 hrs delay when you send a new metadata for an existing event.\n\n**Event de-duplication**\n\nThe API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field.\n\nDuplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.\n\n### HTTP API Responses\n\n- Successful responses to submitted events return `202 Accepted` with an empty body.\n- Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code.\n- Events sent about users that cannot be found will return a `404 Not Found`.\n- Event lists containing duplicate events will have those duplicates ignored.\n- Server errors will return a `500` response code and may contain an error message in the body.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"event_name\": \"invited-friend\",\n \"created_at\": 1671028894,\n \"user_id\": \"314159\",\n \"id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"email\": \"frodo.baggins@example.com\",\n \"metadata\": {\n \"invite_code\": \"ADDAFRIEND\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Create event summaries", + "tags": [ + "Data Events" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/events/summaries", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "events", + "summaries" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"user_id\": \"314159\",\n \"event_summaries\": {\n \"event_name\": \"invited-friend\",\n \"count\": 1,\n \"first\": 1671028894,\n \"last\": 1671028894\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Data Export", + "item": [ + { + "name": "Show content data export", + "tags": [ + "Data Export" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/export/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "export", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can view the status of your job by sending a `GET` request to the URL\n`https://api.intercom.io/export/content/data/{job_identifier}` - the `{job_identifier}` is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model.\n\n> 🚧 Jobs expire after two days\n> All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Download content data export", + "tags": [ + "Data Export" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/download/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "download", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234.\n\nYour exported message data will be streamed continuously back down to you in a gzipped CSV format.\n\n> 📘 Octet header required\n>\n> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create content data export", + "tags": [ + "Data Export" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/export/content/data", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "export", + "content", + "data" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "To create your export job, you need to send a `POST` request to the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis endpoint exports **message delivery and engagement data** for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported data includes who received each message, when they received it, and how they engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces). It does not export raw message or conversation content.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>🚧 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.\n\n>❗️ Updated_at not included\n>\n> It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.\n\n>📘 Date ranges are inclusive\n>\n> Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"created_at_after\": 1527811200,\n \"created_at_before\": 1527811200\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Cancel content data export", + "tags": [ + "Data Export" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/export/cancel/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "export", + "cancel", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can cancel your job", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Ecommerce Connectors", + "item": [ + { + "name": "Upload a product catalog", + "tags": [ + "Ecommerce Connectors" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/ecommerce/connectors/{id}/catalog", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ecommerce", + "connectors", + "{id}", + "catalog" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of the ecommerce connector." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Upload a product catalog to an ecommerce connector. The catalog must be a JSON\narray of product objects. There are two upload modes:\n\n**Single-file upload** — POST a single catalog file (up to 99 MB per request).\nOmit `finalize` and `import_job_id`. Returns `202 Accepted` when sync has started.\n\n**Multipart upload** — For catalogs that must be split across multiple requests:\n\n1. POST the first part with `finalize=false` (no `import_job_id`). The response\n returns an `import_job_id` and `next_part_number`.\n2. POST each subsequent part with `finalize=false`, the `import_job_id` from step 1,\n and the `part_number` from the previous response. Each part must be ≤ 99 MB.\n3. POST with `finalize=true` and the `import_job_id` to complete the upload and\n start the sync. No catalog file is required in the finalization request.\n\nPart uploads are idempotent — retrying the same `part_number` does not create\na duplicate. If a response is lost, retry with the same `part_number`.\n\n## Product object structure\n\nThe catalog file must be a JSON array where each element is a product object.\nOnly `id`, `title`, and `url` are required — all other fields are optional.\n\n| Field | Type | Required | Description |\n|---|---|---|---|\n| `id` | string | ✓ | Your unique product identifier. Used to match products on re-upload so only changed products are re-indexed. Also the delete key — any product ID absent from a new upload is removed from Fin's knowledge. Must be stable across uploads. |\n| `title` | string | ✓ | Product name. Used by Fin when searching for and recommending products. |\n| `url` | string | ✓ | Canonical product page URL shown in Fin's product recommendations. Must be a valid `https://` URL. |\n| `description` | string | | Product description that Fin reads to understand what the product is. HTML formatting is supported and safely sanitized (`description_html` takes precedence if both are provided). This is the primary field Fin uses to match products to shopper questions — a richer description leads to better recommendations. |\n| `featured_image_url` | string | | Primary product image shown in Fin's recommendation cards. Falls back to the first entry of `image_urls` if not provided. If no valid image can be resolved for a variant, that variant's card is not shown to the shopper. |\n| `image_urls` | string[] | | Additional product images. Used as a fallback when `featured_image_url` is absent or when a variant has no specific image. |\n| `price_min` | number | | Lowest price across all variants. If omitted, derived automatically from variant prices. Fin uses this to filter products when a shopper mentions a budget (e.g. \"under $100\"). Displayed as a range alongside `price_max`, or as a single value if both are equal. |\n| `price_max` | number | | Highest price across all variants. If omitted, derived from variant prices. Used alongside `price_min` for budget filtering and price display. |\n| `currency` | string | | ISO 4217 currency code (e.g. `\"USD\"`, `\"EUR\"`, `\"GBP\"`). Defaults to USD if omitted. Used to format prices with the correct symbol in Fin's responses and product cards. |\n| `in_stock` | boolean | | Whether the product is available to purchase. If omitted, derived from variant stock — the product is in stock if at least one variant has `in_stock: true`. Products with no in-stock variants are hidden from Fin entirely. |\n| `category_path` | string or string[] | Strongly recommended | Hierarchical category breadcrumb (e.g. `[\"Clothing\", \"Outerwear\", \"Jackets\"]`). Fin understands the hierarchy — a shopper asking about \"Clothing\" sees products from all subcategories underneath it. The most specific category is shown in search results. |\n| `collections` | string[] | Strongly recommended | Collections or groupings this product belongs to in your store. Fin uses collections to understand your catalog's structure and answer questions like \"what's in the sale collection?\". |\n| `tags` | string[] | | Free-form keywords matching how shoppers phrase needs in chat (e.g. `[\"waterproof\", \"gift\", \"plus-size\"]`). Complements `category_path` and `collections`. |\n| `available_options` | object[] | | Option types and their possible values (e.g. `{\"name\": \"Size\", \"values\": [\"S\", \"M\", \"L\"]}`). Fin uses these to understand what choices a shopper can make and to correctly filter variants when asked for a specific size, colour, or other attribute. |\n| `additional_data` | object | | Custom attributes for your business. Fin uses these to show each customer only relevant products. All keys must be consistent across all products in your catalog — the attribute schema is read from the first product in the file. |\n| `variants` | object[] | | Individual purchasable variants. Fin recommends specific variants (not just products), so populating variants with accurate stock, price, and option data leads to more precise recommendations. See the variant table below. |\n\n### Variant object structure\n\nEach object in the `variants` array may contain:\n\n| Field | Type | Required | Description |\n|---|---|---|---|\n| `id` | string | ✓ | Unique identifier for this variant within the product. |\n| `title` | string | | Variant display name shown to shoppers (e.g. `\"Small / Blue\"`). |\n| `price` | number | | Price of this specific variant. Fin uses variant prices for precise budget filtering and displays the variant price in recommendation cards. |\n| `compare_at_price` | number | | Original price before a discount. When provided, Fin will naturally mention the saving (e.g. \"down from $129 to $99\"). |\n| `in_stock` | boolean | | Whether this variant is currently available. Out-of-stock variants are not shown in Fin's recommendation cards and Fin will not suggest them to shoppers. |\n| `image_url` | string | | Image specific to this variant. Takes precedence over the product's `featured_image_url`. Falls back to `featured_image_url`, then `image_urls`. If no valid image can be resolved, this variant's recommendation card will not be shown. |\n| `selected_options` | object[] | | The specific option values that define this variant (e.g. `[{\"name\": \"Size\", \"value\": \"Small\"}, {\"name\": \"Color\", \"value\": \"Blue\"}]`). Fin uses these to match shopper requests like \"do you have this in medium?\" to the correct variant. |\n| `url` | string | | Direct link to this variant's page. Takes precedence over the product URL in recommendation cards. If omitted, constructed automatically as `{product_url}?variant={id}`. |\n\n### Example catalog file\n\n```json\n[\n {\n \"id\": \"prod-12345\",\n \"title\": \"Classic Cotton T-Shirt\",\n \"url\": \"https://example.com/products/classic-cotton-t-shirt\",\n \"description\": \"A comfortable everyday t-shirt.\",\n \"featured_image_url\": \"https://cdn.example.com/images/t-shirt.jpg\",\n \"price_min\": 19.99,\n \"price_max\": 29.99,\n \"currency\": \"USD\",\n \"in_stock\": true,\n \"tags\": [\"organic\", \"bestseller\"],\n \"collections\": [\"Summer Collection\"],\n \"category_path\": \"Clothing > T-Shirts\",\n \"available_options\": [\n {\"name\": \"Size\", \"values\": [\"S\", \"M\", \"L\"]},\n {\"name\": \"Color\", \"values\": [\"White\", \"Blue\"]}\n ],\n \"variants\": [\n {\n \"id\": \"var-001\",\n \"title\": \"S / White\",\n \"price\": 19.99,\n \"in_stock\": true,\n \"selected_options\": [\n {\"name\": \"Size\", \"value\": \"S\"},\n {\"name\": \"Color\", \"value\": \"White\"}\n ]\n },\n {\n \"id\": \"var-002\",\n \"title\": \"M / Blue\",\n \"price\": 29.99,\n \"in_stock\": true,\n \"selected_options\": [\n {\"name\": \"Size\", \"value\": \"M\"},\n {\"name\": \"Color\", \"value\": \"Blue\"}\n ]\n }\n ],\n \"additional_data\": {\n \"sku\": \"TSHIRT-WHT-S\",\n \"vendor\": \"Acme Apparel\"\n }\n }\n]\n```\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "urlencoded": [], + "formdata": [ + { + "key": "catalog", + "value": "", + "disabled": true, + "type": "file", + "description": "The catalog JSON file. Required for all requests except finalization\n(`finalize=true`). Must be a valid JSON array of product objects. Max 99 MB.\n\nEach element in the array must conform to the\n[`ecommerce_catalog_product`](/docs/references/preview/rest-api/api.intercom.io/models/ecommerce_catalog_product) schema.\nThe `id`, `title`, and `url` fields are required on every product;\nall other fields are optional. Variants, if provided, must conform to the\n[`ecommerce_catalog_variant`](/docs/references/preview/rest-api/api.intercom.io/models/ecommerce_catalog_variant) schema.\n" + }, + { + "key": "finalize", + "value": "\"false\"", + "disabled": true, + "type": "text", + "description": "Set to `true` to finalize a multipart upload session and start the catalog sync.\nNo catalog file is required when finalizing. Set to `false` to upload a part in\na multipart session. Omit entirely for a single-file upload.\n" + }, + { + "key": "import_job_id", + "value": "\"job_01abc123\"", + "disabled": true, + "type": "text", + "description": "The import job ID returned from the first multipart upload request. Required\nwhen uploading subsequent parts (`part_number` ≥ 2) and when finalizing\na multipart session (`finalize=true`).\n" + }, + { + "key": "part_number", + "value": "2", + "disabled": true, + "type": "text", + "description": "The sequential part number for a multipart upload. Must be a positive integer.\nThe server returns `next_part_number` in each response to guide the next request.\nRetrying the same `part_number` is safe and idempotent.\n" + } + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Emails", + "item": [ + { + "name": "List all email settings", + "tags": [ + "Emails" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/emails", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "emails" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Lists all sender email address settings for the workspace", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve an email setting", + "tags": [ + "Emails" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/emails/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "emails", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of the email setting" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Fetches a specific email setting by its unique identifier", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Fin Agent", + "item": [ + { + "name": "Discover Fin's capabilities", + "tags": [ + "Fin Agent" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin/capabilities", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin", + "capabilities" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Return a machine-readable, per-user list of what Fin can do for a given end user, so an\norchestrating agent can decide which endpoint to call.\n\nThe response is audience-matched to the supplied user: each live, API-triggerable\nprocedure is checked against that user before being included, alongside the static\n`reply` and `ask` actions.\n\n{% admonition type=\"warning\" %}\nTo request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"user\": {\n \"id\": \"123456\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"attributes\": {\n \"plan_type\": \"Pro\",\n \"subscription_status\": \"active\"\n }\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Ask Fin", + "tags": [ + "Fin Agent" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin/ask", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin", + "ask" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Ask Fin a single, self-contained question and receive one informational answer.\n\nUnlike a conversation, `/fin/ask` is non-conversational: Fin will not ask follow-up\nquestions, will not run procedures, and will not escalate to a human on its own. You can\nstill escalate one yourself with `POST /fin/escalate`; the ask conversation is already\nclosed after its one-shot answer, and escalation leaves it closed while routing the\nhandoff separately.\n\nFin's answer is delivered asynchronously via the `fin_replied` event. The conversation\nends with a `complete` status — there is no `awaiting_user_reply` cycle.\n\n{% admonition type=\"warning\" %}\nTo request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"conversation_id\": \"ext-123\",\n \"message\": {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n },\n \"user\": {\n \"id\": \"123456\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"attributes\": {\n \"plan_type\": \"Pro\",\n \"subscription_status\": \"active\"\n }\n },\n \"conversation_metadata\": {\n \"history\": [\n {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n }\n ],\n \"attributes\": {\n \"priority_level\": \"high\",\n \"department\": \"sales\"\n }\n },\n \"attachments\": [\n {\n \"type\": \"url\",\n \"url\": \"https://example.com/document.pdf\",\n \"name\": \"screenshot.png\",\n \"content_type\": \"image/png\",\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk...\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Reply to Fin", + "tags": [ + "Fin Agent" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin", + "reply" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Send a follow-up message in an existing conversation. When Fin needs more information to\ncomplete an action, it sets the conversation to `awaiting_user_reply` — send the user's\nresponse so Fin can continue.\n\n{% admonition type=\"warning\" %}\nTo request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"conversation_id\": \"123456\",\n \"message\": {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n },\n \"user\": {\n \"id\": \"123456\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"attributes\": {\n \"plan_type\": \"Pro\",\n \"subscription_status\": \"active\"\n }\n },\n \"attachments\": [\n {\n \"type\": \"url\",\n \"url\": \"https://example.com/document.pdf\",\n \"name\": \"screenshot.png\",\n \"content_type\": \"image/png\",\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk...\"\n }\n ],\n \"settings\": {\n \"follow_up_questions\": true,\n \"email\": true\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Run a Fin procedure", + "tags": [ + "Fin Agent" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin/procedures/{procedure_id}/run", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin", + "procedures", + "{procedure_id}", + "run" + ], + "query": [], + "variable": [ + { + "key": "procedure_id", + "value": "12345", + "disabled": false, + "description": "The ID of the procedure to run." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Deterministically run a specific procedure on a new conversation. Calling this endpoint\nguarantees that the named procedure runs — there is no non-deterministic routing.\n\nFin's progress is delivered asynchronously via events or Server-Sent Events. If the\nprocedure pauses for user input, the conversation status becomes `awaiting_user_reply` —\nsend the user's response with [`/fin/reply`](/docs/references/preview/rest-api/api.intercom.io/fin-agent/replytofin).\n\n{% admonition type=\"warning\" %}\nTo request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"conversation_id\": \"ext-123\",\n \"user\": {\n \"id\": \"123456\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"attributes\": {\n \"plan_type\": \"Pro\",\n \"subscription_status\": \"active\"\n }\n },\n \"message\": {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n },\n \"conversation_metadata\": {\n \"attributes\": {\n \"order_id\": \"98765\"\n }\n },\n \"settings\": {\n \"email\": true\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Escalate to a human", + "tags": [ + "Fin Agent" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin/escalate", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin", + "escalate" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Hand a conversation off to a human teammate. If you use the Intercom Helpdesk, the\nhandoff lands in your team inbox.\n\nProvide either `conversation_id` or `user`:\n\n- `conversation_id` — escalate an existing agent conversation, including one started\n with `/fin/ask`. On the Intercom Helpdesk, Fin by default summarises the conversation\n and opens a new Helpdesk conversation that carries the summary as an internal note.\n Escalation does not change the original agent conversation's assignment or open/closed\n state. Configure an escalation Operator Workflow to change this default.\n- `user` — escalate on behalf of a user with no prior agent conversation. On the Intercom\n Helpdesk, a new Helpdesk conversation is created for the teammate. Not supported on Fin\n for Platforms — see below.\n\nIn both cases, pass the optional `context` to give the receiving teammate background your\norchestrating agent has and Fin does not. On the Intercom Helpdesk, it appears above the\nsummary in the internal note of the new conversation the teammate picks up. It is never\nshown to the end user.\n\nEscalating an existing conversation also sets its AI Agent resolution state to\n`escalated`, readable as `ai_agent.resolution_state` on the Conversations API. This is a\nresolution state, not a billable resolution.\n\nOn Fin for Platforms, `conversation_id` is required — `user` is not supported and is\nrejected, because there is no Intercom Helpdesk in which to create a conversation. There\nis no Intercom inbox either, so an escalation that no workflow handles does not open a\nHelpdesk conversation for a teammate. `context` is not surfaced, and the conversation is\nleft open for your platform to hand off and continue driving.\n\nYou are notified over the existing webhook or SSE channel with an `escalated` status\nfollowed by `complete`. The `complete` status signals that Fin is done; it does not close\nthe conversation. On the Intercom Helpdesk, the new human conversation remains open; on\nFin for Platforms, the conversation remains open for whoever handles it on your platform.\n\n{% admonition type=\"warning\" %}\nTo request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"conversation_id\": \"ext-123\",\n \"user\": {\n \"id\": \"123456\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"attributes\": {\n \"plan_type\": \"Pro\",\n \"subscription_status\": \"active\"\n }\n },\n \"context\": \"Customer is requesting a refund and is frustrated.\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Submit a CSAT rating", + "tags": [ + "Fin Agent" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin/csat", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin", + "csat" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Record a customer's satisfaction rating for a conversation, with an optional free-text\nremark.\n\nFin decides *when* to ask for a rating — this reuses the CSAT settings on your Fin\nworkflow, not this API. When Fin asks, it fires a `csat_requested` event over webhooks or\nSSE carrying the rating options to show the user. Present those options, then submit the\nuser's choice here.\n\nSubmitting the same rating again, with no new remark, is a no-op and stays successful,\nso an at-least-once client can safely retry. Submitting a *different* rating updates the\nstored rating while the update window is still open, and a first remark can be added to\nan already-rated survey. Once a remark has been recorded the rating is locked and can no\nlonger be changed.\n\n{% admonition type=\"warning\" %}\nTo request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"conversation_id\": \"ext-123\",\n \"rating\": \"amazing\",\n \"remark\": \"Fin solved my problem in seconds.\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Start a conversation with Fin", + "tags": [ + "Fin Agent" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin/start", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin", + "start" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "{% admonition type=\"info\" name=\"Legacy — conversational mode\" %}\n`/fin/start` powers the conversational model, where your own UI drives a back-and-forth with Fin. This endpoint is no longer actively developed and is maintained only for existing integrations — new functionality lands on the orchestration endpoints.\n{% /admonition %}\n\nInitialize Fin by passing it the user's message along with conversation history and user details.\n\nThese additional pieces of context will be used by Fin to provide a better and more contextual answer to the user.\n\nOnce Fin is initialized, it progresses through a series of statuses such as *thinking*, *replying*, *awaiting_user_reply*, or *resolved* before ending with a status of *complete*.\n\nDuring this workflow, the client should allow Fin to continue uninterrupted until a final *complete* status is returned, at which point control of the conversation passes back to the client.\n\nEvents can be received via webhooks or Server-Sent Events (SSE) using the `sse_subscription_url` in the response.\n\n{% admonition type=\"warning\" %}\nTo request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"conversation_id\": \"ext-123\",\n \"message\": {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n },\n \"user\": {\n \"id\": \"123456\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"attributes\": {\n \"plan_type\": \"Pro\",\n \"subscription_status\": \"active\"\n }\n },\n \"attachments\": [\n {\n \"type\": \"url\",\n \"url\": \"https://example.com/document.pdf\",\n \"name\": \"screenshot.png\",\n \"content_type\": \"image/png\",\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk...\"\n }\n ],\n \"conversation_metadata\": {\n \"history\": [\n {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n }\n ],\n \"attributes\": {\n \"priority_level\": \"high\",\n \"department\": \"sales\"\n }\n },\n \"settings\": {\n \"follow_up_questions\": true,\n \"email\": true\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Help Center", + "item": [ + { + "name": "List all redirects for a help center", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "help_centers", + "{help_center_id}", + "redirects" + ], + "query": [ + { + "key": "page", + "value": "1", + "description": "The page of results to fetch. Defaults to the first page." + }, + { + "key": "per_page", + "value": "50", + "description": "The number of results to return per page. Defaults to 50, maximum 250." + } + ], + "variable": [ + { + "key": "help_center_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the help center." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all URL redirects for a help center by making a GET request to `https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects`.\n\nRedirects are returned in descending order on the `updated_at` attribute.\n\nRequires the `read_help_center_redirects_scope` OAuth scope. Set `Intercom-Version: Preview`.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a redirect", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "help_centers", + "{help_center_id}", + "redirects", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "help_center_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the help center." + }, + { + "key": "id", + "value": "26", + "disabled": false, + "description": "The unique identifier for the redirect." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch the details of a single redirect by making a GET request to `https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects/{id}`.\n\nRequires the `read_help_center_redirects_scope` OAuth scope. Set `Intercom-Version: Preview`.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List all collections", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "collections" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`.\n\nCollections will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a collection", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a Help Center", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/help_centers/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "help_centers", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List all Help Centers", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/help_centers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "help_centers" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create a redirect", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "help_centers", + "{help_center_id}", + "redirects" + ], + "query": [], + "variable": [ + { + "key": "help_center_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the help center." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can create a new URL redirect by making a POST request to `https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects`.\n\nRequires the `read_write_help_center_redirects_scope` OAuth scope. Set `Intercom-Version: Preview`.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"from_url\": \"http://help-center.test/lovelyhelpcenter/old-page\",\n \"locale\": \"en\",\n \"target_type\": \"article\",\n \"target_id\": \"11\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Create a collection", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "collections" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"collection 51\",\n \"description\": \"English description\",\n \"translated_content\": {\n \"type\": \"group_translated_content\",\n \"ar\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"bg\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"bs\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ca\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"cs\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"da\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"de\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"el\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"en\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"es\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"et\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"fi\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"fr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"he\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"hr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"hu\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"id\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"it\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ja\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ko\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"lt\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"lv\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"mn\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"nb\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"nl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pt\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ro\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ru\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sv\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"tr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"vi\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pt-BR\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"zh-CN\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"zh-TW\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n }\n },\n \"parent_id\": \"6871118\",\n \"help_center_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Update a collection", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"collection 51\",\n \"description\": \"English description\",\n \"translated_content\": {\n \"type\": \"group_translated_content\",\n \"ar\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"bg\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"bs\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ca\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"cs\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"da\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"de\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"el\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"en\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"es\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"et\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"fi\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"fr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"he\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"hr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"hu\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"id\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"it\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ja\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ko\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"lt\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"lv\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"mn\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"nb\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"nl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pt\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ro\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ru\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sv\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"tr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"vi\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pt-BR\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"zh-CN\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"zh-TW\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n }\n },\n \"parent_id\": \"6871118\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete a redirect", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "help_centers", + "{help_center_id}", + "redirects", "{id}" ], - "query": [ + "query": [], + "variable": [ { - "key": "state_version", - "value": "state_version", - "description": "Which version of the data connector to return. Defaults to live." + "key": "help_center_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the help center." + }, + { + "key": "id", + "value": "26", + "disabled": false, + "description": "The unique identifier for the redirect." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" } + ] + }, + "method": "DELETE", + "description": "You can delete a single redirect by making a DELETE request to `https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects/{id}`.\n\nRequires the `read_write_help_center_redirects_scope` OAuth scope. Set `Intercom-Version: Preview`.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Delete a collection", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "collections", + "{id}" ], + "query": [], "variable": [ { "key": "id", - "value": "12345", + "value": "123", "disabled": false, - "description": "The unique identifier of the data connector." + "description": "The unique identifier for the collection which is given by Intercom." } ] }, @@ -6309,8 +11916,8 @@ } ] }, - "method": "GET", - "description": "You can retrieve the full detail of a single data connector by its ID.\n\nThe response includes configuration, data inputs, response fields, and object mappings.\n", + "method": "DELETE", + "description": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", "header": [ { "key": "Intercom-Version", @@ -6324,74 +11931,213 @@ "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Identity Verification Secrets", + "item": [ { - "name": "List execution results for a data connector", + "name": "List all identity verification secrets", "tags": [ - "Data Connectors" + "Identity Verification Secrets" ], "request": { "url": { - "raw": "https://api.intercom.io/data_connectors/{data_connector_id}/execution_results", + "raw": "https://api.intercom.io/secure_mode_secrets", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "data_connectors", - "{data_connector_id}", - "execution_results" + "secure_mode_secrets" ], - "query": [ + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ { - "key": "per_page", - "value": "per_page", - "description": "The number of results per page (1-30, default 10)." + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" }, { - "key": "starting_after", - "value": "starting_after", - "description": "Cursor for pagination. Use the value from `pages.next.starting_after` in a previous response." + "key": "tokenType", + "value": "bearer", + "type": "string" }, { - "key": "success", - "value": "success", - "description": "Filter by success status. Use `true`, `false`, or omit for all." - }, + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Returns the identity verification secrets configured for your workspace.\n\nEach entry includes metadata only — the HMAC signing material itself is **never** returned by this endpoint. The raw secret is only available once, in the response to `POST /secure_mode_secrets`. Persist it at that moment.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create an identity verification secret", + "tags": [ + "Identity Verification Secrets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/secure_mode_secrets", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "secure_mode_secrets" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ { - "key": "error_type", - "value": "error_type", - "description": "Filter by error type." + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" }, { - "key": "start_ts", - "value": "start_ts", - "description": "Unix timestamp for start of time range (default 1 hour ago)." + "key": "tokenType", + "value": "bearer", + "type": "string" }, { - "key": "end_ts", - "value": "end_ts", - "description": "Unix timestamp for end of time range (default now)." + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Creates a new identity verification secret for your workspace. Intercom generates a 256-bit, cryptographically random value server-side and returns it once in the response.\n\n**This is the only opportunity to capture the secret.** Store it in your secure configuration immediately. The `secret` field is omitted from all subsequent responses (including `GET /secure_mode_secrets`) — if you lose it, you must rotate a new secret in and delete this one.\n\nYou must enable the secret for at least one platform (`supports_android`, `supports_ios`, or `supports_web`). Rotation flow: create the new secret, roll it out to every client signing `user_hash` values, then delete the old secret with `DELETE /secure_mode_secrets/{id}` once traffic has cut over.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Production Web\",\n \"supports_android\": false,\n \"supports_ios\": false,\n \"supports_web\": true\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete an identity verification secret", + "tags": [ + "Identity Verification Secrets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/secure_mode_secrets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "secure_mode_secrets", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "102", + "disabled": false, + "description": "The unique identifier of the identity verification secret" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" }, { - "key": "include_bodies", - "value": "include_bodies", - "description": "Include request/response bodies in the response (default false)." + "key": "tokenType", + "value": "bearer", + "type": "string" }, { - "key": "include_request_url", - "value": "include_request_url", - "description": "Include the request URL in the response (default false)." + "key": "addTokenTo", + "value": "header", + "type": "string" } + ] + }, + "method": "DELETE", + "description": "Soft-deletes an identity verification secret. After deletion, any `user_hash` values signed with that secret will no longer verify — Messenger sessions depending on it will be rejected on their next request. Use this to complete a rotation: create a new secret, roll it out, then delete the old one.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Internal Articles", + "item": [ + { + "name": "List all articles", + "tags": [ + "Internal Articles" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/internal_articles", + "protocol": "https", + "host": [ + "api.intercom.io" ], - "variable": [ - { - "key": "data_connector_id", - "value": "data_connector_id", - "disabled": false, - "description": "The unique identifier for the data connector." - } - ] + "path": [ + "internal_articles" + ], + "query": [], + "variable": [] }, "auth": { "type": "bearer", @@ -6414,7 +12160,7 @@ ] }, "method": "GET", - "description": "Retrieve paginated execution logs for a specific data connector.\nResults from the last hour are returned by default. Use `start_ts` and `end_ts` to customize the time range.\n\nRequest/response bodies and request URL are excluded by default.\nUse `include_bodies=true` to include bodies.\nUse `include_request_url=true` to include the sanitised request URL.\n", + "description": "You can fetch a list of all internal articles by making a GET request to `https://api.intercom.io/internal_articles`.", "header": [ { "key": "Intercom-Version", @@ -6430,36 +12176,28 @@ "response": [] }, { - "name": "Retrieve an execution result", + "name": "Retrieve an internal article", "tags": [ - "Data Connectors" + "Internal Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/data_connectors/{data_connector_id}/execution_results/{id}", + "raw": "https://api.intercom.io/internal_articles/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "data_connectors", - "{data_connector_id}", - "execution_results", + "internal_articles", "{id}" ], "query": [], "variable": [ - { - "key": "data_connector_id", - "value": "data_connector_id", - "disabled": false, - "description": "The unique identifier for the data connector." - }, { "key": "id", - "value": "id", + "value": "123", "disabled": false, - "description": "The unique identifier for the execution result." + "description": "The unique identifier for the article which is given by Intercom." } ] }, @@ -6484,7 +12222,7 @@ ] }, "method": "GET", - "description": "Retrieve details for a specific data connector execution result.\nAlways includes request/response bodies and the sanitised request URL.\n", + "description": "You can fetch the details of a single internal article by making a GET request to `https://api.intercom.io/internal_articles/`.", "header": [ { "key": "Intercom-Version", @@ -6500,21 +12238,28 @@ "response": [] }, { - "name": "Create a data connector", + "name": "Search for internal articles", "tags": [ - "Data Connectors" + "Internal Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/data_connectors", + "raw": "https://api.intercom.io/internal_articles/search", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "data_connectors" + "internal_articles", + "search" + ], + "query": [ + { + "key": "folder_id", + "value": "123", + "description": "The ID of the folder to search in. Results will include articles from this folder and all its descendant folders." + } ], - "query": [], "variable": [] }, "auth": { @@ -6537,56 +12282,39 @@ } ] }, - "method": "POST", - "description": "Create a new data connector. The connector is created in `draft` state. Configure its URL, headers, data inputs, and other settings, then set it to `live` when ready.\n", + "method": "GET", + "description": "You can search for internal articles by making a GET request to `https://api.intercom.io/internal_articles/search`.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Get Order Status\",\n \"description\": \"Looks up order status from an external service\",\n \"http_method\": \"get\",\n \"url\": \"https://api.example.com/orders/{{order_id}}/status\",\n \"body\": \"\",\n \"direct_fin_usage\": false,\n \"audiences\": [\n \"leads\",\n \"visitors\"\n ],\n \"headers\": [\n {\n \"name\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"data_inputs\": [\n {\n \"name\": \"order_id\",\n \"type\": \"string\",\n \"description\": \"The order ID to look up\",\n \"required\": true,\n \"default_value\": \"\"\n }\n ],\n \"customer_authentication\": false,\n \"bypass_authentication\": false,\n \"validate_missing_attributes\": false,\n \"mock_response\": {\n \"order\": {\n \"id\": 12345,\n \"status\": \"shipped\"\n }\n },\n \"token_ids\": [\n \"1234\",\n \"5678\"\n ]\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Delete a data connector", + "name": "Create an internal article", "tags": [ - "Data Connectors" + "Internal Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/data_connectors/{id}", + "raw": "https://api.intercom.io/internal_articles", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "data_connectors", - "{id}" + "internal_articles" ], "query": [], - "variable": [ - { - "key": "id", - "value": "12345", - "disabled": false, - "description": "The unique identifier of the data connector" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -6608,59 +12336,58 @@ } ] }, - "method": "DELETE", - "description": "Delete an existing data connector. The connector must be in `draft` state and must not be in use by any workflows or AI agents.\n", + "method": "POST", + "description": "You can create a new internal article by making a POST request to `https://api.intercom.io/internal_articles`.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"title\": \"Thanks for everything\",\n \"body\": \"

This is the body in html

\",\n \"body_markdown\": \"# Internal Guide\\n\\nSome instructions.\\n\",\n \"author_id\": 1295,\n \"owner_id\": 1295,\n \"folder_id\": 6,\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - } - ] - }, - { - "name": "Data Events", - "item": [ + }, { - "name": "List all data events", + "name": "Add a tag to an internal article", "tags": [ - "Data Events" + "Internal Articles", + "Tags" ], "request": { "url": { - "raw": "https://api.intercom.io/events", + "raw": "https://api.intercom.io/internal_articles/{internal_article_id}/tags", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "events" + "internal_articles", + "{internal_article_id}", + "tags" ], - "query": [ - { - "key": "filter", - "value": "filter" - }, - { - "key": "type", - "value": "type", - "description": "The value must be user" - }, + "query": [], + "variable": [ { - "key": "summary", - "value": "summary", - "description": "summary flag" + "key": "internal_article_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the internal article which is given by Intercom." } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -6682,39 +12409,56 @@ } ] }, - "method": "GET", - "description": "\n> 🚧\n>\n> Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days\n\nThe events belonging to a customer can be listed by sending a GET request to `https://api.intercom.io/events` with a user or lead identifier along with a `type` parameter. The identifier parameter can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter value must be `user`.\n\n- `https://api.intercom.io/events?type=user&user_id={user_id}`\n- `https://api.intercom.io/events?type=user&email={email}`\n- `https://api.intercom.io/events?type=user&intercom_user_id={id}` (this call can be used to list leads)\n\nThe `email` parameter value should be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending.\n\nYou can optionally define the result page size as well with the `per_page` parameter.\n", + "method": "POST", + "description": "Apply an existing tag to an internal article. Returns the tag that was applied.\n\nThe tag must already exist in the workspace (create tags with the Tags API),\nand the authenticating teammate must have the `manage_knowledge_base_content`\npermission.\n\nRequires the `read_write_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"1234\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Submit a data event", + "name": "Update an internal article", "tags": [ - "Data Events" + "Internal Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/events", + "raw": "https://api.intercom.io/internal_articles/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "events" + "internal_articles", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the internal article which is given by Intercom." + } + ] }, "auth": { "type": "bearer", @@ -6736,8 +12480,8 @@ } ] }, - "method": "POST", - "description": "\nYou will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`.\n\nWhen using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.\n\nWith the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`).\n\n**NB: For the JSON object types, please note that we do not currently support nested JSON structure.**\n\n| Type | Description | Example |\n| :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- |\n| String | The value is a JSON String | `\"source\":\"desktop\"` |\n| Number | The value is a JSON Number | `\"load\": 3.67` |\n| Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `\"contact_date\": 1392036272` |\n| Link | The value is a HTTP or HTTPS URI. | `\"article\": \"https://example.org/ab1de.html\"` |\n| Rich Link | The value is a JSON object that contains `url` and `value` keys. | `\"article\": {\"url\": \"https://example.org/ab1de.html\", \"value\":\"the dude abides\"}` |\n| Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `\"price\": {\"amount\": 34999, \"currency\": \"eur\"}` |\n\n**Lead Events**\n\nWhen submitting events for Leads, you will need to specify the Lead's `id`.\n\n**Metadata behaviour**\n\n- We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.\n- It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.\n- There might be up to 24 hrs delay when you send a new metadata for an existing event.\n\n**Event de-duplication**\n\nThe API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field.\n\nDuplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.\n\n### HTTP API Responses\n\n- Successful responses to submitted events return `202 Accepted` with an empty body.\n- Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code.\n- Events sent about users that cannot be found will return a `404 Not Found`.\n- Event lists containing duplicate events will have those duplicates ignored.\n- Server errors will return a `500` response code and may contain an error message in the body.\n\n", + "method": "PUT", + "description": "You can update the details of a single internal article by making a PUT request to `https://api.intercom.io/internal_articles/`.", "header": [ { "key": "Intercom-Version", @@ -6754,7 +12498,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"event_name\": \"invited-friend\",\n \"created_at\": 1671028894,\n \"user_id\": \"314159\",\n \"id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"email\": \"frodo.baggins@example.com\",\n \"metadata\": {\n \"invite_code\": \"ADDAFRIEND\"\n }\n}", + "raw": "{\n \"title\": \"Thanks for everything\",\n \"body\": \"\",\n \"body_markdown\": \"## Updated\\n\\nNew content.\\n\",\n \"author_id\": 1295,\n \"owner_id\": 1295,\n \"folder_id\": 6,\n \"audience_ids\": [\n 1,\n 2\n ],\n \"ai_chatbot_availability\": true,\n \"ai_copilot_availability\": true,\n \"ai_sales_agent_availability\": true\n}", "urlencoded": [], "formdata": [] } @@ -6762,23 +12506,30 @@ "response": [] }, { - "name": "Create event summaries", + "name": "Delete an internal article", "tags": [ - "Data Events" + "Internal Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/events/summaries", + "raw": "https://api.intercom.io/internal_articles/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "events", - "summaries" + "internal_articles", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the internal article which is given by Intercom." + } + ] }, "auth": { "type": "bearer", @@ -6800,61 +12551,54 @@ } ] }, - "method": "POST", - "description": "Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred.\n\n", + "method": "DELETE", + "description": "You can delete a single internal article by making a DELETE request to `https://api.intercom.io/internal_articles/`.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"user_id\": \"314159\",\n \"event_summaries\": {\n \"event_name\": \"invited-friend\",\n \"count\": 1,\n \"first\": 1671028894,\n \"last\": 1671028894\n }\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] - } - ] - }, - { - "name": "Data Export", - "item": [ + }, { - "name": "Show content data export", + "name": "Remove a tag from an internal article", "tags": [ - "Data Export" + "Internal Articles", + "Tags" ], "request": { "url": { - "raw": "https://api.intercom.io/export/content/data/{job_identifier}", + "raw": "https://api.intercom.io/internal_articles/{internal_article_id}/tags/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "export", - "content", - "data", - "{job_identifier}" + "internal_articles", + "{internal_article_id}", + "tags", + "{id}" ], "query": [], "variable": [ { - "key": "job_identifier", - "value": "job_identifier", + "key": "internal_article_id", + "value": "123", "disabled": false, - "description": "job_identifier" + "description": "The unique identifier for the internal article which is given by Intercom." + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier of the tag to remove, as given by Intercom." } ] }, @@ -6878,8 +12622,8 @@ } ] }, - "method": "GET", - "description": "You can view the status of your job by sending a `GET` request to the URL\n`https://api.intercom.io/export/content/data/{job_identifier}` - the `{job_identifier}` is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model.\n\n> 🚧 Jobs expire after two days\n> All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.\n", + "method": "DELETE", + "description": "Remove a tag from an internal article. Returns the tag that was removed, with\nnull `applied_at` and `applied_by`.\n\nThe authenticating teammate must have the `manage_knowledge_base_content`\npermission.\n\nRequires the `read_write_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.\n", "header": [ { "key": "Intercom-Version", @@ -6893,32 +12637,36 @@ "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Jobs", + "item": [ { - "name": "Download content data export", + "name": "Retrieve job status", "tags": [ - "Data Export" + "Jobs" ], "request": { "url": { - "raw": "https://api.intercom.io/download/content/data/{job_identifier}", + "raw": "https://api.intercom.io/jobs/status/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "download", - "content", - "data", - "{job_identifier}" + "jobs", + "status", + "{id}" ], "query": [], "variable": [ { - "key": "job_identifier", - "value": "job_identifier", + "key": "id", + "value": "id", "disabled": false, - "description": "job_identifier" + "description": "The unique identifier for the job which is given by Intercom" } ] }, @@ -6943,7 +12691,7 @@ ] }, "method": "GET", - "description": "When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234.\n\nYour exported message data will be streamed continuously back down to you in a gzipped CSV format.\n\n> 📘 Octet header required\n>\n> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.\n", + "description": "Retrieve the status of job execution.", "header": [ { "key": "Intercom-Version", @@ -6957,25 +12705,44 @@ "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Macros", + "item": [ { - "name": "Create content data export", + "name": "List all macros", "tags": [ - "Data Export" + "Macros" ], "request": { "url": { - "raw": "https://api.intercom.io/export/content/data", + "raw": "https://api.intercom.io/macros", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "export", - "content", - "data" + "macros" + ], + "query": [ + { + "key": "per_page", + "value": "50", + "description": "The number of results per page" + }, + { + "key": "starting_after", + "value": "WzE3MTk0OTM3NTcuMCwgIjEyMyJd", + "description": "Base64-encoded cursor containing [updated_at, id] for pagination" + }, + { + "key": "updated_since", + "value": "1719474966", + "description": "Unix timestamp to filter macros updated after this time" + } ], - "query": [], "variable": [] }, "auth": { @@ -6998,55 +12765,45 @@ } ] }, - "method": "POST", - "description": "To create your export job, you need to send a `POST` request to the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>🚧 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.\n\n>❗️ Updated_at not included\n>\n> It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.\n\n>📘 Date ranges are inclusive\n>\n> Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.\n", + "method": "GET", + "description": "You can fetch a list of all macros (saved replies) in your workspace for use in automating responses.\n\nThe macros are returned in descending order by updated_at.\n\n**Pagination**\n\nThis endpoint uses cursor-based pagination via the `starting_after` parameter. The cursor is a Base64-encoded JSON array containing `[updated_at, id]` of the last item from the previous page.\n\n**Placeholder Transformation**\n\nThe API transforms Intercom placeholders to a more standard XML-like format:\n- From: `{{user.name | fallback: 'there'}}`\n- To: ``\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"created_at_after\": 1527811200,\n \"created_at_before\": 1527811200\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Cancel content data export", + "name": "Retrieve a macro", "tags": [ - "Data Export" + "Macros" ], "request": { "url": { - "raw": "https://api.intercom.io/export/cancel/{job_identifier}", + "raw": "https://api.intercom.io/macros/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "export", - "cancel", - "{job_identifier}" + "macros", + "{id}" ], "query": [], "variable": [ { - "key": "job_identifier", - "value": "job_identifier", + "key": "id", + "value": "123", "disabled": false, - "description": "job_identifier" + "description": "The unique identifier of the macro" } ] }, @@ -7070,8 +12827,8 @@ } ] }, - "method": "POST", - "description": "You can cancel your job", + "method": "GET", + "description": "You can fetch a single macro (saved reply) by its ID. The macro will only be returned if it is visible to the authenticated user based on its visibility settings.\n\n**Visibility Rules**\n\nA macro is returned based on its `visible_to` setting:\n- `everyone`: Always visible to all team members\n- `specific_teams`: Only visible if the authenticated user belongs to one of the teams specified in `visible_to_team_ids`\n\nIf a macro exists but is not visible to the authenticated user, a 404 error is returned.\n\n**Placeholder Transformation**\n\nThe API transforms Intercom placeholders to a more standard XML-like format in the `body` field:\n- From: `{{user.name | fallback: 'there'}}`\n- To: ``\n\nDefault values in placeholders are HTML-escaped for security.\n", "header": [ { "key": "Intercom-Version", @@ -7089,24 +12846,42 @@ ] }, { - "name": "Emails", + "name": "Messages", "item": [ { - "name": "List all email settings", + "name": "Get statuses of all messages sent based on the specified ruleset_id", "tags": [ - "Emails" + "Messages", + "WhatsApp" ], "request": { "url": { - "raw": "https://api.intercom.io/emails", + "raw": "https://api.intercom.io/messages/status", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "emails" + "messages", + "status" + ], + "query": [ + { + "key": "ruleset_id", + "value": "ruleset_id", + "description": "The unique identifier for the set of messages to check status for" + }, + { + "key": "per_page", + "value": "per_page", + "description": "Number of results per page (default 50, max 100)" + }, + { + "key": "starting_after", + "value": "starting_after", + "description": "Cursor for pagination, used to fetch the next page of results" + } ], - "query": [], "variable": [] }, "auth": { @@ -7130,7 +12905,7 @@ ] }, "method": "GET", - "description": "Lists all sender email address settings for the workspace", + "description": "Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages.\n\n\nThis endpoint returns paginated status events for WhatsApp messages sent via the Outbound module, providing\ninformation about delivery state and related message details.\n", "header": [ { "key": "Intercom-Version", @@ -7146,30 +12921,31 @@ "response": [] }, { - "name": "Retrieve an email setting", + "name": "Retrieve WhatsApp message delivery status", "tags": [ - "Emails" + "Messages", + "WhatsApp" ], "request": { "url": { - "raw": "https://api.intercom.io/emails/{id}", + "raw": "https://api.intercom.io/messages/whatsapp/status", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "emails", - "{id}" + "messages", + "whatsapp", + "status" ], - "query": [], - "variable": [ + "query": [ { - "key": "id", - "value": "id", - "disabled": false, - "description": "The unique identifier of the email setting" + "key": "message_id", + "value": "message_id", + "description": "The WhatsApp message ID to check status for" } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -7192,7 +12968,7 @@ ] }, "method": "GET", - "description": "Fetches a specific email setting by its unique identifier", + "description": "Retrieves the delivery status of a specific WhatsApp message by its message ID.\n\n\nReturns the current status, conversation details, and any error information if the message failed to deliver.\n", "header": [ { "key": "Intercom-Version", @@ -7206,27 +12982,21 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Fin Agent", - "item": [ + }, { - "name": "Start a conversation with Fin", + "name": "Create a message", "tags": [ - "Fin Agent" + "Messages" ], "request": { "url": { - "raw": "https://api.intercom.io/fin/start", + "raw": "https://api.intercom.io/messages", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "fin", - "start" + "messages" ], "query": [], "variable": [] @@ -7252,7 +13022,7 @@ ] }, "method": "POST", - "description": "Initialize Fin by passing it the user's message along with conversation history and user details.\n\nThese additional pieces of context will be used by Fin to provide a better and more contextual answer to the user.\n\n{% admonition type=\"warning\" %}\nPlease reach out to your accounts team to discuss access.\n{% /admonition %}\n\nOnce Fin is initialized, it progresses through a series of statuses such as *thinking*, *replying*, *awaiting_user_reply*, or *resolved* before ending with a status of *complete*.\n\nDuring this workflow, the client should allow Fin to continue uninterrupted until a final *complete* status is returned, at which point control of the conversation passes back to the client.\n\nEvents can be received via webhooks or Server-Sent Events (SSE) using the `sse_subscription_url` in the response.\n", + "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message, an email, sms or whatsapp.\n\n> 🚧 Sending for visitors\n>\n> There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.\n\nThis will return the Message model that has been created.\n\n> 🚧 Retrieving Associated Conversations\n>\n> As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.\n", "header": [ { "key": "Intercom-Version", @@ -7269,28 +13039,33 @@ ], "body": { "mode": "raw", - "raw": "{\n \"conversation_id\": \"ext-123\",\n \"message\": {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n },\n \"user\": {\n \"id\": \"123456\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"attributes\": {\n \"plan_type\": \"Pro\",\n \"subscription_status\": \"active\"\n }\n },\n \"attachments\": [\n {\n \"type\": \"url\",\n \"url\": \"https://example.com/document.pdf\",\n \"name\": \"screenshot.png\",\n \"content_type\": \"image/png\",\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk...\"\n }\n ],\n \"conversation_metadata\": {\n \"history\": [\n {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n }\n ],\n \"attributes\": {\n \"priority_level\": \"high\",\n \"department\": \"sales\"\n }\n }\n}", + "raw": "{\n \"message_type\": \"in_app\",\n \"subject\": \"Thanks for everything\",\n \"body\": \"Hello there\",\n \"template\": \"plain\",\n \"from\": {\n \"type\": \"admin\",\n \"id\": 394051\n },\n \"to\": [\n {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n {\n \"type\": \"lead\",\n \"id\": \"536e564f316c83104c000021\"\n }\n ],\n \"cc\": [\n {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000023\"\n }\n ],\n \"bcc\": [\n {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000022\"\n }\n ],\n \"created_at\": 1590000000,\n \"create_conversation_without_contact_reply\": true\n}", "urlencoded": [], "formdata": [] } }, "response": [] - }, + } + ] + }, + { + "name": "News", + "item": [ { - "name": "Reply to Fin", + "name": "List all news items", "tags": [ - "Fin Agent" + "News" ], "request": { "url": { - "raw": "https://api.intercom.io/fin/reply", + "raw": "https://api.intercom.io/news/news_items", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "fin", - "reply" + "news", + "news_items" ], "query": [], "variable": [] @@ -7315,54 +13090,48 @@ } ] }, - "method": "POST", - "description": "Once Fin has returned a response to a user's message, its status will be `awaiting_user_reply`.\n\nIf a user replies, use this endpoint to send this response to Fin.\n\n{% admonition type=\"warning\" %}\nPlease reach out to your accounts team to discuss access.\n{% /admonition %}\n", + "method": "GET", + "description": "You can fetch a list of all news items", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"conversation_id\": \"123456\",\n \"message\": {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n },\n \"user\": {\n \"id\": \"123456\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"attributes\": {\n \"plan_type\": \"Pro\",\n \"subscription_status\": \"active\"\n }\n },\n \"attachments\": [\n {\n \"type\": \"url\",\n \"url\": \"https://example.com/document.pdf\",\n \"name\": \"screenshot.png\",\n \"content_type\": \"image/png\",\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk...\"\n }\n ]\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] - } - ] - }, - { - "name": "Help Center", - "item": [ + }, { - "name": "List all collections", + "name": "Retrieve a news item", "tags": [ - "Help Center" + "News" ], "request": { "url": { - "raw": "https://api.intercom.io/help_center/collections", + "raw": "https://api.intercom.io/news/news_items/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "help_center", - "collections" + "news", + "news_items", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } + ] }, "auth": { "type": "bearer", @@ -7385,7 +13154,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`.\n\nCollections will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.\n", + "description": "You can fetch the details of a single news item.", "header": [ { "key": "Intercom-Version", @@ -7401,21 +13170,22 @@ "response": [] }, { - "name": "Retrieve a collection", + "name": "List all live newsfeed items", "tags": [ - "Help Center" + "News" ], "request": { "url": { - "raw": "https://api.intercom.io/help_center/collections/{id}", + "raw": "https://api.intercom.io/news/newsfeeds/{id}/items", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "help_center", - "collections", - "{id}" + "news", + "newsfeeds", + "{id}", + "items" ], "query": [], "variable": [ @@ -7423,7 +13193,7 @@ "key": "id", "value": "123", "disabled": false, - "description": "The unique identifier for the collection which is given by Intercom." + "description": "The unique identifier for the news feed item which is given by Intercom." } ] }, @@ -7448,7 +13218,7 @@ ] }, "method": "GET", - "description": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", + "description": "You can fetch a list of all news items that are live on a given newsfeed", "header": [ { "key": "Intercom-Version", @@ -7464,31 +13234,23 @@ "response": [] }, { - "name": "Retrieve a Help Center", + "name": "List all newsfeeds", "tags": [ - "Help Center" + "News" ], "request": { "url": { - "raw": "https://api.intercom.io/help_center/help_centers/{id}", + "raw": "https://api.intercom.io/news/newsfeeds", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "help_center", - "help_centers", - "{id}" + "news", + "newsfeeds" ], "query": [], - "variable": [ - { - "key": "id", - "value": "123", - "disabled": false, - "description": "The unique identifier for the collection which is given by Intercom." - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -7511,7 +13273,7 @@ ] }, "method": "GET", - "description": "You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/`.", + "description": "You can fetch a list of all newsfeeds", "header": [ { "key": "Intercom-Version", @@ -7527,23 +13289,31 @@ "response": [] }, { - "name": "List all Help Centers", + "name": "Retrieve a newsfeed", "tags": [ - "Help Center" + "News" ], "request": { "url": { - "raw": "https://api.intercom.io/help_center/help_centers", + "raw": "https://api.intercom.io/news/newsfeeds/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "help_center", - "help_centers" + "news", + "newsfeeds", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } + ] }, "auth": { "type": "bearer", @@ -7566,7 +13336,7 @@ ] }, "method": "GET", - "description": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", + "description": "You can fetch the details of a single newsfeed", "header": [ { "key": "Intercom-Version", @@ -7582,20 +13352,20 @@ "response": [] }, { - "name": "Create a collection", + "name": "Create a news item", "tags": [ - "Help Center" + "News" ], "request": { "url": { - "raw": "https://api.intercom.io/help_center/collections", + "raw": "https://api.intercom.io/news/news_items", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "help_center", - "collections" + "news", + "news_items" ], "query": [], "variable": [] @@ -7621,7 +13391,7 @@ ] }, "method": "POST", - "description": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", + "description": "You can create a news item", "header": [ { "key": "Intercom-Version", @@ -7638,7 +13408,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"name\": \"collection 51\",\n \"description\": \"English description\",\n \"translated_content\": {\n \"type\": \"group_translated_content\",\n \"ar\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"bg\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"bs\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ca\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"cs\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"da\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"de\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"el\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"en\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"es\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"et\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"fi\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"fr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"he\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"hr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"hu\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"id\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"it\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ja\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ko\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"lt\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"lv\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"mn\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"nb\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"nl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pt\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ro\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ru\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sv\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"tr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"vi\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pt-BR\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"zh-CN\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"zh-TW\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n }\n },\n \"parent_id\": \"6871118\",\n \"help_center_id\": \"123\"\n}", + "raw": "{\n \"title\": \"Halloween is here!\",\n \"body\": \"

New costumes in store for this spooky season

\",\n \"sender_id\": 123,\n \"state\": \"live\",\n \"deliver_silently\": true,\n \"labels\": [\n \"Product\",\n \"Update\",\n \"New\"\n ],\n \"reactions\": [\n \"😆\",\n \"😅\"\n ],\n \"newsfeed_assignments\": [\n {\n \"newsfeed_id\": 198313,\n \"published_at\": 1674917488\n }\n ]\n}", "urlencoded": [], "formdata": [] } @@ -7646,20 +13416,20 @@ "response": [] }, { - "name": "Update a collection", + "name": "Update a news item", "tags": [ - "Help Center" + "News" ], "request": { "url": { - "raw": "https://api.intercom.io/help_center/collections/{id}", + "raw": "https://api.intercom.io/news/news_items/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "help_center", - "collections", + "news", + "news_items", "{id}" ], "query": [], @@ -7668,7 +13438,7 @@ "key": "id", "value": "123", "disabled": false, - "description": "The unique identifier for the collection which is given by Intercom." + "description": "The unique identifier for the news item which is given by Intercom." } ] }, @@ -7693,7 +13463,6 @@ ] }, "method": "PUT", - "description": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", "header": [ { "key": "Intercom-Version", @@ -7710,7 +13479,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"name\": \"collection 51\",\n \"description\": \"English description\",\n \"translated_content\": {\n \"type\": \"group_translated_content\",\n \"ar\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"bg\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"bs\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ca\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"cs\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"da\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"de\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"el\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"en\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"es\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"et\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"fi\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"fr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"he\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"hr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"hu\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"id\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"it\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ja\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ko\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"lt\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"lv\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"mn\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"nb\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"nl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pt\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ro\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ru\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sv\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"tr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"vi\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pt-BR\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"zh-CN\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"zh-TW\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n }\n },\n \"parent_id\": \"6871118\"\n}", + "raw": "{\n \"title\": \"Halloween is here!\",\n \"body\": \"

New costumes in store for this spooky season

\",\n \"sender_id\": 123,\n \"state\": \"live\",\n \"deliver_silently\": true,\n \"labels\": [\n \"Product\",\n \"Update\",\n \"New\"\n ],\n \"reactions\": [\n \"😆\",\n \"😅\"\n ],\n \"newsfeed_assignments\": [\n {\n \"newsfeed_id\": 198313,\n \"published_at\": 1674917488\n }\n ]\n}", "urlencoded": [], "formdata": [] } @@ -7718,20 +13487,20 @@ "response": [] }, { - "name": "Delete a collection", + "name": "Delete a news item", "tags": [ - "Help Center" + "News" ], "request": { "url": { - "raw": "https://api.intercom.io/help_center/collections/{id}", + "raw": "https://api.intercom.io/news/news_items/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "help_center", - "collections", + "news", + "news_items", "{id}" ], "query": [], @@ -7740,7 +13509,7 @@ "key": "id", "value": "123", "disabled": false, - "description": "The unique identifier for the collection which is given by Intercom." + "description": "The unique identifier for the news item which is given by Intercom." } ] }, @@ -7765,7 +13534,7 @@ ] }, "method": "DELETE", - "description": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", + "description": "You can delete a single news item.", "header": [ { "key": "Intercom-Version", @@ -7783,25 +13552,35 @@ ] }, { - "name": "Internal Articles", + "name": "Notes", "item": [ { - "name": "List all articles", + "name": "List all company notes", "tags": [ - "Internal Articles" + "Notes", + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/internal_articles", + "raw": "https://api.intercom.io/companies/{company_id}/notes", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "internal_articles" + "companies", + "{company_id}", + "notes" ], "query": [], - "variable": [] + "variable": [ + { + "key": "company_id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } + ] }, "auth": { "type": "bearer", @@ -7824,7 +13603,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of all internal articles by making a GET request to `https://api.intercom.io/internal_articles`.", + "description": "You can fetch a list of notes that are associated to a company.", "header": [ { "key": "Intercom-Version", @@ -7840,28 +13619,30 @@ "response": [] }, { - "name": "Retrieve an internal article", + "name": "List all contact notes", "tags": [ - "Internal Articles" + "Notes", + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/internal_articles/{id}", + "raw": "https://api.intercom.io/contacts/{id}/notes", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "internal_articles", - "{id}" + "contacts", + "{id}", + "notes" ], "query": [], "variable": [ { "key": "id", - "value": "123", + "value": "id", "disabled": false, - "description": "The unique identifier for the article which is given by Intercom." + "description": "The unique identifier of a contact." } ] }, @@ -7886,7 +13667,7 @@ ] }, "method": "GET", - "description": "You can fetch the details of a single internal article by making a GET request to `https://api.intercom.io/internal_articles/`.", + "description": "You can fetch a list of notes that are associated to a contact.", "header": [ { "key": "Intercom-Version", @@ -7902,29 +13683,30 @@ "response": [] }, { - "name": "Search for internal articles", + "name": "Retrieve a note", "tags": [ - "Internal Articles" + "Notes" ], "request": { "url": { - "raw": "https://api.intercom.io/internal_articles/search", + "raw": "https://api.intercom.io/notes/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "internal_articles", - "search" + "notes", + "{id}" ], - "query": [ + "query": [], + "variable": [ { - "key": "folder_id", - "value": "123", - "description": "The ID of the folder to search in. Results will include articles from this folder and all its descendant folders." + "key": "id", + "value": "1", + "disabled": false, + "description": "The unique identifier of a given note" } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -7947,7 +13729,7 @@ ] }, "method": "GET", - "description": "You can search for internal articles by making a GET request to `https://api.intercom.io/internal_articles/search`.", + "description": "You can fetch the details of a single note.", "header": [ { "key": "Intercom-Version", @@ -7963,91 +13745,30 @@ "response": [] }, { - "name": "Create an internal article", - "tags": [ - "Internal Articles" - ], - "request": { - "url": { - "raw": "https://api.intercom.io/internal_articles", - "protocol": "https", - "host": [ - "api.intercom.io" - ], - "path": [ - "internal_articles" - ], - "query": [], - "variable": [] - }, - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "bearerToken", - "value": "{{bearerToken}}", - "type": "string" - }, - { - "key": "tokenType", - "value": "bearer", - "type": "string" - }, - { - "key": "addTokenTo", - "value": "header", - "type": "string" - } - ] - }, - "method": "POST", - "description": "You can create a new internal article by making a POST request to `https://api.intercom.io/internal_articles`.", - "header": [ - { - "key": "Intercom-Version", - "value": "Preview" - }, - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Thanks for everything\",\n \"body\": \"

This is the body in html

\",\n \"author_id\": 1295,\n \"owner_id\": 1295,\n \"folder_id\": 6\n}", - "urlencoded": [], - "formdata": [] - } - }, - "response": [] - }, - { - "name": "Update an internal article", + "name": "Create a company note", "tags": [ - "Internal Articles" + "Notes", + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/internal_articles/{id}", + "raw": "https://api.intercom.io/companies/{company_id}/notes", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "internal_articles", - "{id}" + "companies", + "{company_id}", + "notes" ], "query": [], "variable": [ { - "key": "id", - "value": "123", + "key": "company_id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", "disabled": false, - "description": "The unique identifier for the internal article which is given by Intercom." + "description": "The unique identifier for the company which is given by Intercom" } ] }, @@ -8071,8 +13792,8 @@ } ] }, - "method": "PUT", - "description": "You can update the details of a single internal article by making a PUT request to `https://api.intercom.io/internal_articles/`.", + "method": "POST", + "description": "You can add a note to a single company.", "header": [ { "key": "Intercom-Version", @@ -8089,7 +13810,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"title\": \"Thanks for everything\",\n \"body\": \"\",\n \"author_id\": 1295,\n \"owner_id\": 1295,\n \"folder_id\": 6\n}", + "raw": "{\n \"body\": \"New note\",\n \"admin_id\": \"991267583\"\n}", "urlencoded": [], "formdata": [] } @@ -8097,20 +13818,22 @@ "response": [] }, { - "name": "Delete an internal article", + "name": "Create a note", "tags": [ - "Internal Articles" + "Notes", + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/internal_articles/{id}", + "raw": "https://api.intercom.io/contacts/{id}/notes", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "internal_articles", - "{id}" + "contacts", + "{id}", + "notes" ], "query": [], "variable": [ @@ -8118,7 +13841,7 @@ "key": "id", "value": "123", "disabled": false, - "description": "The unique identifier for the internal article which is given by Intercom." + "description": "The unique identifier of a given contact." } ] }, @@ -8142,51 +13865,54 @@ } ] }, - "method": "DELETE", - "description": "You can delete a single internal article by making a DELETE request to `https://api.intercom.io/internal_articles/`.", + "method": "POST", + "description": "You can add a note to a single contact.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"body\": \"New note\",\n \"contact_id\": \"123\",\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - } - ] - }, - { - "name": "Jobs", - "item": [ + }, { - "name": "Retrieve job status", + "name": "Delete a note", "tags": [ - "Jobs" + "Notes" ], "request": { "url": { - "raw": "https://api.intercom.io/jobs/status/{id}", + "raw": "https://api.intercom.io/notes/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "jobs", - "status", + "notes", "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "id", + "value": "1", "disabled": false, - "description": "The unique identifier for the job which is given by Intercom" + "description": "The unique identifier of a given note" } ] }, @@ -8210,8 +13936,8 @@ } ] }, - "method": "GET", - "description": "Retrieve the status of job execution.", + "method": "DELETE", + "description": "You can delete a single contact or company note. Notes of other kinds cannot be deleted through the API.", "header": [ { "key": "Intercom-Version", @@ -8229,40 +13955,24 @@ ] }, { - "name": "Macros", + "name": "Office Hours", "item": [ { - "name": "List all macros", + "name": "List all office hours schedules", "tags": [ - "Macros" + "Office Hours" ], "request": { "url": { - "raw": "https://api.intercom.io/macros", + "raw": "https://api.intercom.io/office_hours_schedules", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "macros" - ], - "query": [ - { - "key": "per_page", - "value": "50", - "description": "The number of results per page" - }, - { - "key": "starting_after", - "value": "WzE3MTk0OTM3NTcuMCwgIjEyMyJd", - "description": "Base64-encoded cursor containing [updated_at, id] for pagination" - }, - { - "key": "updated_since", - "value": "1719474966", - "description": "Unix timestamp to filter macros updated after this time" - } + "office_hours_schedules" ], + "query": [], "variable": [] }, "auth": { @@ -8286,7 +13996,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of all macros (saved replies) in your workspace for use in automating responses.\n\nThe macros are returned in descending order by updated_at.\n\n**Pagination**\n\nThis endpoint uses cursor-based pagination via the `starting_after` parameter. The cursor is a Base64-encoded JSON array containing `[updated_at, id]` of the last item from the previous page.\n\n**Placeholder Transformation**\n\nThe API transforms Intercom placeholders to a more standard XML-like format:\n- From: `{{user.name | fallback: 'there'}}`\n- To: ``\n", + "description": "You can fetch a list of all office hours schedules for the workspace.", "header": [ { "key": "Intercom-Version", @@ -8302,19 +14012,19 @@ "response": [] }, { - "name": "Retrieve a macro", + "name": "Retrieve an office hours schedule", "tags": [ - "Macros" + "Office Hours" ], "request": { "url": { - "raw": "https://api.intercom.io/macros/{id}", + "raw": "https://api.intercom.io/office_hours_schedules/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "macros", + "office_hours_schedules", "{id}" ], "query": [], @@ -8323,7 +14033,7 @@ "key": "id", "value": "123", "disabled": false, - "description": "The unique identifier of the macro" + "description": "The unique identifier for the office hours schedule." } ] }, @@ -8348,7 +14058,7 @@ ] }, "method": "GET", - "description": "You can fetch a single macro (saved reply) by its ID. The macro will only be returned if it is visible to the authenticated user based on its visibility settings.\n\n**Visibility Rules**\n\nA macro is returned based on its `visible_to` setting:\n- `everyone`: Always visible to all team members\n- `specific_teams`: Only visible if the authenticated user belongs to one of the teams specified in `visible_to_team_ids`\n\nIf a macro exists but is not visible to the authenticated user, a 404 error is returned.\n\n**Placeholder Transformation**\n\nThe API transforms Intercom placeholders to a more standard XML-like format in the `body` field:\n- From: `{{user.name | fallback: 'there'}}`\n- To: ``\n\nDefault values in placeholders are HTML-escaped for security.\n", + "description": "You can fetch the details of a single office hours schedule.", "header": [ { "key": "Intercom-Version", @@ -8362,47 +14072,33 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Messages", - "item": [ + }, { - "name": "Get statuses of all messages sent based on the specified ruleset_id", + "name": "List all office hours exceptions", "tags": [ - "Messages", - "WhatsApp" + "Office Hours" ], "request": { "url": { - "raw": "https://api.intercom.io/messages/status", + "raw": "https://api.intercom.io/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "messages", - "status" + "office_hours_schedules", + "{office_hours_schedule_id}", + "office_hours_exceptions" ], - "query": [ - { - "key": "ruleset_id", - "value": "ruleset_id", - "description": "The unique identifier for the set of messages to check status for" - }, - { - "key": "per_page", - "value": "per_page", - "description": "Number of results per page (default 50, max 100)" - }, + "query": [], + "variable": [ { - "key": "starting_after", - "value": "starting_after", - "description": "Cursor for pagination, used to fetch the next page of results" + "key": "office_hours_schedule_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the office hours schedule." } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -8425,7 +14121,7 @@ ] }, "method": "GET", - "description": "Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages.\n\n\nThis endpoint returns paginated status events for WhatsApp messages sent via the Outbound module, providing\ninformation about delivery state and related message details.\n", + "description": "You can fetch a list of all exceptions for an office hours schedule.", "header": [ { "key": "Intercom-Version", @@ -8441,31 +14137,38 @@ "response": [] }, { - "name": "Retrieve WhatsApp message delivery status", + "name": "Retrieve an office hours exception", "tags": [ - "Messages", - "WhatsApp" + "Office Hours" ], "request": { "url": { - "raw": "https://api.intercom.io/messages/whatsapp/status", + "raw": "https://api.intercom.io/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "messages", - "whatsapp", - "status" + "office_hours_schedules", + "{office_hours_schedule_id}", + "office_hours_exceptions", + "{id}" ], - "query": [ + "query": [], + "variable": [ { - "key": "message_id", - "value": "message_id", - "description": "The WhatsApp message ID to check status for" + "key": "office_hours_schedule_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the office hours schedule." + }, + { + "key": "id", + "value": "456", + "disabled": false, + "description": "The unique identifier for the office hours exception." } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -8488,7 +14191,7 @@ ] }, "method": "GET", - "description": "Retrieves the delivery status of a specific WhatsApp message by its message ID.\n\n\nReturns the current status, conversation details, and any error information if the message failed to deliver.\n", + "description": "You can fetch the details of a single office hours exception.", "header": [ { "key": "Intercom-Version", @@ -8504,19 +14207,19 @@ "response": [] }, { - "name": "Create a message", + "name": "Create an office hours schedule", "tags": [ - "Messages" + "Office Hours" ], "request": { "url": { - "raw": "https://api.intercom.io/messages", + "raw": "https://api.intercom.io/office_hours_schedules", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "messages" + "office_hours_schedules" ], "query": [], "variable": [] @@ -8542,7 +14245,7 @@ ] }, "method": "POST", - "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message, an email, sms or whatsapp.\n\n> 🚧 Sending for visitors\n>\n> There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.\n\nThis will return the Message model that has been created.\n\n> 🚧 Retrieving Associated Conversations\n>\n> As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.\n", + "description": "You can create a new office hours schedule for the workspace.", "header": [ { "key": "Intercom-Version", @@ -8559,36 +14262,39 @@ ], "body": { "mode": "raw", - "raw": "{\n \"message_type\": \"in_app\",\n \"subject\": \"Thanks for everything\",\n \"body\": \"Hello there\",\n \"template\": \"plain\",\n \"from\": {\n \"type\": \"admin\",\n \"id\": 394051\n },\n \"to\": [\n {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n {\n \"type\": \"lead\",\n \"id\": \"536e564f316c83104c000021\"\n }\n ],\n \"cc\": [\n {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000023\"\n }\n ],\n \"bcc\": [\n {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000022\"\n }\n ],\n \"created_at\": 1590000000,\n \"create_conversation_without_contact_reply\": true\n}", + "raw": "{\n \"name\": \"Standard Support Hours\",\n \"time_zone_name\": \"America/New_York\",\n \"time_intervals\": [\n {\n \"start_minute\": 540,\n \"end_minute\": 1020,\n \"day_of_week\": 0\n }\n ]\n}", "urlencoded": [], "formdata": [] } }, "response": [] - } - ] - }, - { - "name": "News", - "item": [ + }, { - "name": "List all news items", + "name": "Create an office hours exception", "tags": [ - "News" + "Office Hours" ], "request": { "url": { - "raw": "https://api.intercom.io/news/news_items", + "raw": "https://api.intercom.io/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "news", - "news_items" + "office_hours_schedules", + "{office_hours_schedule_id}", + "office_hours_exceptions" ], "query": [], - "variable": [] + "variable": [ + { + "key": "office_hours_schedule_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the office hours schedule." + } + ] }, "auth": { "type": "bearer", @@ -8610,37 +14316,45 @@ } ] }, - "method": "GET", - "description": "You can fetch a list of all news items", + "method": "POST", + "description": "You can create an exception for an office hours schedule. Use `closed` to mark the day closed (omit `time_intervals`) or `custom_hours` to supply replacement intervals.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"exception_date\": \"2026-12-25\",\n \"exception_type\": \"closed\",\n \"name\": \"Christmas Day\",\n \"time_intervals\": [\n {\n \"start_minute\": 540,\n \"end_minute\": 1020,\n \"day_of_week\": 0\n }\n ],\n \"recurring_annually\": true\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a news item", + "name": "Update an office hours schedule", "tags": [ - "News" + "Office Hours" ], "request": { "url": { - "raw": "https://api.intercom.io/news/news_items/{id}", + "raw": "https://api.intercom.io/office_hours_schedules/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "news", - "news_items", + "office_hours_schedules", "{id}" ], "query": [], @@ -8649,7 +14363,7 @@ "key": "id", "value": "123", "disabled": false, - "description": "The unique identifier for the news item which is given by Intercom." + "description": "The unique identifier for the office hours schedule." } ] }, @@ -8673,47 +14387,62 @@ } ] }, - "method": "GET", - "description": "You can fetch the details of a single news item.", + "method": "PUT", + "description": "You can update an existing office hours schedule.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Extended Support Hours\",\n \"time_zone_name\": \"America/New_York\",\n \"time_intervals\": [\n {\n \"start_minute\": 540,\n \"end_minute\": 1020,\n \"day_of_week\": 0\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all live newsfeed items", + "name": "Update an office hours exception", "tags": [ - "News" + "Office Hours" ], "request": { "url": { - "raw": "https://api.intercom.io/news/newsfeeds/{id}/items", + "raw": "https://api.intercom.io/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "news", - "newsfeeds", - "{id}", - "items" + "office_hours_schedules", + "{office_hours_schedule_id}", + "office_hours_exceptions", + "{id}" ], "query": [], "variable": [ { - "key": "id", + "key": "office_hours_schedule_id", "value": "123", "disabled": false, - "description": "The unique identifier for the news feed item which is given by Intercom." + "description": "The unique identifier for the office hours schedule." + }, + { + "key": "id", + "value": "456", + "disabled": false, + "description": "The unique identifier for the office hours exception." } ] }, @@ -8737,92 +14466,45 @@ } ] }, - "method": "GET", - "description": "You can fetch a list of all news items that are live on a given newsfeed", + "method": "PUT", + "description": "You can update an existing office hours exception.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" - } - ], - "body": null - }, - "response": [] - }, - { - "name": "List all newsfeeds", - "tags": [ - "News" - ], - "request": { - "url": { - "raw": "https://api.intercom.io/news/newsfeeds", - "protocol": "https", - "host": [ - "api.intercom.io" - ], - "path": [ - "news", - "newsfeeds" - ], - "query": [], - "variable": [] - }, - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "bearerToken", - "value": "{{bearerToken}}", - "type": "string" - }, - { - "key": "tokenType", - "value": "bearer", - "type": "string" - }, - { - "key": "addTokenTo", - "value": "header", - "type": "string" - } - ] - }, - "method": "GET", - "description": "You can fetch a list of all newsfeeds", - "header": [ - { - "key": "Intercom-Version", - "value": "Preview" }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"exception_date\": \"2026-12-25\",\n \"exception_type\": \"custom_hours\",\n \"name\": \"Christmas Day (reduced hours)\",\n \"time_intervals\": [\n {\n \"start_minute\": 540,\n \"end_minute\": 1020,\n \"day_of_week\": 0\n }\n ],\n \"recurring_annually\": true\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a newsfeed", + "name": "Delete an office hours schedule", "tags": [ - "News" + "Office Hours" ], "request": { "url": { - "raw": "https://api.intercom.io/news/newsfeeds/{id}", + "raw": "https://api.intercom.io/office_hours_schedules/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "news", - "newsfeeds", + "office_hours_schedules", "{id}" ], "query": [], @@ -8831,7 +14513,7 @@ "key": "id", "value": "123", "disabled": false, - "description": "The unique identifier for the news feed item which is given by Intercom." + "description": "The unique identifier for the office hours schedule." } ] }, @@ -8855,8 +14537,8 @@ } ] }, - "method": "GET", - "description": "You can fetch the details of a single newsfeed", + "method": "DELETE", + "description": "You can delete a single office hours schedule.", "header": [ { "key": "Intercom-Version", @@ -8872,23 +14554,38 @@ "response": [] }, { - "name": "Create a news item", + "name": "Delete an office hours exception", "tags": [ - "News" + "Office Hours" ], "request": { "url": { - "raw": "https://api.intercom.io/news/news_items", + "raw": "https://api.intercom.io/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "news", - "news_items" + "office_hours_schedules", + "{office_hours_schedule_id}", + "office_hours_exceptions", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "office_hours_schedule_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the office hours schedule." + }, + { + "key": "id", + "value": "456", + "disabled": false, + "description": "The unique identifier for the office hours exception." + } + ] }, "auth": { "type": "bearer", @@ -8910,55 +14607,51 @@ } ] }, - "method": "POST", - "description": "You can create a news item", + "method": "DELETE", + "description": "You can delete a single office hours exception.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Halloween is here!\",\n \"body\": \"

New costumes in store for this spooky season

\",\n \"sender_id\": 123,\n \"state\": \"live\",\n \"deliver_silently\": true,\n \"labels\": [\n \"Product\",\n \"Update\",\n \"New\"\n ],\n \"reactions\": [\n \"😆\",\n \"😅\"\n ],\n \"newsfeed_assignments\": [\n {\n \"newsfeed_id\": 198313,\n \"published_at\": 1674917488\n }\n ]\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Procedures", + "item": [ { - "name": "Update a news item", + "name": "Submit human input to a Fin Procedure HITL step", "tags": [ - "News" + "Procedures" ], "request": { "url": { - "raw": "https://api.intercom.io/news/news_items/{id}", + "raw": "https://api.intercom.io/procedures/{conversation_id}/collect_agent_input", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "news", - "news_items", - "{id}" + "procedures", + "{conversation_id}", + "collect_agent_input" ], "query": [], "variable": [ { - "key": "id", - "value": "123", + "key": "conversation_id", + "value": "215473853299345", "disabled": false, - "description": "The unique identifier for the news item which is given by Intercom." + "description": "The ID of the conversation where the HITL step was triggered." } ] }, @@ -8982,7 +14675,8 @@ } ] }, - "method": "PUT", + "method": "POST", + "description": "Submit human-collected input to a Fin Procedure that is paused at a Human in the Loop (HITL) step.\n\nWhen a procedure reaches a HITL step with the API channel enabled, Intercom sends a `procedure.hitl_notification.created` webhook. Use the `callback_url` from that webhook payload to call this endpoint with the collected attribute values.\n\nThe `step_id` must match the one from the webhook payload, and `attribute_values` must include a value for every attribute listed in `attributes_to_collect`.\n\n{% admonition type=\"info\" name=\"Authentication\" %}\nThis endpoint requires an OAuth token with the `write_conversations` scope. The admin associated with the token must have access to the conversation.\n{% /admonition %}\n\n{% admonition type=\"warning\" name=\"Feature access\" %}\nThis endpoint requires the Procedures HITL API feature to be enabled for your workspace.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", @@ -8999,39 +14693,52 @@ ], "body": { "mode": "raw", - "raw": "{\n \"title\": \"Halloween is here!\",\n \"body\": \"

New costumes in store for this spooky season

\",\n \"sender_id\": 123,\n \"state\": \"live\",\n \"deliver_silently\": true,\n \"labels\": [\n \"Product\",\n \"Update\",\n \"New\"\n ],\n \"reactions\": [\n \"😆\",\n \"😅\"\n ],\n \"newsfeed_assignments\": [\n {\n \"newsfeed_id\": 198313,\n \"published_at\": 1674917488\n }\n ]\n}", + "raw": "{\n \"step_id\": \"d5b81f72-adb9-4317-b973-75b3c3624c09\",\n \"attribute_values\": [\n {\n \"identifier\": \"workflow_local_variables.72c5a6b3-3cce-41d8-8e30-14da40791958\",\n \"value\": true\n }\n ]\n}", "urlencoded": [], "formdata": [] } }, "response": [] - }, + } + ] + }, + { + "name": "Reporting Data Export", + "item": [ { - "name": "Delete a news item", + "name": "Get export job status", "tags": [ - "News" + "Reporting Data Export" ], "request": { "url": { - "raw": "https://api.intercom.io/news/news_items/{id}", + "raw": "https://api.intercom.io/export/reporting_data/{job_identifier}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "news", - "news_items", - "{id}" + "export", + "reporting_data", + "{job_identifier}" ], - "query": [], - "variable": [ + "query": [ { - "key": "id", - "value": "123", - "disabled": false, - "description": "The unique identifier for the news item which is given by Intercom." + "key": "app_id", + "value": "app_id", + "description": "The Intercom defined code of the workspace the company is associated to." + }, + { + "key": "client_id", + "value": "client_id" + }, + { + "key": "job_identifier", + "value": "job_identifier", + "description": "Unique identifier of the job." } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -9053,8 +14760,7 @@ } ] }, - "method": "DELETE", - "description": "You can delete a single news item.", + "method": "GET", "header": [ { "key": "Intercom-Version", @@ -9068,39 +14774,26 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Notes", - "item": [ + }, { - "name": "List all company notes", + "name": "List available datasets and attributes", "tags": [ - "Notes", - "Companies" + "Reporting Data Export" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{company_id}/notes", + "raw": "https://api.intercom.io/export/reporting_data/get_datasets", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", - "{company_id}", - "notes" + "export", + "reporting_data", + "get_datasets" ], "query": [], - "variable": [ - { - "key": "company_id", - "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", - "disabled": false, - "description": "The unique identifier for the company which is given by Intercom" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -9123,7 +14816,6 @@ ] }, "method": "GET", - "description": "You can fetch a list of notes that are associated to a company.", "header": [ { "key": "Intercom-Version", @@ -9139,32 +14831,33 @@ "response": [] }, { - "name": "List all contact notes", + "name": "Download completed export job data", "tags": [ - "Notes", - "Contacts" + "Reporting Data Export" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/notes", + "raw": "https://api.intercom.io/download/reporting_data/{job_identifier}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{id}", - "notes" + "download", + "reporting_data", + "{job_identifier}" ], - "query": [], - "variable": [ + "query": [ { - "key": "id", - "value": "id", - "disabled": false, - "description": "The unique identifier of a contact." + "key": "app_id", + "value": "app_id" + }, + { + "key": "job_identifier", + "value": "job_identifier" } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -9187,12 +14880,17 @@ ] }, "method": "GET", - "description": "You can fetch a list of notes that are associated to a contact.", + "description": "Download the data from a completed reporting data export job.\n\n> Octet header required\n>\n> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Accept", + "value": "Accept", + "description": "Required header for downloading the export file" + }, { "key": "Accept", "value": "application/json" @@ -9203,30 +14901,24 @@ "response": [] }, { - "name": "Retrieve a note", + "name": "Enqueue a new reporting data export job", "tags": [ - "Notes" + "Reporting Data Export" ], "request": { "url": { - "raw": "https://api.intercom.io/notes/{id}", + "raw": "https://api.intercom.io/export/reporting_data/enqueue", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "notes", - "{id}" + "export", + "reporting_data", + "enqueue" ], "query": [], - "variable": [ - { - "key": "id", - "value": "1", - "disabled": false, - "description": "The unique identifier of a given note" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -9248,49 +14940,53 @@ } ] }, - "method": "GET", - "description": "You can fetch the details of a single note.", + "method": "POST", + "description": "For the **conversation** dataset, from the Preview version this export returns all conversations, including those that never received a user reply. Earlier versions return only conversations that received at least one user reply. Other datasets are unaffected.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"dataset_id\": \"conversation\",\n \"attribute_ids\": [\n \"conversation_id\",\n \"conversation_started_at\"\n ],\n \"start_time\": 1717490000,\n \"end_time\": 1717510000\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Roles", + "item": [ { - "name": "Create a company note", + "name": "List all roles", "tags": [ - "Notes", - "Companies" + "Roles" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{company_id}/notes", + "raw": "https://api.intercom.io/roles", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", - "{company_id}", - "notes" + "roles" ], "query": [], - "variable": [ - { - "key": "company_id", - "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", - "disabled": false, - "description": "The unique identifier for the company which is given by Intercom" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -9312,56 +15008,45 @@ } ] }, - "method": "POST", - "description": "You can add a note to a single company.", + "method": "GET", + "description": "You can fetch a list of all roles in the workspace.\n\nRoles define what a teammate can do in a workspace. The teammates endpoint\nreturns the role a teammate holds, but only the roles that are currently\nassigned, and only their id and name. This endpoint lists every role in the\nworkspace, each with its description.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"body\": \"New note\",\n \"admin_id\": \"991267583\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Create a note", + "name": "Retrieve a role", "tags": [ - "Notes", - "Contacts" + "Roles" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/notes", + "raw": "https://api.intercom.io/roles/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{id}", - "notes" + "roles", + "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "123", + "value": "991267902", "disabled": false, - "description": "The unique identifier of a given contact." + "description": "The unique identifier of a given role." } ] }, @@ -9385,28 +15070,19 @@ } ] }, - "method": "POST", - "description": "You can add a note to a single contact.", + "method": "GET", + "description": "You can fetch the details of a single role by its id, including its\ndescription, which the teammates endpoint does not return.\n", "header": [ - { - "key": "Intercom-Version", - "value": "Preview" - }, - { - "key": "Content-Type", - "value": "application/json" + { + "key": "Intercom-Version", + "value": "Preview" }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"body\": \"New note\",\n \"contact_id\": \"123\",\n \"admin_id\": \"123\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] } @@ -10693,6 +16369,77 @@ "body": null }, "response": [] + }, + { + "name": "Update a team's members", + "tags": [ + "Teams" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/teams/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "teams", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given team." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "You can replace the set of teammates who belong to a team. Send the full list of\nteammates the team should end up with — any teammate currently on the team and\nmissing from the list is removed. This makes the endpoint safe to call on a\nschedule to keep Intercom in step with an external rota or workforce management\nsystem, since sending an unchanged list makes no changes at all.\n\nA token that acts on behalf of a teammate carries that teammate's permissions:\nthey must be able to manage teams, and any team or teammate their access is\nrestricted from remains out of reach here.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_ids\": [\n 493881,\n 493882\n ],\n \"admin_priority_level\": {\n \"primary_admin_ids\": [\n 493881\n ],\n \"secondary_admin_ids\": [\n 493882\n ]\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] } ] }, @@ -11295,134 +17042,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"message_type\": \"comment\",\n \"type\": \"admin\",\n \"body\": \"Hello there!\",\n \"created_at\": 1590000000,\n \"attachment_urls\": \"\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"admin_id\": \"3156780\",\n \"cross_post\": true\n}", - "urlencoded": [], - "formdata": [] - } - }, - "response": [] - }, - { - "name": "Create a ticket", - "tags": [ - "Tickets" - ], - "request": { - "url": { - "raw": "https://api.intercom.io/tickets", - "protocol": "https", - "host": [ - "api.intercom.io" - ], - "path": [ - "tickets" - ], - "query": [], - "variable": [] - }, - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "bearerToken", - "value": "{{bearerToken}}", - "type": "string" - }, - { - "key": "tokenType", - "value": "bearer", - "type": "string" - }, - { - "key": "addTokenTo", - "value": "header", - "type": "string" - } - ] - }, - "method": "POST", - "description": "You can create a new ticket.", - "header": [ - { - "key": "Intercom-Version", - "value": "Preview" - }, - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ticket_type_id\": \"1234\",\n \"contacts\": [\n {\n \"id\": \"1234\"\n }\n ],\n \"conversation_to_link_id\": \"1234\",\n \"company_id\": \"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632\",\n \"created_at\": 1590000000,\n \"ticket_attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n },\n \"assignment\": {\n \"admin_assignee_id\": \"123\",\n \"team_assignee_id\": \"8\"\n }\n}", - "urlencoded": [], - "formdata": [] - } - }, - "response": [] - }, - { - "name": "Enqueue create ticket", - "tags": [ - "Tickets" - ], - "request": { - "url": { - "raw": "https://api.intercom.io/tickets/enqueue", - "protocol": "https", - "host": [ - "api.intercom.io" - ], - "path": [ - "tickets", - "enqueue" - ], - "query": [], - "variable": [] - }, - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "bearerToken", - "value": "{{bearerToken}}", - "type": "string" - }, - { - "key": "tokenType", - "value": "bearer", - "type": "string" - }, - { - "key": "addTokenTo", - "value": "header", - "type": "string" - } - ] - }, - "method": "POST", - "description": "Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job.", - "header": [ - { - "key": "Intercom-Version", - "value": "Preview" - }, - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"ticket_type_id\": \"1234\",\n \"contacts\": [\n {\n \"id\": \"1234\"\n }\n ],\n \"conversation_to_link_id\": \"1234\",\n \"company_id\": \"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632\",\n \"created_at\": 1590000000,\n \"ticket_attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n },\n \"assignment\": {\n \"admin_assignee_id\": \"123\",\n \"team_assignee_id\": \"8\"\n }\n}", + "raw": "{\n \"message_type\": \"comment\",\n \"type\": \"admin\",\n \"body\": \"Hello there!\",\n \"created_at\": 1590000000,\n \"attachment_urls\": [],\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"admin_id\": \"3156780\",\n \"attachment_files\": [\n {\n \"content_type\": \"application/json\",\n \"data\": \"ewogICJ0ZXN0IjogMQp9\",\n \"name\": \"test.json\"\n }\n ],\n \"cross_post\": true\n}", "urlencoded": [], "formdata": [] } @@ -11430,13 +17050,13 @@ "response": [] }, { - "name": "Change ticket type", + "name": "Link a conversation to a ticket", "tags": [ "Tickets" ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/{ticket_id}/change_type", + "raw": "https://api.intercom.io/tickets/{ticket_id}/linked_conversations", "protocol": "https", "host": [ "api.intercom.io" @@ -11444,15 +17064,15 @@ "path": [ "tickets", "{ticket_id}", - "change_type" + "linked_conversations" ], "query": [], "variable": [ { "key": "ticket_id", - "value": "ticket_id", + "value": "64619700005694", "disabled": false, - "description": "The unique identifier for the ticket which is given by Intercom." + "description": "The unique identifier for the tracker ticket which is given by Intercom." } ] }, @@ -11477,7 +17097,7 @@ ] }, "method": "POST", - "description": "You can change the type of a ticket. The new ticket type must be in the same category as the current type. Attributes matching by name and type are automatically transferred from the old type; values provided in ticket_attributes override transferred values.", + "description": "Link a conversation to an existing tracker ticket. The conversation can be\na regular conversation or one that has been converted into a customer ticket.\n\nUse this when related conversations surface after a tracker ticket has\nalready been created. The ticket in the path must be a tracker ticket, and\n`conversation_id` in the body is the conversation (or customer ticket) to\nlink to it. This returns the linked conversation.\n\nA tracker ticket can have up to 2,500 linked conversations; once that\nlimit is reached, further requests return `linked_conversation_limit_exceeded`.\n\nRequires the `write_tickets` OAuth scope.\n", "header": [ { "key": "Intercom-Version", @@ -11494,7 +17114,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"ticket_type_id\": \"1234\",\n \"ticket_state_id\": \"5678\",\n \"ticket_attributes\": {\n \"_default_title_\": \"example\",\n \"_default_description_\": \"having a problem\"\n }\n}", + "raw": "{\n \"conversation_id\": \"204\"\n}", "urlencoded": [], "formdata": [] } @@ -11502,20 +17122,19 @@ "response": [] }, { - "name": "Search tickets", + "name": "Create a ticket", "tags": [ "Tickets" ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/search", + "raw": "https://api.intercom.io/tickets", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "tickets", - "search" + "tickets" ], "query": [], "variable": [] @@ -11541,7 +17160,7 @@ ] }, "method": "POST", - "description": "You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`.\n\nThis will accept a query object in the body which will define your filters.\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiples there can be:\n- There's a limit of max 2 nested filters\n- There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foobar\"`).\nThe `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `\"I need support\"` body - the query should contain a `=` operator with the value `\"support\"` for such conversation to be returned. A query with a `=` operator and a `\"need support\"` value will not yield a result.\n\n| Field | Type |\n| :---------------------------------------- | :--------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| title | String |\n| description | String |\n| category | String |\n| ticket_type_id | String |\n| contact_ids | String |\n| teammate_ids | String |\n| admin_assignee_id | String |\n| team_assignee_id | String |\n| open | Boolean |\n| state | String |\n| snoozed_until | Date (UNIX timestamp) |\n| ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |\n\n{% admonition type=\"info\" name=\"Searching by Category\" %}\nWhen searching for tickets by the **`category`** field, specific terms must be used instead of the category names:\n* For **Customer** category tickets, use the term `request`.\n* For **Back-office** category tickets, use the term `task`.\n* For **Tracker** category tickets, use the term `tracker`.\n{% /admonition %}\n\n### Accepted Operators\n\n{% admonition type=\"info\" name=\"Searching based on `created_at`\" %}\n You may use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "description": "You can create a new ticket.", "header": [ { "key": "Intercom-Version", @@ -11558,7 +17177,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"query\": {\n \"field\": \"created_at\",\n \"operator\": \"AND\",\n \"value\": \"73732934\"\n },\n \"pagination\": {\n \"per_page\": 2,\n \"starting_after\": \"your-cursor-from-response\"\n }\n}", + "raw": "{\n \"ticket_type_id\": \"1234\",\n \"contacts\": [\n {\n \"id\": \"1234\"\n }\n ],\n \"conversation_to_link_id\": \"1234\",\n \"company_id\": \"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632\",\n \"created_at\": 1590000000,\n \"ticket_attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n },\n \"assignment\": {\n \"admin_assignee_id\": \"123\",\n \"team_assignee_id\": \"8\"\n }\n}", "urlencoded": [], "formdata": [] } @@ -11566,30 +17185,23 @@ "response": [] }, { - "name": "Update a ticket", + "name": "Enqueue create ticket", "tags": [ "Tickets" ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/{id}", + "raw": "https://api.intercom.io/tickets/enqueue", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "tickets", - "{id}" + "enqueue" ], "query": [], - "variable": [ - { - "key": "id", - "value": "id", - "disabled": false, - "description": "The unique identifier for the ticket which is given by Intercom.\n{% admonition type=\"info\" name=\"Not the Inbox ticket ID\" %}\nThis is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.\n{% /admonition %}\n" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -11611,8 +17223,8 @@ } ] }, - "method": "PUT", - "description": "You can update a ticket.", + "method": "POST", + "description": "Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job.", "header": [ { "key": "Intercom-Version", @@ -11629,7 +17241,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"ticket_attributes\": {\n \"_default_title_\": \"example\",\n \"_default_description_\": \"having a problem\"\n },\n \"ticket_state_id\": \"123\",\n \"company_id\": \"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632\",\n \"open\": true,\n \"is_shared\": true,\n \"snoozed_until\": 1673609604,\n \"admin_id\": 123,\n \"assignee_id\": \"123\"\n}", + "raw": "{\n \"ticket_type_id\": \"1234\",\n \"contacts\": [\n {\n \"id\": \"1234\"\n }\n ],\n \"conversation_to_link_id\": \"1234\",\n \"company_id\": \"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632\",\n \"created_at\": 1590000000,\n \"ticket_attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n },\n \"assignment\": {\n \"admin_assignee_id\": \"123\",\n \"team_assignee_id\": \"8\"\n }\n}", "urlencoded": [], "formdata": [] } @@ -11637,28 +17249,29 @@ "response": [] }, { - "name": "Delete a ticket", + "name": "Change ticket type", "tags": [ "Tickets" ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/{id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}/change_type", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "tickets", - "{id}" + "{ticket_id}", + "change_type" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "ticket_id", + "value": "ticket_id", "disabled": false, - "description": "The unique identifier for the ticket which is given by Intercom.\n{% admonition type=\"info\" name=\"Not the Inbox ticket ID\" %}\nThis is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.\n{% /admonition %}\n" + "description": "The unique identifier for the ticket which is given by Intercom." } ] }, @@ -11682,49 +17295,48 @@ } ] }, - "method": "DELETE", - "description": "{% admonition type=\"warning\" name=\"Irreversible operation\" %}\nDeleting a ticket is permanent and cannot be reversed.\n{% /admonition %}\n\nDeleting a ticket permanently removes it from the inbox. All sensitive data is deleted, including admin and user replies, ticket attributes, uploads, and related content. The ticket will still appear in reporting, though some data may be incomplete due to the deletion.\n", + "method": "POST", + "description": "You can change the type of a ticket. The new ticket type must be in the same category as the current type. Attributes matching by name and type are automatically transferred from the old type; values provided in ticket_attributes override transferred values.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"ticket_type_id\": \"1234\",\n \"ticket_state_id\": \"5678\",\n \"ticket_attributes\": {\n \"_default_title_\": \"example\",\n \"_default_description_\": \"having a problem\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - } - ] - }, - { - "name": "Visitors", - "item": [ + }, { - "name": "Retrieve a visitor with User ID", + "name": "Search tickets", "tags": [ - "Visitors" + "Tickets" ], "request": { "url": { - "raw": "https://api.intercom.io/visitors", + "raw": "https://api.intercom.io/tickets/search", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "visitors" - ], - "query": [ - { - "key": "user_id", - "value": "user_id", - "description": "The user_id of the Visitor you want to retrieve." - } + "tickets", + "search" ], + "query": [], "variable": [] }, "auth": { @@ -11747,40 +17359,56 @@ } ] }, - "method": "GET", - "description": "You can fetch the details of a single visitor.", + "method": "POST", + "description": "You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`.\n\nThis will accept a query object in the body which will define your filters.\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiples there can be:\n- There's a limit of max 2 nested filters\n- There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foobar\"`).\nThe `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `\"I need support\"` body - the query should contain a `=` operator with the value `\"support\"` for such conversation to be returned. A query with a `=` operator and a `\"need support\"` value will not yield a result.\n\n| Field | Type |\n| :---------------------------------------- | :--------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| title | String |\n| description | String |\n| category | String |\n| ticket_type_id | String |\n| contact_ids | String |\n| teammate_ids | String |\n| admin_assignee_id | Integer |\n| team_assignee_id | Integer |\n| open | Boolean |\n| state | String |\n| snoozed_until | Date (UNIX timestamp) |\n| ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |\n\n{% admonition type=\"info\" name=\"Searching by Category\" %}\nWhen searching for tickets by the **`category`** field, specific terms must be used instead of the category names:\n* For **Customer** category tickets, use the term `request`.\n* For **Back-office** category tickets, use the term `task`.\n* For **Tracker** category tickets, use the term `tracker`.\n{% /admonition %}\n\n### Accepted Operators\n\n{% admonition type=\"info\" name=\"Searching based on `created_at`\" %}\n You may use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"query\": {\n \"field\": \"created_at\",\n \"operator\": \"AND\",\n \"value\": \"73732934\"\n },\n \"pagination\": {\n \"per_page\": 2,\n \"starting_after\": \"your-cursor-from-response\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Convert a visitor", + "name": "Update a ticket", "tags": [ - "Visitors" + "Tickets" ], "request": { "url": { - "raw": "https://api.intercom.io/visitors/convert", + "raw": "https://api.intercom.io/tickets/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "visitors", - "convert" + "tickets", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom.\n{% admonition type=\"info\" name=\"Not the Inbox ticket ID\" %}\nThis is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.\n{% /admonition %}\n" + } + ] }, "auth": { "type": "bearer", @@ -11802,8 +17430,8 @@ } ] }, - "method": "POST", - "description": "You can merge a Visitor to a Contact of role type `lead` or `user`.\n\n> 📘 What happens upon a visitor being converted?\n>\n> If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers.\n", + "method": "PUT", + "description": "You can update a ticket.", "header": [ { "key": "Intercom-Version", @@ -11820,7 +17448,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"type\": \"user\",\n \"user\": {\n \"id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"user_id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"email\": \"winstonsmith@truth.org\"\n },\n \"visitor\": {\n \"id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"user_id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"email\": \"winstonsmith@truth.org\"\n }\n}", + "raw": "{\n \"ticket_attributes\": {\n \"_default_title_\": \"example\",\n \"_default_description_\": \"having a problem\"\n },\n \"ticket_state_id\": \"123\",\n \"company_id\": \"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632\",\n \"open\": true,\n \"is_shared\": true,\n \"snoozed_until\": 1673609604,\n \"admin_id\": 123,\n \"assignee_id\": \"123\",\n \"priority\": \"high\"\n}", "urlencoded": [], "formdata": [] } @@ -11828,22 +17456,38 @@ "response": [] }, { - "name": "Update a visitor", + "name": "Unlink a conversation from a ticket", "tags": [ - "Visitors" + "Tickets" ], "request": { "url": { - "raw": "https://api.intercom.io/visitors", + "raw": "https://api.intercom.io/tickets/{ticket_id}/linked_conversations/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "visitors" + "tickets", + "{ticket_id}", + "linked_conversations", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "ticket_id", + "value": "64619700005694", + "disabled": false, + "description": "The unique identifier for the tracker ticket which is given by Intercom." + }, + { + "key": "id", + "value": "204", + "disabled": false, + "description": "The unique identifier (given by Intercom) for the linked conversation or customer ticket to unlink." + } + ] }, "auth": { "type": "bearer", @@ -11865,51 +17509,36 @@ } ] }, - "method": "PUT", - "description": "Sending a PUT request to `/visitors` will result in an update of an existing Visitor.\n\n**Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body.\n\n**Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body.\n", + "method": "DELETE", + "description": "Unlink a conversation (or converted customer ticket) from a tracker ticket\nit is currently linked to. The ticket in the path must be a tracker ticket.\nThis returns the conversation that was unlinked.\n\nRequires the `write_tickets` OAuth scope.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"8a88a590-e\",\n \"user_id\": \"123\",\n \"name\": \"Christian Bale\",\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 9\n }\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] - } - ] - }, - { - "name": "Workflows", - "item": [ + }, { - "name": "Export a workflow", + "name": "Delete a ticket", "tags": [ - "Workflows" + "Tickets" ], "request": { "url": { - "raw": "https://api.intercom.io/export/workflows/{id}", + "raw": "https://api.intercom.io/tickets/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "export", - "workflows", + "tickets", "{id}" ], "query": [], @@ -11918,7 +17547,7 @@ "key": "id", "value": "id", "disabled": false, - "description": "The unique identifier for the workflow" + "description": "The unique identifier for the ticket which is given by Intercom.\n{% admonition type=\"info\" name=\"Not the Inbox ticket ID\" %}\nThis is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.\n{% /admonition %}\n" } ] }, @@ -11942,8 +17571,8 @@ } ] }, - "method": "GET", - "description": "Export a workflow configuration by its ID. This endpoint returns the complete workflow definition including its steps, targeting rules, and attributes.\n\nThis endpoint is designed for EU Data Act compliance, allowing customers to export their workflow configurations.\n\n{% admonition type=\"warning\" name=\"Preview API\" %}\n This API is currently in the Preview version. Its behavior may change in future releases.\n{% /admonition %}\n", + "method": "DELETE", + "description": "{% admonition type=\"warning\" name=\"Irreversible operation\" %}\nDeleting a ticket is permanent and cannot be reversed.\n{% /admonition %}\n\nDeleting a ticket permanently removes it from the inbox. All sensitive data is deleted, including admin and user replies, ticket attributes, uploads, and related content. The ticket will still appear in reporting, though some data may be incomplete due to the deletion.\n", "header": [ { "key": "Intercom-Version", @@ -11961,39 +17590,28 @@ ] }, { - "name": "Export", + "name": "Visitors", "item": [ { - "name": "Get export job status", + "name": "Retrieve a visitor with User ID", "tags": [ - "Export" + "Visitors" ], "request": { "url": { - "raw": "https://api.intercom.io/export/reporting_data/{job_identifier}", + "raw": "https://api.intercom.io/visitors", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "export", - "reporting_data", - "{job_identifier}" + "visitors" ], "query": [ { - "key": "app_id", - "value": "app_id", - "description": "The Intercom defined code of the workspace the company is associated to." - }, - { - "key": "client_id", - "value": "client_id" - }, - { - "key": "job_identifier", - "value": "job_identifier", - "description": "Unique identifier of the job." + "key": "user_id", + "value": "user_id", + "description": "The user_id of the Visitor you want to retrieve." } ], "variable": [] @@ -12019,6 +17637,7 @@ ] }, "method": "GET", + "description": "You can fetch the details of a single visitor.", "header": [ { "key": "Intercom-Version", @@ -12034,21 +17653,20 @@ "response": [] }, { - "name": "List available datasets and attributes", + "name": "Convert a visitor", "tags": [ - "Export" + "Visitors" ], "request": { "url": { - "raw": "https://api.intercom.io/export/reporting_data/get_datasets", + "raw": "https://api.intercom.io/visitors/convert", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "export", - "reporting_data", - "get_datasets" + "visitors", + "convert" ], "query": [], "variable": [] @@ -12073,48 +17691,47 @@ } ] }, - "method": "GET", + "method": "POST", + "description": "You can merge a Visitor to a Contact of role type `lead` or `user`.\n\n> 📘 What happens upon a visitor being converted?\n>\n> If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"user\",\n \"user\": {\n \"id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"user_id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"email\": \"winstonsmith@truth.org\"\n },\n \"visitor\": {\n \"id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"user_id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"email\": \"winstonsmith@truth.org\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Download completed export job data", + "name": "Update a visitor", "tags": [ - "Export" + "Visitors" ], "request": { "url": { - "raw": "https://api.intercom.io/download/reporting_data/{job_identifier}", + "raw": "https://api.intercom.io/visitors", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "download", - "reporting_data", - "{job_identifier}" - ], - "query": [ - { - "key": "app_id", - "value": "app_id" - }, - { - "key": "job_identifier", - "value": "job_identifier" - } + "visitors" ], + "query": [], "variable": [] }, "auth": { @@ -12137,46 +17754,62 @@ } ] }, - "method": "GET", - "description": "Download the data from a completed reporting data export job.\n\n> Octet header required\n>\n> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.\n", + "method": "PUT", + "description": "Sending a PUT request to `/visitors` will result in an update of an existing Visitor.\n\n**Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body.\n\n**Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, { - "key": "Accept", - "value": "Accept", - "description": "Required header for downloading the export file" + "key": "Content-Type", + "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"8a88a590-e\",\n \"user_id\": \"123\",\n \"name\": \"Christian Bale\",\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 9\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Workflows", + "item": [ { - "name": "Enqueue a new reporting data export job", + "name": "Export a workflow", "tags": [ - "Export" + "Workflows" ], "request": { "url": { - "raw": "https://api.intercom.io/export/reporting_data/enqueue", + "raw": "https://api.intercom.io/export/workflows/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "export", - "reporting_data", - "enqueue" + "workflows", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the workflow" + } + ] }, "auth": { "type": "bearer", @@ -12198,27 +17831,19 @@ } ] }, - "method": "POST", + "method": "GET", + "description": "Export a workflow configuration by its ID. This endpoint returns the complete workflow definition including its steps, targeting rules, and attributes.\n\nThis endpoint is designed for EU Data Act compliance, allowing customers to export their workflow configurations.\n\n{% admonition type=\"info\" name=\"Preview API\" %}\n This endpoint is available in the Preview API version. We may make iterative improvements, including adding new fields or refining existing ones.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"dataset_id\": \"conversation\",\n \"attribute_ids\": [\n \"conversation_id\",\n \"conversation_started_at\"\n ],\n \"start_time\": 1717490000,\n \"end_time\": 1717510000\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] } @@ -12561,7 +18186,7 @@ "event": [], "variable": [ { - "id": "f6d918ee-961e-40a5-8308-deaa65c7c8da", + "id": "0ab7e0ed-f585-4ecc-81bb-f0a8897fec53", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/scripts/postman/collection.js b/scripts/postman/collection.js index 870363d3..040b1006 100644 --- a/scripts/postman/collection.js +++ b/scripts/postman/collection.js @@ -303,6 +303,13 @@ module.exports = class Collection { }); } + serialize(key, value) { + if (value === undefined || value === null) { + return ''; + } + return typeof value === 'string' ? value : JSON.stringify(value); + } + fetchExample(param) { if (param.value) { return String(param.value); diff --git a/scripts/postman/example.js b/scripts/postman/example.js index 4625d30e..be2519d3 100644 --- a/scripts/postman/example.js +++ b/scripts/postman/example.js @@ -24,6 +24,9 @@ module.exports = class Example { return this.value(prop.items.oneOf[0]); } else if (prop.type === 'array' && prop.items.properties) { return [this.value(prop.items)]; + } else if (prop.type === 'array') { + // A sampled element is not accepted: attachment_urls: [""] is an undownloadable URL. + return []; } else if (prop.oneOf) { return this.value(prop.oneOf[0]); } else if (prop.type === 'string' && prop.enum) {