From b921b7cf5728f07ae307f9618936213b2bd1c80b Mon Sep 17 00:00:00 2001 From: Steve Henry Date: Fri, 25 Apr 2025 11:52:28 +0100 Subject: [PATCH 1/3] Fix folders and urls in Postman collection generation --- postman/2.10/README.md | 2 +- .../2.10/intercom-api.postman_collection.json | 7033 ++++++++++++-- postman/2.11/README.md | 2 +- .../2.11/intercom-api.postman_collection.json | 7132 ++++++++++++-- postman/2.12/README.md | 2 +- .../2.12/intercom-api.postman_collection.json | 7673 +++++++++++++-- postman/2.13/README.md | 2 +- .../2.13/intercom-api.postman_collection.json | 8219 +++++++++++++--- postman/2.7/README.md | 2 +- .../2.7/intercom-api.postman_collection.json | 6292 ++++++++++-- postman/2.8/README.md | 2 +- .../2.8/intercom-api.postman_collection.json | 6292 ++++++++++-- postman/2.9/README.md | 2 +- .../2.9/intercom-api.postman_collection.json | 6984 ++++++++++++-- postman/README.md | 2 - postman/Unstable/README.md | 2 +- .../intercom-api.postman_collection.json | 8447 ++++++++++++++--- scripts/postman/collection.js | 50 +- scripts/postman/example.js | 2 +- 19 files changed, 50661 insertions(+), 7481 deletions(-) delete mode 100644 postman/README.md diff --git a/postman/2.10/README.md b/postman/2.10/README.md index 142b658..076aa68 100644 --- a/postman/2.10/README.md +++ b/postman/2.10/README.md @@ -12,4 +12,4 @@ This directory contains the Postman collection for Intercom API version 2.10. 3. Set your access token in the environment variables 4. Start making API calls! -Last updated: 2025-04-15T14:40:02.395Z +Last updated: 2025-04-25T10:49:24.555Z diff --git a/postman/2.10/intercom-api.postman_collection.json b/postman/2.10/intercom-api.postman_collection.json index 2eeb07c..6f51ea8 100644 --- a/postman/2.10/intercom-api.postman_collection.json +++ b/postman/2.10/intercom-api.postman_collection.json @@ -8,1872 +8,7150 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-04-15T14:40:02.393Z" + "updatedAt": "2025-04-25T10:49:24.551Z" }, "item": [ { - "name": "General", + "name": "Admins", "item": [ { "name": "Identify an admin", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/me", + "raw": "https://api.intercom.io/me", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "me" + ], + "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": "\nYou can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology).\n\n> 🚧 Single Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.\n", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List all activity logs", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/activity_logs", + "raw": "https://api.intercom.io/admins/activity_logs", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "admins", "activity_logs" + ], + "query": [ + { + "key": "created_at_after", + "value": "1677253093", + "description": "The start date that you request data for. It must be formatted as a UNIX timestamp." + }, + { + "key": "created_at_before", + "value": "1677861493", + "description": "The end date that you request data for. It must be formatted as a UNIX timestamp." + } + ], + "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 get a log of activities by all admins in an app.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List all admins", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/admins", + "raw": "https://api.intercom.io/admins", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "admins" + ], + "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 admins for a given workspace.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Retrieve an admin", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/{id}", + "raw": "https://api.intercom.io/admins/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "admins", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given admin" + } + ] + }, + "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 details of a single admin.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, + { + "name": "Set an admin to away", + "tags": [ + "Admins" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/admins/{id}/away", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "admins", + "{id}", + "away" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a given admin" + } + ] + }, + "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 set an Admin as away for the Inbox.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"away_mode_enabled\": true,\n \"away_mode_reassign\": false\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Articles", + "item": [ { "name": "List all articles", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "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": "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", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Retrieve an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article 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 article by making a GET request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Search for articles", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/articles/search", + "raw": "https://api.intercom.io/articles/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "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." + } + ], + "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 search for articles by making a GET request to `https://api.intercom.io/articles/search`.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all collections", + "name": "Create an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections", + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections" + "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" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a collection", + "name": "Update an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", + "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "description": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", - "header": [], - "body": {} + "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 article by making a PUT request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a Help Center", + "name": "Delete an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/help_centers/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "help_centers", + "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "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": [], - "body": {} - }, - "response": [] - }, - { - "name": "List all Help Centers", - "request": { - "method": "GET", - "url": { - "raw": "/help_center/help_centers", - "path": [ - "help_center", - "help_centers" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Companies", + "item": [ { "name": "Retrieve companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "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" + } + ], + "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 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": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Retrieve a company by ID", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", "{id}" + ], + "query": [], + "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", + "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 company.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List attached contacts", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}/contacts", + "raw": "https://api.intercom.io/companies/{id}/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", "{id}", "contacts" + ], + "query": [], + "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", + "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 contacts that belong to a company.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List attached segments for companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}/segments", + "raw": "https://api.intercom.io/companies/{id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", "{id}", "segments" + ], + "query": [], + "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", + "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 segments that belong to a company.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Scroll over all companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/scroll", + "raw": "https://api.intercom.io/companies/scroll", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", "scroll" + ], + "query": [ + { + "key": "scroll_param", + "value": "scroll_param", + "description": "" + } + ], + "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": " 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": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached companies for contact", + "name": "Create or Update a company", + "tags": [ + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies" + ], + "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 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": "2.10" + }, + { + "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\": \"Technology\",\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}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "List all companies", + "tags": [ + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/companies/list", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "list" + ], + "query": [ + { + "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", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "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", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Attach a Contact to a Company", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}/companies", + "raw": "https://api.intercom.io/contacts/{id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{id}", "companies" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can fetch a list of companies that are associated to a contact.", - "header": [], - "body": {} + "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 attach a company to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"58a430d35458202d41b1e65b\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all notes", + "name": "Update a company", + "tags": [ + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "{id}" + ], + "query": [], + "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", + "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 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", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Delete a company", + "tags": [ + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "{id}" + ], + "query": [], + "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", + "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 company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Detach a contact from a company", + "tags": [ + "Companies", + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{contact_id}/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{contact_id}", + "companies", + "{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", + "disabled": false, + "description": "The unique identifier for the company 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": "DELETE", + "description": "You can detach a company from a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Contacts", + "item": [ + { + "name": "List attached companies for contact", + "tags": [ + "Contacts", + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}/notes", + "raw": "https://api.intercom.io/contacts/{id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{id}", - "notes" + "companies" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can fetch a list of notes that are associated to a contact.", - "header": [], - "body": {} + "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 companies that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List attached segments for contact", + "tags": [ + "Contacts", + "Segments" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/segments", + "raw": "https://api.intercom.io/contacts/{contact_id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "segments" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 a list of segments that are associated to a contact.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List subscriptions for a contact", + "tags": [ + "Contacts", + "Subscription Types" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 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", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List tags attached to a contact", + "tags": [ + "Contacts", + "Tags" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 a list of all tags that are attached to a specific contact.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Get a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "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": "GET", "description": "You can fetch the details of a single contact.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List all contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts" + ], + "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 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", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all conversations", + "name": "Merge a lead and a user", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/contacts/merge", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "contacts", + "merge" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"from\": \"5d70dd30de4efd54f42fd526\",\n \"into\": \"5ba682d23d7cf92bef87bfd4\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a conversation", + "name": "Search contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/contacts/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}" + "contacts", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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", - "header": [], - "body": {} + "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| 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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "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": "List all data attributes", + "name": "Create contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/data_attributes", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes" - ] + "contacts" + ], + "query": [], + "variable": [] }, - "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", - "header": [], - "body": {} + "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 contact (ie. user or lead).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all data events", + "name": "Archive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/contacts/{id}/archive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "contacts", + "{id}", + "archive" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "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": [], - "body": {} + "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 archive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Show content data export", + "name": "Unarchive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/export/content/data/{job_identifier}", + "raw": "https://api.intercom.io/contacts/{id}/unarchive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data", - "{job_identifier}" + "contacts", + "{id}", + "unarchive" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "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": [], - "body": {} + "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 unarchive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Download content data export", + "name": "Update a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/download/content/data/{job_identifier}", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "download", - "content", - "data", - "{job_identifier}" + "contacts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "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": [], - "body": {} + "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 contact (ie. user or lead).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all news items", + "name": "Delete a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items" + "contacts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch a list of all news items", - "header": [], - "body": {} + "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": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Conversations", + "item": [ { - "name": "Retrieve a news item", + "name": "List all conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{id}" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single news item.", - "header": [], - "body": {} + "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": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all live newsfeed items", + "name": "Retrieve a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{id}/items", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", - "{id}", - "items" + "conversations", + "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can fetch a list of all news items that are live on a given newsfeed", - "header": [], - "body": {} + "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.\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": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all newsfeeds", + "name": "Creates a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds" + "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" + } ] }, - "description": "You can fetch a list of all newsfeeds", - "header": [], - "body": {} + "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": "2.10" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a newsfeed", + "name": "Search conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{id}", + "raw": "https://api.intercom.io/conversations/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", - "{id}" + "conversations", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single newsfeed", - "header": [], - "body": {} + "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 as part of 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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "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": "Retrieve a note", + "name": "Reply to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/notes/{id}", + "raw": "https://api.intercom.io/conversations/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "notes", - "{id}" + "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" + } ] }, - "description": "You can fetch the details of a single note.", - "header": [], - "body": {} + "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.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "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 \"attachment_urls\": \"\",\n \"admin_id\": \"3156780\",\n \"created_at\": 1590000000,\n \"attachment_files\": [\n {\n \"content_type\": \"application/json\",\n \"data\": \"ewogICJ0ZXN0IjogMQp9\",\n \"name\": \"test.json\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all segments", + "name": "Manage a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/segments", + "raw": "https://api.intercom.io/conversations/{id}/parts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments" + "conversations", + "{id}", + "parts" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can fetch a list of all segments.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Retrieve a segment", + "name": "Run Assignment Rules on a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/segments/{id}", + "raw": "https://api.intercom.io/conversations/{id}/run_assignment_rules", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments", - "{id}" + "conversations", + "{id}", + "run_assignment_rules" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can fetch the details of a single segment.", - "header": [], - "body": {} + "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=\"danger\" name=\"Deprecation of Run Assignment Rules\" %}\nRun assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail.\n{% /admonition %}\nYou can let a conversation be automatically assigned following assignment rules.\n{% admonition type=\"warning\" name=\"When using workflows\" %}\nIt is not possible to use this endpoint with Workflows.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List subscription types", + "name": "Attach a contact to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/subscription_types", + "raw": "https://api.intercom.io/conversations/{id}/customers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "subscription_types" + "conversations", + "{id}", + "customers" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can list all subscription types. A list of subscription type objects will be returned.", - "header": [], - "body": {} + "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": "2.10" + }, + { + "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\": \"joe@example.com\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all tags", + "name": "Redact a conversation part", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/tags", + "raw": "https://api.intercom.io/conversations/redact", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags" + "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" + } ] }, - "description": "You can fetch a list of all tags for a given workspace.\n\n", - "header": [], - "body": {} + "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": "2.10" + }, + { + "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": "Find a specific tag", + "name": "Convert a conversation to a ticket", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/tags/{id}", + "raw": "https://api.intercom.io/conversations/{id}/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags", - "{id}" + "conversations", + "{id}", + "convert" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can fetch the details of tags that are on the workspace by their id.\nThis will return a tag object.\n", - "header": [], - "body": {} + "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": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ticket_type_id\": \"1234\",\n \"attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all teams", + "name": "Update a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/teams", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams" + "conversations", + "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "This will return a list of team objects for the App.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"read\": true\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a team", + "name": "Detach a contact from a group conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/teams/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/customers/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams", - "{id}" + "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." + } ] }, - "description": "You can fetch the details of a single team, containing an array of admins that belong to this team.", - "header": [], - "body": {} + "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 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": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"5017690\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Data Attributes", + "item": [ { - "name": "List all ticket types", + "name": "List all data attributes", + "tags": [ + "Data Attributes" + ], "request": { - "method": "GET", "url": { - "raw": "/ticket_types", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can get a list of all ticket types for a workspace.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a ticket type", + "name": "Create a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "GET", "url": { - "raw": "/ticket_types/{id}", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{id}" + "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" + } ] }, - "description": "You can fetch the details of a single ticket type.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a data attributes for a `contact` or a `company`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Data Attribute\",\n \"model\": \"contact\",\n \"data_type\": \"string\",\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a ticket", + "name": "Update a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "GET", "url": { - "raw": "/tickets/{id}", + "raw": "https://api.intercom.io/data_attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", + "data_attributes", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "1", + "disabled": false, + "description": "The data attribute id" + } ] }, - "description": "You can fetch the details of a single ticket.", - "header": [], - "body": {} + "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": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"archived\": false,\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Data Events", + "item": [ { - "name": "Retrieve a visitor with User ID", + "name": "List all data events", + "tags": [ + "Data Events" + ], "request": { - "method": "GET", "url": { - "raw": "/visitors", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors" - ] + "events" + ], + "query": [ + { + "key": "filter", + "value": "filter" + }, + { + "key": "type", + "value": "type", + "description": "The value must be user" + }, + { + "key": "summary", + "value": "summary", + "description": "summary flag" + } + ], + "variable": [] }, - "description": "You can fetch the details of a single visitor.", - "header": [], - "body": {} + "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": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create an article", + "name": "Submit a data event", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles" + "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" + } ] }, - "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", - "header": [], - "body": {} + "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": "2.10" + }, + { + "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 a collection", + "name": "Create event summaries", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/help_center/collections", + "raw": "https://api.intercom.io/events/summaries", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections" + "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" + } ] }, - "description": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", - "header": [], - "body": {} + "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": "2.10" + }, + { + "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": "Create or Update a company", + "name": "Show content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/export/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies" + "export", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "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": [], - "body": {} + "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": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all companies", + "name": "Download content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/companies/list", + "raw": "https://api.intercom.io/download/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "list" + "download", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "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": [], - "body": {} + "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": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Attach a Contact to a Company", + "name": "Create content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/companies", + "raw": "https://api.intercom.io/export/content/data", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "companies" + "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" + } ] }, - "description": "You can attach a company to a single contact.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "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": "Create a note", + "name": "Cancel content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/notes", + "raw": "https://api.intercom.io/export/cancel/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "notes" + "export", + "cancel", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "description": "You can add a note to a single contact.", - "header": [], - "body": {} + "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": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Help Center", + "item": [ { - "name": "Add subscription to a contact", + "name": "List all collections", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions" + "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" + } ] }, - "description": "You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", - "header": [], - "body": {} + "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": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Add tag to a contact", + "name": "Retrieve a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "description": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", - "header": [], - "body": {} + "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": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Merge a lead and a user", + "name": "Retrieve a Help Center", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/merge", + "raw": "https://api.intercom.io/help_center/help_centers/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "merge" + "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." + } ] }, - "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", - "header": [], - "body": {} + "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": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Search contacts", + "name": "List all Help Centers", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/search", + "raw": "https://api.intercom.io/help_center/help_centers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "search" + "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" + } ] }, - "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| 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", - "header": [], - "body": {} + "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": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create contact", + "name": "Create a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts" + "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" + } ] }, - "description": "You can create a new contact (ie. user or lead).", - "header": [], - "body": {} + "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": "2.10" + }, + { + "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": "Archive contact", + "name": "Update a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/archive", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "archive" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "description": "You can archive a single contact.", - "header": [], - "body": {} + "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": "2.10" + }, + { + "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": "Unarchive contact", + "name": "Delete a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/unarchive", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "unarchive" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "description": "You can unarchive a single contact.", - "header": [], - "body": {} + "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 collection by making a DELETE request to `https://api.intercom.io/collections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Messages", + "item": [ { - "name": "Add tag to a conversation", + "name": "Create a message", + "tags": [ + "Messages" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{conversation_id}/tags", + "raw": "https://api.intercom.io/messages", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags" + "messages" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\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", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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 \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n \"create_conversation_without_contact_reply\": true\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "News", + "item": [ { - "name": "Creates a conversation", + "name": "List all news items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "news", + "news_items" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all news items", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Search conversations", + "name": "Retrieve a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/search", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "search" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "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 as part of 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", - "header": [], - "body": {} + "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 news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Reply to a conversation", + "name": "List all live newsfeed items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/reply", + "raw": "https://api.intercom.io/news/newsfeeds/{id}/items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", + "news", + "newsfeeds", "{id}", - "reply" + "items" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } ] }, - "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.", - "header": [], - "body": {} + "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 news items that are live on a given newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Manage a conversation", + "name": "List all newsfeeds", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/parts", + "raw": "https://api.intercom.io/news/newsfeeds", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "parts" + "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" + } ] }, - "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", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all newsfeeds", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Run Assignment Rules on a conversation", + "name": "Retrieve a newsfeed", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/run_assignment_rules", + "raw": "https://api.intercom.io/news/newsfeeds/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "run_assignment_rules" + "news", + "newsfeeds", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } ] }, - "description": "{% admonition type=\"danger\" name=\"Deprecation of Run Assignment Rules\" %}\nRun assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail.\n{% /admonition %}\nYou can let a conversation be automatically assigned following assignment rules.\n{% admonition type=\"warning\" name=\"When using workflows\" %}\nIt is not possible to use this endpoint with Workflows.\n{% /admonition %}\n", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Attach a contact to a conversation", - "request": { - "method": "POST", - "url": { - "raw": "/conversations/{id}/customers", - "path": [ - "conversations", - "{id}", - "customers" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Redact a conversation part", + "name": "Create a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/redact", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "redact" + "news", + "news_items" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can create a news item", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Convert a conversation to a ticket", + "name": "Update a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/convert", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "convert" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "description": "You can convert a conversation to a ticket.", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Create a data attribute", - "request": { - "method": "POST", - "url": { - "raw": "/data_attributes", - "path": [ - "data_attributes" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a data attributes for a `contact` or a `company`.", - "header": [], - "body": {} + "method": "PUT", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Submit a data event", + "name": "Delete a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "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": [], - "body": {} - }, - "response": [] - }, - { - "name": "Create event summaries", - "request": { - "method": "POST", - "url": { - "raw": "/events/summaries", - "path": [ - "events", - "summaries" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "DELETE", + "description": "You can delete a single news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Notes", + "item": [ { - "name": "Create content data export", + "name": "List all notes", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/export/content/data", + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data" + "contacts", + "{id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a contact." + } ] }, - "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", - "header": [], - "body": {} + "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 notes that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Cancel content data export", + "name": "Retrieve a note", + "tags": [ + "Notes" + ], "request": { - "method": "POST", "url": { - "raw": "/export/cancel/{job_identifier}", + "raw": "https://api.intercom.io/notes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "cancel", - "{job_identifier}" + "notes", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "1", + "disabled": false, + "description": "The unique identifier of a given note" + } ] }, - "description": "You can cancel your job", - "header": [], - "body": {} + "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 note.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a message", + "name": "Create a note", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/messages", + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "messages" + "contacts", + "{id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given contact." + } ] }, - "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\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": [], - "body": {} + "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 a note to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"body\": \"New note\",\n \"contact_id\": \"123\",\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Segments", + "item": [ { - "name": "Create a news item", + "name": "List all segments", + "tags": [ + "Segments" + ], "request": { - "method": "POST", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items" + "segments" + ], + "query": [ + { + "key": "include_count", + "value": "true", + "description": "It includes the count of contacts that belong to each segment." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a news item", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all segments.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a phone Switch", + "name": "Retrieve a segment", + "tags": [ + "Segments" + ], "request": { - "method": "POST", "url": { - "raw": "/phone_call_redirects", + "raw": "https://api.intercom.io/segments/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "phone_call_redirects" + "segments", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identified of a given segment." + } ] }, - "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", - "header": [], - "body": {} + "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 segment.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Subscription Types", + "item": [ { - "name": "Create or update a tag, Tag or untag companies, Tag contacts", + "name": "List subscription types", + "tags": [ + "Subscription Types" + ], "request": { - "method": "POST", "url": { - "raw": "/tags", + "raw": "https://api.intercom.io/subscription_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags" + "subscription_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", - "header": [], - "body": {} + "method": "GET", + "description": "You can list all subscription types. A list of subscription type objects will be returned.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a new attribute for a ticket type", + "name": "Add subscription to a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/ticket_types/{ticket_type_id}/attributes", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{ticket_type_id}", - "attributes" + "contacts", + "{contact_id}", + "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can create a new attribute for a ticket type.", - "header": [], - "body": {} + "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 a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"37846\",\n \"consent_type\": \"opt_in\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Create a ticket type", + "name": "Remove subscription from a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/ticket_types", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types" + "contacts", + "{contact_id}", + "subscriptions", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "value": "37846", + "disabled": false, + "description": "The unique identifier for the subscription type which is given by Intercom" + } ] }, - "description": "You can create a new ticket type.\n> 📘 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: _default_title_ and _default_description_.\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", - "header": [], - "body": {} + "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 a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Switch", + "item": [ { - "name": "Reply to a ticket", + "name": "Create a phone Switch", + "tags": [ + "Switch" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/{id}/reply", + "raw": "https://api.intercom.io/phone_call_redirects", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{id}", - "reply" + "phone_call_redirects" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins.", - "header": [], - "body": {} + "method": "POST", + "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"phone\": \"+1 1234567890\",\n \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Tags", + "item": [ { - "name": "Add tag to a ticket", + "name": "List all tags", + "tags": [ + "Tags" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/{ticket_id}/tags", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{ticket_id}", "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all tags for a given workspace.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a ticket", + "name": "Find a specific tag", + "tags": [ + "Tags" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets", + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets" + "tags", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } ] }, - "description": "You can create a new ticket.", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Search tickets", - "request": { - "method": "POST", - "url": { - "raw": "/tickets/search", - "path": [ - "tickets", - "search" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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### 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": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of tags that are on the workspace by their id.\nThis will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Convert a visitor", + "name": "Add tag to a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/visitors/convert", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors", - "convert" + "contacts", + "{contact_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 tag a specific contact. This will return a tag object for the tag that was added to the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Set an admin to away", + "name": "Add tag to a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "PUT", "url": { - "raw": "/admins/{id}/away", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins", - "{id}", - "away" + "conversations", + "{conversation_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + } ] }, - "description": "You can set an Admin as away for the Inbox.", - "header": [], - "body": {} + "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 tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"780\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update an article", + "name": "Create or update a tag, Tag or untag companies, Tag contacts", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", - "{id}" + "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "method": "POST", + "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Independent\",\n \"id\": \"656452352\",\n \"companies\": [\n {\n \"id\": \"531ee472cce572a6ec000006\",\n \"company_id\": \"6\",\n \"untag\": \"true\"\n }\n ],\n \"users\": [\n {\n \"id\": \"5f7f0d217289f8d2f4262080\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a collection", + "name": "Add tag to a ticket", + "tags": [ + "Tags", + "Tickets" + ], "request": { - "method": "PUT", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", - "{id}" + "tickets", + "{ticket_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "64619700005694", + "disabled": false, + "description": "ticket_id" + } ] }, - "description": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} + "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 tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"780\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a company", + "name": "Remove tag from a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", + "contacts", + "{contact_id}", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier for the tag which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a contact", + "name": "Remove tag from a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "PUT", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", + "conversations", + "{conversation_id}", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "id" + } ] }, - "description": "You can update an existing contact (ie. user or lead).", - "header": [], - "body": {} + "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 tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a conversation", + "name": "Delete tag", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } ] }, - "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", - "header": [], - "body": {} + "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 the details of tags that are on the workspace by passing in the id.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a data attribute", + "name": "Remove tag from a ticket", + "tags": [ + "Tags", + "Tickets" + ], "request": { - "method": "PUT", "url": { - "raw": "/data_attributes/{id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes", + "tickets", + "{ticket_id}", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "64619700005694", + "disabled": false, + "description": "ticket_id" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier for the tag which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Teams", + "item": [ { - "name": "Update a news item", + "name": "List all teams", + "tags": [ + "Teams" + ], "request": { - "method": "PUT", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/teams", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{id}" + "teams" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "", - "header": [], - "body": {} + "method": "GET", + "description": "This will return a list of team objects for the App.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update an existing attribute for a ticket type", + "name": "Retrieve a team", + "tags": [ + "Teams" + ], "request": { - "method": "PUT", "url": { - "raw": "/ticket_types/{ticket_type_id}/attributes/{id}", + "raw": "https://api.intercom.io/teams/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{ticket_type_id}", - "attributes", + "teams", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given team." + } ] }, - "description": "You can update an existing attribute for a ticket type.", - "header": [], - "body": {} + "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 team, containing an array of admins that belong to this team.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Ticket Type Attributes", + "item": [ { - "name": "Update a ticket type", + "name": "Create a new attribute for a ticket type", + "tags": [ + "Ticket Type Attributes" + ], "request": { - "method": "PUT", "url": { - "raw": "/ticket_types/{id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "ticket_types", - "{id}" + "{ticket_type_id}", + "attributes" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } ] }, - "description": "\nYou can update a ticket type.\n\n> 📘 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", - "header": [], - "body": {} + "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 attribute for a ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug Priority\",\n \"description\": \"Priority level of the bug\",\n \"data_type\": \"string\",\n \"required_to_create\": false,\n \"required_to_create_for_contacts\": false,\n \"visible_on_create\": true,\n \"visible_to_contacts\": true,\n \"multiline\": false,\n \"list_items\": \"Low Priority,Medium Priority,High Priority\",\n \"allow_multiple_values\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a ticket", + "name": "Update an existing attribute for a ticket type", + "tags": [ + "Ticket Type Attributes" + ], "request": { - "method": "PUT", "url": { - "raw": "/tickets/{id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", + "ticket_types", + "{ticket_type_id}", + "attributes", "{id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + }, + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket type attribute which is given by Intercom." + } ] }, - "description": "You can update a ticket.", - "header": [], - "body": {} + "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 attribute for a ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug Priority\",\n \"description\": \"Priority level of the bug\",\n \"required_to_create\": false,\n \"required_to_create_for_contacts\": false,\n \"visible_on_create\": true,\n \"visible_to_contacts\": true,\n \"multiline\": false,\n \"list_items\": \"Low Priority,Medium Priority,High Priority\",\n \"allow_multiple_values\": false,\n \"archived\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Ticket Types", + "item": [ { - "name": "Update a visitor", + "name": "List all ticket types", + "tags": [ + "Ticket Types" + ], "request": { - "method": "PUT", "url": { - "raw": "/visitors", + "raw": "https://api.intercom.io/ticket_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors" + "ticket_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can get a list of all ticket types for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete an article", + "name": "Retrieve a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/ticket_types/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", + "ticket_types", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } ] }, - "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "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 ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete a collection", + "name": "Create a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/ticket_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", - "{id}" + "ticket_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new ticket type.\n> 📘 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: _default_title_ and _default_description_.\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug\",\n \"description\": \"Used for tracking bugs\",\n \"category\": \"Customer\",\n \"icon\": \"🐞\",\n \"is_internal\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a company", + "name": "Update a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/ticket_types/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", + "ticket_types", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } ] }, - "description": "You can delete a single company.", - "header": [], - "body": {} + "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 ticket type.\n\n> 📘 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug\",\n \"description\": \"A bug has been occured\",\n \"category\": \"Customer\",\n \"icon\": \"🐞\",\n \"archived\": false,\n \"is_internal\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Tickets", + "item": [ { - "name": "Detach a contact from a company", + "name": "Retrieve a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/companies/{id}", + "raw": "https://api.intercom.io/tickets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "companies", + "tickets", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom." + } ] }, - "description": "You can detach a company from a single contact.", - "header": [], - "body": {} + "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 ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Remove subscription from a contact", + "name": "Reply to a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/subscriptions/{id}", + "raw": "https://api.intercom.io/tickets/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions", - "{id}" + "tickets", + "{id}", + "reply" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false + } ] }, - "description": "You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", - "header": [], - "body": {} + "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 ticket with a message from an admin or on behalf of a contact, or with a note for admins.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "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 \"attachment_urls\": \"\",\n \"admin_id\": \"3156780\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Remove tag from a contact", + "name": "Create a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/tags/{id}", + "raw": "https://api.intercom.io/tickets", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags", - "{id}" + "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" + } ] }, - "description": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "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 \"company_id\": \"1234\",\n \"ticket_attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a contact", + "name": "Search tickets", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/tickets/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}" + "tickets", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single contact.", - "header": [], - "body": {} + "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### 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": "2.10" + }, + { + "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": "Remove tag from a conversation", + "name": "Update a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{conversation_id}/tags/{id}", + "raw": "https://api.intercom.io/tickets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags", + "tickets", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom" + } ] }, - "description": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Detach a contact from a group conversation", - "request": { - "method": "DELETE", - "url": { - "raw": "/conversations/{conversation_id}/customers/{contact_id}", - "path": [ - "conversations", - "{conversation_id}", - "customers", - "{contact_id}" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "PUT", + "description": "You can update a ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ticket_attributes\": {\n \"_default_title_\": \"example\",\n \"_default_description_\": \"having a problem\"\n },\n \"state\": \"submitted\",\n \"open\": true,\n \"is_shared\": true,\n \"snoozed_until\": 1673609604,\n \"assignment\": {\n \"admin_id\": \"123\",\n \"assignee_id\": \"123\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Visitors", + "item": [ { - "name": "Delete a news item", + "name": "Retrieve a visitor with User ID", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{id}" + "visitors" + ], + "query": [ + { + "key": "user_id", + "value": "user_id", + "description": "The user_id of the Visitor you want to retrieve." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single news item.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single visitor.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.10" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete tag", + "name": "Convert a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/tags/{id}", + "raw": "https://api.intercom.io/visitors/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags", - "{id}" + "visitors", + "convert" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete the details of tags that are on the workspace by passing in the id.", - "header": [], - "body": {} + "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": "2.10" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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\": \"joe@example.com\"\n },\n \"visitor\": {\n \"id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"user_id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"email\": \"joe@example.com\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Remove tag from a ticket", + "name": "Update a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/tickets/{ticket_id}/tags/{id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{ticket_id}", - "tags", - "{id}" + "visitors" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.", - "header": [], - "body": {} + "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": "2.10" + }, + { + "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": [] + } }, "response": [] } @@ -1883,28 +7161,7 @@ "event": [], "variable": [ { - "id": "02ef4d2f-64eb-44be-a785-1605d37c5f6e", - "key": "https://api.intercom.io", - "value": "https://api.intercom.io", - "type": "string", - "description": "The production API server" - }, - { - "id": "690e673d-1be6-4b65-8f3c-ca509b5e659d", - "key": "https://api.eu.intercom.io", - "value": "https://api.eu.intercom.io", - "type": "string", - "description": "The european API server" - }, - { - "id": "03b27b7e-90c1-4bd7-a47f-1c80037dedd0", - "key": "https://api.au.intercom.io", - "value": "https://api.au.intercom.io", - "type": "string", - "description": "The australian API server" - }, - { - "id": "903f694f-4502-4e3d-b5cb-8be4ee785c2c", + "id": "ddfcd9d0-c5e3-4eae-844a-badf27d5a84f", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/postman/2.11/README.md b/postman/2.11/README.md index 633f2e4..25e66c8 100644 --- a/postman/2.11/README.md +++ b/postman/2.11/README.md @@ -12,4 +12,4 @@ This directory contains the Postman collection for Intercom API version 2.11. 3. Set your access token in the environment variables 4. Start making API calls! -Last updated: 2025-04-15T14:40:02.652Z +Last updated: 2025-04-25T10:49:24.812Z diff --git a/postman/2.11/intercom-api.postman_collection.json b/postman/2.11/intercom-api.postman_collection.json index 4cbb469..1baa5ee 100644 --- a/postman/2.11/intercom-api.postman_collection.json +++ b/postman/2.11/intercom-api.postman_collection.json @@ -8,1872 +8,7237 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-04-15T14:40:02.651Z" + "updatedAt": "2025-04-25T10:49:24.810Z" }, "item": [ { - "name": "General", + "name": "Admins", "item": [ { "name": "Identify an admin", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/me", + "raw": "https://api.intercom.io/me", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "me" + ], + "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": "\nYou can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology).\n\n> 🚧 Single Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.\n", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List all activity logs", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/activity_logs", + "raw": "https://api.intercom.io/admins/activity_logs", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "admins", "activity_logs" + ], + "query": [ + { + "key": "created_at_after", + "value": "1677253093", + "description": "The start date that you request data for. It must be formatted as a UNIX timestamp." + }, + { + "key": "created_at_before", + "value": "1677861493", + "description": "The end date that you request data for. It must be formatted as a UNIX timestamp." + } + ], + "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 get a log of activities by all admins in an app.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List all admins", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/admins", + "raw": "https://api.intercom.io/admins", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "admins" + ], + "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 admins for a given workspace.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Retrieve an admin", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/{admin_id}", + "raw": "https://api.intercom.io/admins/{admin_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "admins", "{admin_id}" + ], + "query": [], + "variable": [ + { + "key": "admin_id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given admin" + } + ] + }, + "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 details of a single admin.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, + { + "name": "Set an admin to away", + "tags": [ + "Admins" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/admins/{admin_id}/away", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "admins", + "{admin_id}", + "away" + ], + "query": [], + "variable": [ + { + "key": "admin_id", + "value": "admin_id", + "disabled": false, + "description": "The unique identifier of a given admin" + } + ] + }, + "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 set an Admin as away for the Inbox.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"away_mode_enabled\": true,\n \"away_mode_reassign\": false\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Articles", + "item": [ { "name": "List all articles", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "articles" + ], + "query": [ + { + "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" + } + ], + "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 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": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Retrieve an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/articles/{article_id}", + "raw": "https://api.intercom.io/articles/{article_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "articles", "{article_id}" + ], + "query": [], + "variable": [ + { + "key": "article_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article 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 article by making a GET request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Search for articles", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/articles/search", + "raw": "https://api.intercom.io/articles/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "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." + } + ], + "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 search for articles by making a GET request to `https://api.intercom.io/articles/search`.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all collections", + "name": "Create an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections", + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections" + "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" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a collection", + "name": "Update an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections/{collection_id}", + "raw": "https://api.intercom.io/articles/{article_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", - "{collection_id}" + "articles", + "{article_id}" + ], + "query": [], + "variable": [ + { + "key": "article_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "description": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Retrieve a Help Center", - "request": { - "method": "GET", - "url": { - "raw": "/help_center/help_centers/{help_center_id}", - "path": [ - "help_center", - "help_centers", - "{help_center_id}" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "PUT", + "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all Help Centers", + "name": "Delete an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/help_centers", + "raw": "https://api.intercom.io/articles/{article_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "help_centers" + "articles", + "{article_id}" + ], + "query": [], + "variable": [ + { + "key": "article_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "description": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", - "header": [], - "body": {} + "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 article by making a DELETE request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Companies", + "item": [ { "name": "Retrieve companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "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" + } + ], + "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 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": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Retrieve a company by ID", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{company_id}", + "raw": "https://api.intercom.io/companies/{company_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", "{company_id}" + ], + "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" + } ] }, + "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 company.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List attached contacts", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{company_id}/contacts", + "raw": "https://api.intercom.io/companies/{company_id}/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", "{company_id}", "contacts" + ], + "query": [ + { + "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" + } + ], + "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", + "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 contacts that belong to a company.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List attached segments for companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{company_id}/segments", + "raw": "https://api.intercom.io/companies/{company_id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", "{company_id}", "segments" + ], + "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" + } ] }, + "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 segments that belong to a company.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Scroll over all companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/scroll", + "raw": "https://api.intercom.io/companies/scroll", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", "scroll" + ], + "query": [ + { + "key": "scroll_param", + "value": "scroll_param", + "description": "" + } + ], + "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": " 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": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached companies for contact", + "name": "Create or Update a company", + "tags": [ + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies" + ], + "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 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": "2.11" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "List all companies", + "tags": [ + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/companies/list", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "list" + ], + "query": [ + { + "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", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "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", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Attach a Contact to a Company", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/companies", + "raw": "https://api.intercom.io/contacts/{contact_id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "companies" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "contact_id", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can fetch a list of companies that are associated to a contact.", - "header": [], - "body": {} + "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 attach a company to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"58a430d35458202d41b1e65b\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all notes", + "name": "Update a company", + "tags": [ + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/companies/{company_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "{company_id}" + ], + "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" + } + ] + }, + "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 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", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Delete a company", + "tags": [ + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/companies/{company_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "{company_id}" + ], + "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" + } + ] + }, + "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 company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Detach a contact from a company", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/notes", + "raw": "https://api.intercom.io/contacts/{contact_id}/companies/{company_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", - "notes" + "companies", + "{company_id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "58a430d35458202d41b1e65b", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "company_id", + "value": "58a430d35458202d41b1e65b", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch a list of notes that are associated to a contact.", - "header": [], - "body": {} + "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 detach a company from a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Contacts", + "item": [ + { + "name": "List attached companies for contact", + "tags": [ + "Contacts", + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{contact_id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{contact_id}", + "companies" + ], + "query": [ + { + "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" + } + ], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 a list of companies that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List attached segments for contact", + "tags": [ + "Contacts", + "Segments" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/segments", + "raw": "https://api.intercom.io/contacts/{contact_id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "segments" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 a list of segments that are associated to a contact.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List subscriptions for a contact", + "tags": [ + "Contacts", + "Subscription Types" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 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", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List tags attached to a contact", + "tags": [ + "Contacts", + "Tags" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 a list of all tags that are attached to a specific contact.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Get a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}", + "raw": "https://api.intercom.io/contacts/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "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": "GET", "description": "You can fetch the details of a single contact.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List all contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts" + ], + "query": [ + { + "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" + }, + { + "key": "starting_after", + "value": "starting_after", + "description": "String used to get the next page of conversations." + } + ], + "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 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", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all conversations", + "name": "Merge a lead and a user", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/contacts/merge", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "contacts", + "merge" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"from\": \"5d70dd30de4efd54f42fd526\",\n \"into\": \"5ba682d23d7cf92bef87bfd4\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a conversation", + "name": "Search contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations/{conversation_id}", + "raw": "https://api.intercom.io/contacts/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}" + "contacts", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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", - "header": [], - "body": {} + "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| 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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "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": "List all data attributes", + "name": "Create contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/data_attributes", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes" + "contacts" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new contact (ie. user or lead).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all data events", + "name": "Archive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/contacts/{contact_id}/archive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "contacts", + "{contact_id}", + "archive" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "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": [], - "body": {} + "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 archive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Show content data export", + "name": "Unarchive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/export/content/data/{job_identifier}", + "raw": "https://api.intercom.io/contacts/{contact_id}/unarchive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data", - "{job_identifier}" + "contacts", + "{contact_id}", + "unarchive" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "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": [], - "body": {} + "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 unarchive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Download content data export", + "name": "Update a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/download/content/data/{job_identifier}", + "raw": "https://api.intercom.io/contacts/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "download", - "content", - "data", - "{job_identifier}" + "contacts", + "{contact_id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "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": [], - "body": {} + "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 contact (ie. user or lead).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all news items", + "name": "Delete a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/contacts/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items" + "contacts", + "{contact_id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "contact_id", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch a list of all news items", - "header": [], - "body": {} + "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": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Conversations", + "item": [ { - "name": "Retrieve a news item", + "name": "List all conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items/{news_item_id}", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{news_item_id}" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single news item.", - "header": [], - "body": {} + "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": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all live newsfeed items", + "name": "Retrieve a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{newsfeed_id}/items", + "raw": "https://api.intercom.io/conversations/{conversation_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", - "{newsfeed_id}", - "items" + "conversations", + "{conversation_id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "conversation_id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can fetch a list of all news items that are live on a given newsfeed", - "header": [], - "body": {} + "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.\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": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all newsfeeds", + "name": "Creates a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds" + "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" + } ] }, - "description": "You can fetch a list of all newsfeeds", - "header": [], - "body": {} + "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": "2.11" + }, + { + "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 \"created_at\": 1671028894\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a newsfeed", + "name": "Search conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{newsfeed_id}", + "raw": "https://api.intercom.io/conversations/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", - "{newsfeed_id}" + "conversations", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single newsfeed", - "header": [], - "body": {} + "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 as part of the The conversation model is 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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "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": "Retrieve a note", + "name": "Reply to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/notes/{note_id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "notes", - "{note_id}" + "conversations", + "{conversation_id}", + "reply" + ], + "query": [], + "variable": [ + { + "key": "conversation_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" + } ] }, - "description": "You can fetch the details of a single note.", - "header": [], - "body": {} + "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.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "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 \"admin_id\": \"3156780\",\n \"attachment_files\": [\n {\n \"content_type\": \"application/json\",\n \"data\": \"ewogICJ0ZXN0IjogMQp9\",\n \"name\": \"test.json\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all segments", + "name": "Manage a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/segments", + "raw": "https://api.intercom.io/conversations/{conversation_id}/parts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments" + "conversations", + "{conversation_id}", + "parts" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can fetch a list of all segments.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Retrieve a segment", + "name": "Run Assignment Rules on a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/segments/{segment_id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/run_assignment_rules", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments", - "{segment_id}" + "conversations", + "{conversation_id}", + "run_assignment_rules" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can fetch the details of a single segment.", - "header": [], - "body": {} + "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=\"danger\" name=\"Deprecation of Run Assignment Rules\" %}\nRun assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail.\n{% /admonition %}\nYou can let a conversation be automatically assigned following assignment rules.\n{% admonition type=\"warning\" name=\"When using workflows\" %}\nIt is not possible to use this endpoint with Workflows.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List subscription types", + "name": "Attach a contact to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/subscription_types", + "raw": "https://api.intercom.io/conversations/{conversation_id}/customers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "subscription_types" + "conversations", + "{conversation_id}", + "customers" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can list all subscription types. A list of subscription type objects will be returned.", - "header": [], - "body": {} + "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": "2.11" + }, + { + "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": "List all tags", + "name": "Redact a conversation part", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/tags", + "raw": "https://api.intercom.io/conversations/redact", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags" + "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" + } ] }, - "description": "You can fetch a list of all tags for a given workspace.\n\n", - "header": [], - "body": {} + "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": "2.11" + }, + { + "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": "Find a specific tag", + "name": "Convert a conversation to a ticket", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/tags/{tag_id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags", - "{tag_id}" + "conversations", + "{conversation_id}", + "convert" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can fetch the details of tags that are on the workspace by their id.\nThis will return a tag object.\n", - "header": [], - "body": {} + "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": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ticket_type_id\": \"1234\",\n \"attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all teams", + "name": "Update a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/teams", + "raw": "https://api.intercom.io/conversations/{conversation_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams" + "conversations", + "{conversation_id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "conversation_id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "This will return a list of team objects for the App.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"read\": true,\n \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a team", + "name": "Detach a contact from a group conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/teams/{team_id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/customers/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams", - "{team_id}" + "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." + } ] }, - "description": "You can fetch the details of a single team, containing an array of admins that belong to this team.", - "header": [], - "body": {} + "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 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": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"5017690\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Data Attributes", + "item": [ { - "name": "List all ticket types", + "name": "List all data attributes", + "tags": [ + "Data Attributes" + ], "request": { - "method": "GET", "url": { - "raw": "/ticket_types", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can get a list of all ticket types for a workspace.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a ticket type", + "name": "Create a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "GET", "url": { - "raw": "/ticket_types/{ticket_type_id}", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{ticket_type_id}" + "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" + } ] }, - "description": "You can fetch the details of a single ticket type.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a data attributes for a `contact` or a `company`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Data Attribute\",\n \"model\": \"contact\",\n \"data_type\": \"string\",\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a ticket", + "name": "Update a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "GET", "url": { - "raw": "/tickets/{ticket_id}", + "raw": "https://api.intercom.io/data_attributes/{data_attribute_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{ticket_id}" + "data_attributes", + "{data_attribute_id}" + ], + "query": [], + "variable": [ + { + "key": "data_attribute_id", + "value": "1", + "disabled": false, + "description": "The data attribute id" + } ] }, - "description": "You can fetch the details of a single ticket.", - "header": [], - "body": {} + "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": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"archived\": false,\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Data Events", + "item": [ { - "name": "Retrieve a visitor with User ID", + "name": "List all data events", + "tags": [ + "Data Events" + ], "request": { - "method": "GET", "url": { - "raw": "/visitors", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors" + "events" + ], + "query": [ + { + "key": "filter", + "value": "filter" + }, + { + "key": "type", + "value": "type", + "description": "The value must be user" + }, + { + "key": "summary", + "value": "summary", + "description": "summary flag" + }, + { + "key": "per_page", + "value": "15", + "description": "How many results to display per page. Defaults to 15" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single visitor.", - "header": [], - "body": {} + "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": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create an article", + "name": "Submit a data event", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles" + "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" + } ] }, - "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", - "header": [], - "body": {} + "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": "2.11" + }, + { + "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 a collection", + "name": "Create event summaries", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/help_center/collections", + "raw": "https://api.intercom.io/events/summaries", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections" + "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" + } ] }, - "description": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", - "header": [], - "body": {} + "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": "2.11" + }, + { + "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": "Create or Update a company", + "name": "Show content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/export/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies" + "export", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "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": [], - "body": {} + "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": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all companies", + "name": "Download content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/companies/list", + "raw": "https://api.intercom.io/download/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "list" + "download", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "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": [], - "body": {} + "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": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Attach a Contact to a Company", + "name": "Create content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/companies", + "raw": "https://api.intercom.io/export/content/data", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "companies" + "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" + } ] }, - "description": "You can attach a company to a single contact.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "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": "Create a note", + "name": "Cancel content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/notes", + "raw": "https://api.intercom.io/export/cancel/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "notes" + "export", + "cancel", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "description": "You can add a note to a single contact.", - "header": [], - "body": {} + "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": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Help Center", + "item": [ { - "name": "Add subscription to a contact", + "name": "List all collections", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions" + "help_center", + "collections" + ], + "query": [ + { + "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" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", - "header": [], - "body": {} + "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": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Add tag to a contact", + "name": "Retrieve a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/help_center/collections/{collection_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags" + "help_center", + "collections", + "{collection_id}" + ], + "query": [], + "variable": [ + { + "key": "collection_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "description": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", - "header": [], - "body": {} + "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": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Merge a lead and a user", + "name": "Retrieve a Help Center", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/merge", + "raw": "https://api.intercom.io/help_center/help_centers/{help_center_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "merge" + "help_center", + "help_centers", + "{help_center_id}" + ], + "query": [], + "variable": [ + { + "key": "help_center_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the Help Center which is given by Intercom." + } ] }, - "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", - "header": [], - "body": {} + "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": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Search contacts", + "name": "List all Help Centers", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/search", + "raw": "https://api.intercom.io/help_center/help_centers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "search" + "help_center", + "help_centers" + ], + "query": [ + { + "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" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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| 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", - "header": [], - "body": {} + "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": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create contact", + "name": "Create a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts" + "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" + } ] }, - "description": "You can create a new contact (ie. user or lead).", - "header": [], - "body": {} + "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": "2.11" + }, + { + "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": "Archive contact", + "name": "Update a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/archive", + "raw": "https://api.intercom.io/help_center/collections/{collection_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "archive" + "help_center", + "collections", + "{collection_id}" + ], + "query": [], + "variable": [ + { + "key": "collection_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "description": "You can archive a single contact.", - "header": [], - "body": {} + "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": "2.11" + }, + { + "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": "Unarchive contact", + "name": "Delete a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/unarchive", + "raw": "https://api.intercom.io/help_center/collections/{collection_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "unarchive" + "help_center", + "collections", + "{collection_id}" + ], + "query": [], + "variable": [ + { + "key": "collection_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "description": "You can unarchive a single contact.", - "header": [], - "body": {} + "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 collection by making a DELETE request to `https://api.intercom.io/collections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Messages", + "item": [ { - "name": "Add tag to a conversation", + "name": "Create a message", + "tags": [ + "Messages" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{conversation_id}/tags", + "raw": "https://api.intercom.io/messages", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags" + "messages" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\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", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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 \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n \"created_at\": 1590000000,\n \"create_conversation_without_contact_reply\": true\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "News", + "item": [ { - "name": "Creates a conversation", + "name": "List all news items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "news", + "news_items" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all news items", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Search conversations", + "name": "Retrieve a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/search", + "raw": "https://api.intercom.io/news/news_items/{news_item_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "search" + "news", + "news_items", + "{news_item_id}" + ], + "query": [], + "variable": [ + { + "key": "news_item_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "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 as part of the The conversation model is 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", - "header": [], - "body": {} + "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 news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Reply to a conversation", + "name": "List all live newsfeed items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{conversation_id}/reply", + "raw": "https://api.intercom.io/news/newsfeeds/{newsfeed_id}/items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "reply" + "news", + "newsfeeds", + "{newsfeed_id}", + "items" + ], + "query": [], + "variable": [ + { + "key": "newsfeed_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } ] }, - "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.", - "header": [], - "body": {} + "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 news items that are live on a given newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Manage a conversation", + "name": "List all newsfeeds", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{conversation_id}/parts", + "raw": "https://api.intercom.io/news/newsfeeds", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "parts" + "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" + } ] }, - "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", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all newsfeeds", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Run Assignment Rules on a conversation", + "name": "Retrieve a newsfeed", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{conversation_id}/run_assignment_rules", + "raw": "https://api.intercom.io/news/newsfeeds/{newsfeed_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "run_assignment_rules" + "news", + "newsfeeds", + "{newsfeed_id}" + ], + "query": [], + "variable": [ + { + "key": "newsfeed_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } ] }, - "description": "{% admonition type=\"danger\" name=\"Deprecation of Run Assignment Rules\" %}\nRun assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail.\n{% /admonition %}\nYou can let a conversation be automatically assigned following assignment rules.\n{% admonition type=\"warning\" name=\"When using workflows\" %}\nIt is not possible to use this endpoint with Workflows.\n{% /admonition %}\n", - "header": [], - "body": {} + "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 newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Attach a contact to a conversation", + "name": "Create a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{conversation_id}/customers", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "customers" + "news", + "news_items" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can create a news item", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Redact a conversation part", + "name": "Update a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/redact", + "raw": "https://api.intercom.io/news/news_items/{news_item_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "redact" + "news", + "news_items", + "{news_item_id}" + ], + "query": [], + "variable": [ + { + "key": "news_item_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "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": [], - "body": {} + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Convert a conversation to a ticket", + "name": "Delete a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{conversation_id}/convert", + "raw": "https://api.intercom.io/news/news_items/{news_item_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "convert" + "news", + "news_items", + "{news_item_id}" + ], + "query": [], + "variable": [ + { + "key": "news_item_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "description": "You can convert a conversation to a ticket.", - "header": [], - "body": {} + "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 news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Notes", + "item": [ { - "name": "Create a data attribute", + "name": "List all notes", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/data_attributes", + "raw": "https://api.intercom.io/contacts/{contact_id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes" + "contacts", + "{contact_id}", + "notes" + ], + "query": [ + { + "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" + } + ], + "variable": [ + { + "key": "contact_id", + "value": "contact_id", + "disabled": false, + "description": "The unique identifier of a contact." + } ] }, - "description": "You can create a data attributes for a `contact` or a `company`.", - "header": [], - "body": {} + "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 notes that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Submit a data event", + "name": "Retrieve a note", + "tags": [ + "Notes" + ], "request": { - "method": "POST", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/notes/{note_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "notes", + "{note_id}" + ], + "query": [], + "variable": [ + { + "key": "note_id", + "value": "1", + "disabled": false, + "description": "The unique identifier of a given note" + } ] }, - "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": [], - "body": {} + "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 note.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create event summaries", + "name": "Create a note", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/events/summaries", + "raw": "https://api.intercom.io/contacts/{contact_id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events", - "summaries" + "contacts", + "{contact_id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given contact." + } ] }, - "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": [], - "body": {} + "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 a note to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"body\": \"New note\",\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Segments", + "item": [ { - "name": "Create content data export", + "name": "List all segments", + "tags": [ + "Segments" + ], "request": { - "method": "POST", "url": { - "raw": "/export/content/data", + "raw": "https://api.intercom.io/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data" + "segments" + ], + "query": [ + { + "key": "include_count", + "value": "true", + "description": "It includes the count of contacts that belong to each segment." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all segments.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Cancel content data export", + "name": "Retrieve a segment", + "tags": [ + "Segments" + ], "request": { - "method": "POST", "url": { - "raw": "/export/cancel/{job_identifier}", + "raw": "https://api.intercom.io/segments/{segment_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "cancel", - "{job_identifier}" + "segments", + "{segment_id}" + ], + "query": [], + "variable": [ + { + "key": "segment_id", + "value": "123", + "disabled": false, + "description": "The unique identified of a given segment." + } ] }, - "description": "You can cancel your job", - "header": [], - "body": {} + "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 segment.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Subscription Types", + "item": [ { - "name": "Create a message", + "name": "List subscription types", + "tags": [ + "Subscription Types" + ], "request": { - "method": "POST", "url": { - "raw": "/messages", + "raw": "https://api.intercom.io/subscription_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "messages" + "subscription_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\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": [], - "body": {} + "method": "GET", + "description": "You can list all subscription types. A list of subscription type objects will be returned.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a news item", + "name": "Add subscription to a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items" + "contacts", + "{contact_id}", + "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can create a news item", - "header": [], - "body": {} + "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 a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"37846\",\n \"consent_type\": \"opt_in\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Create a phone Switch", + "name": "Remove subscription from a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/phone_call_redirects", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions/{subscription_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "phone_call_redirects" + "contacts", + "{contact_id}", + "subscriptions", + "{subscription_id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "subscription_id", + "value": "37846", + "disabled": false, + "description": "The unique identifier for the subscription type which is given by Intercom" + } ] }, - "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", - "header": [], - "body": {} + "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 a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Switch", + "item": [ { - "name": "Create or update a tag, Tag or untag companies, Tag contacts", + "name": "Create a phone Switch", + "tags": [ + "Switch" + ], "request": { - "method": "POST", "url": { - "raw": "/tags", + "raw": "https://api.intercom.io/phone_call_redirects", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags" + "phone_call_redirects" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", - "header": [], - "body": {} + "method": "POST", + "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"phone\": \"+1 1234567890\",\n \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Tags", + "item": [ { - "name": "Create a new attribute for a ticket type", + "name": "List all tags", + "tags": [ + "Tags" + ], "request": { - "method": "POST", "url": { - "raw": "/ticket_types/{ticket_type_id}/attributes", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{ticket_type_id}", - "attributes" + "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a new attribute for a ticket type.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all tags for a given workspace.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a ticket type", + "name": "Find a specific tag", + "tags": [ + "Tags" + ], "request": { - "method": "POST", "url": { - "raw": "/ticket_types", + "raw": "https://api.intercom.io/tags/{tag_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types" + "tags", + "{tag_id}" + ], + "query": [], + "variable": [ + { + "key": "tag_id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } ] }, - "description": "You can create a new ticket type.\n> 📘 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: _default_title_ and _default_description_.\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", - "header": [], - "body": {} + "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 tags that are on the workspace by their id.\nThis will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Reply to a ticket", + "name": "Add tag to a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/{ticket_id}/reply", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{ticket_id}", - "reply" + "contacts", + "{contact_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins.", - "header": [], - "body": {} + "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 tag a specific contact. This will return a tag object for the tag that was added to the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Add tag to a ticket", + "name": "Add tag to a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/{ticket_id}/tags", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{ticket_id}", + "conversations", + "{conversation_id}", "tags" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + } ] }, - "description": "You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", - "header": [], - "body": {} + "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 tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"780\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Create a ticket", + "name": "Create or update a tag, Tag or untag companies, Tag contacts", + "tags": [ + "Tags" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets" + "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a new ticket.", - "header": [], - "body": {} + "method": "POST", + "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Independent\",\n \"id\": \"656452352\",\n \"companies\": [\n {\n \"id\": \"531ee472cce572a6ec000006\",\n \"company_id\": \"6\",\n \"untag\": true\n }\n ],\n \"users\": [\n {\n \"id\": \"5f7f0d217289f8d2f4262080\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Search tickets", + "name": "Add tag to a ticket", + "tags": [ + "Tags", + "Tickets" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/search", + "raw": "https://api.intercom.io/tickets/{ticket_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "tickets", - "search" + "{ticket_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "64619700005694", + "disabled": false, + "description": "ticket_id" + } ] }, - "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\"`).\n\n| Field | Type |\n| :---------------------------------------- | :--------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| _default_title_ | String |\n| _default_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### 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": [], - "body": {} + "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 tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"780\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Convert a visitor", + "name": "Remove tag from a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/visitors/convert", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags/{tag_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors", - "convert" + "contacts", + "{contact_id}", + "tags", + "{tag_id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "tag_id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier for the tag which is given by Intercom" + } ] }, - "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": [], - "body": {} - }, - "response": [] - }, - { - "name": "Set an admin to away", - "request": { - "method": "PUT", - "url": { - "raw": "/admins/{admin_id}/away", - "path": [ - "admins", - "{admin_id}", - "away" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can set an Admin as away for the Inbox.", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update an article", + "name": "Remove tag from a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "PUT", "url": { - "raw": "/articles/{article_id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags/{tag_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", - "{article_id}" + "conversations", + "{conversation_id}", + "tags", + "{tag_id}" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + }, + { + "key": "tag_id", + "value": "7522907", + "disabled": false, + "description": "id" + } ] }, - "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Update a collection", - "request": { - "method": "PUT", - "url": { - "raw": "/help_center/collections/{collection_id}", - "path": [ - "help_center", - "collections", - "{collection_id}" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a company", + "name": "Delete tag", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/companies/{company_id}", + "raw": "https://api.intercom.io/tags/{tag_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "{company_id}" + "tags", + "{tag_id}" + ], + "query": [], + "variable": [ + { + "key": "tag_id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } ] }, - "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": [], - "body": {} + "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 the details of tags that are on the workspace by passing in the id.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a contact", + "name": "Remove tag from a ticket", + "tags": [ + "Tags", + "Tickets" + ], "request": { - "method": "PUT", "url": { - "raw": "/contacts/{contact_id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}/tags/{tag_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}" + "tickets", + "{ticket_id}", + "tags", + "{tag_id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "64619700005694", + "disabled": false, + "description": "ticket_id" + }, + { + "key": "tag_id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier for the tag which is given by Intercom" + } ] }, - "description": "You can update an existing contact (ie. user or lead).", - "header": [], - "body": {} + "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 tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Teams", + "item": [ { - "name": "Update a conversation", + "name": "List all teams", + "tags": [ + "Teams" + ], "request": { - "method": "PUT", "url": { - "raw": "/conversations/{conversation_id}", + "raw": "https://api.intercom.io/teams", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}" + "teams" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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", - "header": [], - "body": {} + "method": "GET", + "description": "This will return a list of team objects for the App.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a data attribute", + "name": "Retrieve a team", + "tags": [ + "Teams" + ], "request": { - "method": "PUT", "url": { - "raw": "/data_attributes/{data_attribute_id}", + "raw": "https://api.intercom.io/teams/{team_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes", - "{data_attribute_id}" + "teams", + "{team_id}" + ], + "query": [], + "variable": [ + { + "key": "team_id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given team." + } ] }, - "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": [], - "body": {} + "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 team, containing an array of admins that belong to this team.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Ticket Type Attributes", + "item": [ { - "name": "Update a news item", + "name": "Create a new attribute for a ticket type", + "tags": [ + "Ticket Type Attributes" + ], "request": { - "method": "PUT", "url": { - "raw": "/news/news_items/{news_item_id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{news_item_id}" + "ticket_types", + "{ticket_type_id}", + "attributes" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type 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" + } ] }, - "description": "", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new attribute for a ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug Priority\",\n \"description\": \"Priority level of the bug\",\n \"data_type\": \"string\",\n \"required_to_create\": false,\n \"required_to_create_for_contacts\": false,\n \"visible_on_create\": true,\n \"visible_to_contacts\": true,\n \"multiline\": false,\n \"list_items\": \"Low Priority,Medium Priority,High Priority\",\n \"allow_multiple_values\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { "name": "Update an existing attribute for a ticket type", + "tags": [ + "Ticket Type Attributes" + ], "request": { - "method": "PUT", "url": { - "raw": "/ticket_types/{ticket_type_id}/attributes/{attribute_id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes/{attribute_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "ticket_types", "{ticket_type_id}", "attributes", "{attribute_id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + }, + { + "key": "attribute_id", + "value": "attribute_id", + "disabled": false, + "description": "The unique identifier for the ticket type attribute 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 an existing attribute for a ticket type.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug Priority\",\n \"description\": \"Priority level of the bug\",\n \"required_to_create\": false,\n \"required_to_create_for_contacts\": false,\n \"visible_on_create\": true,\n \"visible_to_contacts\": true,\n \"multiline\": false,\n \"list_items\": \"Low Priority,Medium Priority,High Priority\",\n \"allow_multiple_values\": false,\n \"archived\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Ticket Types", + "item": [ { - "name": "Update a ticket type", + "name": "List all ticket types", + "tags": [ + "Ticket Types" + ], "request": { - "method": "PUT", "url": { - "raw": "/ticket_types/{ticket_type_id}", + "raw": "https://api.intercom.io/ticket_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{ticket_type_id}" + "ticket_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "\nYou can update a ticket type.\n\n> 📘 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", - "header": [], - "body": {} + "method": "GET", + "description": "You can get a list of all ticket types for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a ticket", + "name": "Retrieve a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "PUT", "url": { - "raw": "/tickets/{ticket_id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{ticket_id}" + "ticket_types", + "{ticket_type_id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } ] }, - "description": "You can update a ticket.", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Update a visitor", - "request": { - "method": "PUT", - "url": { - "raw": "/visitors", - "path": [ - "visitors" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete an article", + "name": "Create a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/articles/{article_id}", + "raw": "https://api.intercom.io/ticket_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", - "{article_id}" + "ticket_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new ticket type.\n> 📘 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: _default_title_ and _default_description_.\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug\",\n \"description\": \"Used for tracking bugs\",\n \"category\": \"Customer\",\n \"icon\": \"🐞\",\n \"is_internal\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a collection", + "name": "Update a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/help_center/collections/{collection_id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", - "{collection_id}" + "ticket_types", + "{ticket_type_id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } ] }, - "description": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Delete a company", - "request": { - "method": "DELETE", - "url": { - "raw": "/companies/{company_id}", - "path": [ - "companies", - "{company_id}" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single company.", - "header": [], - "body": {} + "method": "PUT", + "description": "\nYou can update a ticket type.\n\n> 📘 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug\",\n \"description\": \"A bug has been occured\",\n \"category\": \"Customer\",\n \"icon\": \"🐞\",\n \"archived\": false,\n \"is_internal\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Tickets", + "item": [ { - "name": "Detach a contact from a company", + "name": "Retrieve a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/companies/{company_id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "companies", - "{company_id}" + "tickets", + "{ticket_id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "ticket_id", + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom." + } ] }, - "description": "You can detach a company from a single contact.", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Remove subscription from a contact", - "request": { - "method": "DELETE", - "url": { - "raw": "/contacts/{contact_id}/subscriptions/{subscription_id}", - "path": [ - "contacts", - "{contact_id}", - "subscriptions", - "{subscription_id}" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Remove tag from a contact", + "name": "Reply to a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/tags/{tag_id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags", - "{tag_id}" + "tickets", + "{ticket_id}", + "reply" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "ticket_id", + "disabled": false + } ] }, - "description": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", - "header": [], - "body": {} + "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 ticket with a message from an admin or on behalf of a contact, or with a note for admins.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "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 \"admin_id\": \"3156780\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a contact", + "name": "Create a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}", + "raw": "https://api.intercom.io/tickets", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}" + "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" + } ] }, - "description": "You can delete a single contact.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "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 \"company_id\": \"1234\",\n \"created_at\": 1590000000,\n \"ticket_attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Remove tag from a conversation", + "name": "Search tickets", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{conversation_id}/tags/{tag_id}", + "raw": "https://api.intercom.io/tickets/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags", - "{tag_id}" + "tickets", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", - "header": [], - "body": {} + "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\"`).\n\n| Field | Type |\n| :---------------------------------------- | :--------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| _default_title_ | String |\n| _default_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### 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": "2.11" + }, + { + "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": "Detach a contact from a group conversation", + "name": "Update a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{conversation_id}/customers/{contact_id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "customers", - "{contact_id}" + "tickets", + "{ticket_id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "ticket_id", + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 a ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ticket_attributes\": {\n \"_default_title_\": \"example\",\n \"_default_description_\": \"having a problem\"\n },\n \"state\": \"submitted\",\n \"open\": true,\n \"is_shared\": true,\n \"snoozed_until\": 1673609604,\n \"assignment\": {\n \"admin_id\": \"123\",\n \"assignee_id\": \"123\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Visitors", + "item": [ { - "name": "Delete a news item", + "name": "Retrieve a visitor with User ID", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/news/news_items/{news_item_id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{news_item_id}" + "visitors" + ], + "query": [ + { + "key": "user_id", + "value": "user_id", + "description": "The user_id of the Visitor you want to retrieve." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single news item.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single visitor.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.11" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete tag", + "name": "Convert a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/tags/{tag_id}", + "raw": "https://api.intercom.io/visitors/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags", - "{tag_id}" + "visitors", + "convert" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete the details of tags that are on the workspace by passing in the id.", - "header": [], - "body": {} + "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": "2.11" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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": "Remove tag from a ticket", + "name": "Update a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/tickets/{ticket_id}/tags/{tag_id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{ticket_id}", - "tags", - "{tag_id}" + "visitors" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.", - "header": [], - "body": {} + "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": "2.11" + }, + { + "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": [] + } }, "response": [] } @@ -1883,28 +7248,7 @@ "event": [], "variable": [ { - "id": "7eb39327-d036-4126-9f9f-a8b6df1432f7", - "key": "https://api.intercom.io", - "value": "https://api.intercom.io", - "type": "string", - "description": "The production API server" - }, - { - "id": "468c1f33-6f74-4305-83db-78167eae312b", - "key": "https://api.eu.intercom.io", - "value": "https://api.eu.intercom.io", - "type": "string", - "description": "The european API server" - }, - { - "id": "58514801-c6c1-4e16-9ae3-a0ff7e4b346d", - "key": "https://api.au.intercom.io", - "value": "https://api.au.intercom.io", - "type": "string", - "description": "The australian API server" - }, - { - "id": "f1c85242-77d8-4df3-ad18-bef5eaa5c26a", + "id": "367fdd6b-d8af-49af-82be-725e50679c86", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/postman/2.12/README.md b/postman/2.12/README.md index 42b0887..5f6584a 100644 --- a/postman/2.12/README.md +++ b/postman/2.12/README.md @@ -12,4 +12,4 @@ This directory contains the Postman collection for Intercom API version 2.12. 3. Set your access token in the environment variables 4. Start making API calls! -Last updated: 2025-04-15T14:40:02.870Z +Last updated: 2025-04-25T10:49:25.046Z diff --git a/postman/2.12/intercom-api.postman_collection.json b/postman/2.12/intercom-api.postman_collection.json index d388582..1e58199 100644 --- a/postman/2.12/intercom-api.postman_collection.json +++ b/postman/2.12/intercom-api.postman_collection.json @@ -8,2046 +8,7742 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-04-15T14:40:02.869Z" + "updatedAt": "2025-04-25T10:49:25.043Z" }, "item": [ { - "name": "General", + "name": "AI Content", "item": [ { - "name": "Identify an admin", + "name": "List content import sources", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/me", + "raw": "https://api.intercom.io/ai/content_import_sources", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "me" + "ai", + "content_import_sources" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "\nYou can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology).\n\n> 🚧 Single Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.\n", - "header": [], - "body": {} + "method": "GET", + "description": "You can retrieve a list of all content import sources for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all activity logs", + "name": "Retrieve a content import source", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/activity_logs", + "raw": "https://api.intercom.io/ai/content_import_sources/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins", - "activity_logs" + "ai", + "content_import_sources", + "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can get a log of activities by all admins in an app.", - "header": [], - "body": {} + "method": "GET", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all admins", + "name": "List external pages", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/admins", + "raw": "https://api.intercom.io/ai/external_pages", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins" + "ai", + "external_pages" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of admins for a given workspace.", - "header": [], - "body": {} + "method": "GET", + "description": "You can retrieve a list of all external pages for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve an admin", + "name": "Retrieve an external page", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/{id}", + "raw": "https://api.intercom.io/ai/external_pages/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins", + "ai", + "external_pages", "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can retrieve the details of a single admin.", - "header": [], - "body": {} + "method": "GET", + "description": "You can retrieve an external page.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List content import sources", + "name": "Create a content import source", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/ai/content_import_sources", + "raw": "https://api.intercom.io/ai/content_import_sources", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "ai", "content_import_sources" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can retrieve a list of all content import sources for a workspace.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new content import source by sending a POST request to this endpoint.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"sync_behavior\": \"api\",\n \"status\": \"active\",\n \"url\": \"https://help.example.com\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a content import source", + "name": "Create an external page (or update an external page by external ID)", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/ai/content_import_sources/{id}", + "raw": "https://api.intercom.io/ai/external_pages", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "ai", - "content_import_sources", - "{id}" + "external_pages" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List external pages", + "name": "Update a content import source", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/ai/external_pages", + "raw": "https://api.intercom.io/ai/content_import_sources/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "ai", - "external_pages" + "content_import_sources", + "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can retrieve a list of all external pages for a workspace.", - "header": [], - "body": {} + "method": "PUT", + "description": "You can update an existing content import source.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"sync_behavior\": \"api\",\n \"status\": \"active\",\n \"url\": \"https://help.example.com\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve an external page", + "name": "Update an external page", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/ai/external_pages/{id}", + "raw": "https://api.intercom.io/ai/external_pages/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "ai", "external_pages", "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can retrieve an external page.", - "header": [], - "body": {} + "method": "PUT", + "description": "You can update an existing external page (if it was created via the API).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all articles", + "name": "Delete a content import source", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/ai/content_import_sources/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles" + "ai", + "content_import_sources", + "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "DELETE", + "description": "You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve an article", + "name": "Delete an external page", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/ai/external_pages/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", + "ai", + "external_pages", "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "method": "DELETE", + "description": "Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Admins", + "item": [ { - "name": "Search for articles", + "name": "Identify an admin", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/articles/search", + "raw": "https://api.intercom.io/me", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", - "search" + "me" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.", - "header": [], - "body": {} + "method": "GET", + "description": "\nYou can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology).\n\n> 🚧 Single Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all collections", + "name": "List all activity logs", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections", + "raw": "https://api.intercom.io/admins/activity_logs", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections" + "admins", + "activity_logs" + ], + "query": [ + { + "key": "created_at_after", + "value": "1677253093", + "description": "The start date that you request data for. It must be formatted as a UNIX timestamp." + }, + { + "key": "created_at_before", + "value": "1677861493", + "description": "The end date that you request data for. It must be formatted as a UNIX timestamp." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can get a log of activities by all admins in an app.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a collection", + "name": "List all admins", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/admins", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", - "{id}" + "admins" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of admins for a given workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a Help Center", + "name": "Retrieve an admin", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/help_centers/{id}", + "raw": "https://api.intercom.io/admins/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "help_centers", + "admins", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given admin" + } ] }, - "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": [], - "body": {} + "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 details of a single admin.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all Help Centers", + "name": "Set an admin to away", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/help_centers", + "raw": "https://api.intercom.io/admins/{id}/away", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "help_centers" + "admins", + "{id}", + "away" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a given admin" + } ] }, - "description": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", - "header": [], - "body": {} + "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 set an Admin as away for the Inbox.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"away_mode_enabled\": true,\n \"away_mode_reassign\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Articles", + "item": [ { - "name": "Retrieve companies", + "name": "List all articles", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies" + "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" + } ] }, - "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": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a company by ID", + "name": "Retrieve an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", + "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "description": "You can fetch a single company.", - "header": [], - "body": {} + "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 article by making a GET request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached contacts", + "name": "Search for articles", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}/contacts", + "raw": "https://api.intercom.io/articles/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "{id}", - "contacts" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of all contacts that belong to a company.", - "header": [], - "body": {} + "method": "GET", + "description": "You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached segments for companies", + "name": "Create an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}/segments", + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "{id}", - "segments" + "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" + } ] }, - "description": "You can fetch a list of all segments that belong to a company.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Scroll over all companies", + "name": "Update an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/scroll", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "scroll" + "articles", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 article by making a PUT request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List attached companies for contact", + "name": "Delete an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}/companies", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "companies" + "articles", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "description": "You can fetch a list of companies that are associated to a contact.", - "header": [], - "body": {} + "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 article by making a DELETE request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Companies", + "item": [ { - "name": "List all notes", + "name": "Retrieve companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}/notes", + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "notes" + "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" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of notes that are associated to a contact.", - "header": [], - "body": {} + "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": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached segments for contact", + "name": "Retrieve a company by ID", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/segments", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "segments" + "companies", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch a list of segments that are associated to a contact.", - "header": [], - "body": {} + "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 company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List subscriptions for a contact", + "name": "List attached contacts", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/companies/{id}/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions" + "companies", + "{id}", + "contacts" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "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", - "header": [], - "body": {} + "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 contacts that belong to a company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List tags attached to a contact", + "name": "List attached segments for companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/companies/{id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags" + "companies", + "{id}", + "segments" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch a list of all tags that are attached to a specific contact.", - "header": [], - "body": {} + "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 segments that belong to a company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Get a contact", + "name": "Scroll over all companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/companies/scroll", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}" + "companies", + "scroll" + ], + "query": [ + { + "key": "scroll_param", + "value": "scroll_param", + "description": "" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single contact.", - "header": [], - "body": {} + "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", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all contacts", + "name": "Create or Update a company", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts", + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts" + "companies" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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", - "header": [], - "body": {} + "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": "2.12" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all conversations", + "name": "List all companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/companies/list", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "companies", + "list" + ], + "query": [ + { + "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", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "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", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a conversation", + "name": "Attach a Contact to a Company", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/contacts/{id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}" + "contacts", + "{id}", + "companies" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "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", - "header": [], - "body": {} + "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 attach a company to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"58a430d35458202d41b1e65b\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all data attributes", + "name": "Update a company", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/data_attributes", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes" + "companies", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", - "header": [], - "body": {} + "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 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", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all data events", + "name": "Delete a company", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "companies", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Show content data export", + "name": "Detach a contact from a company", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/export/content/data/{job_identifier}", + "raw": "https://api.intercom.io/contacts/{contact_id}/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data", - "{job_identifier}" + "contacts", + "{contact_id}", + "companies", + "{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", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 detach a company from a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Contacts", + "item": [ { - "name": "Download content data export", + "name": "List attached companies for contact", + "tags": [ + "Contacts", + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/download/content/data/{job_identifier}", + "raw": "https://api.intercom.io/contacts/{id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "download", - "content", - "data", - "{job_identifier}" + "contacts", + "{id}", + "companies" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 companies that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all news items", + "name": "List attached segments for contact", + "tags": [ + "Contacts", + "Segments" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/contacts/{contact_id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items" + "contacts", + "{contact_id}", + "segments" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can fetch a list of all news items", - "header": [], - "body": {} + "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 segments that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a news item", + "name": "List subscriptions for a contact", + "tags": [ + "Contacts", + "Subscription Types" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{id}" + "contacts", + "{contact_id}", + "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can fetch the details of a single news item.", - "header": [], - "body": {} + "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 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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all live newsfeed items", + "name": "List tags attached to a contact", + "tags": [ + "Contacts", + "Tags" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{id}/items", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", - "{id}", - "items" + "contacts", + "{contact_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can fetch a list of all news items that are live on a given newsfeed", - "header": [], - "body": {} + "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 tags that are attached to a specific contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all newsfeeds", + "name": "Get a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds" + "contacts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch a list of all newsfeeds", - "header": [], - "body": {} + "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 contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a newsfeed", + "name": "List all contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{id}", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", - "{id}" + "contacts" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single newsfeed", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a note", + "name": "Merge a lead and a user", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/notes/{id}", + "raw": "https://api.intercom.io/contacts/merge", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "notes", - "{id}" + "contacts", + "merge" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single note.", - "header": [], - "body": {} + "method": "POST", + "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"from\": \"5d70dd30de4efd54f42fd526\",\n \"into\": \"5ba682d23d7cf92bef87bfd4\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all segments", + "name": "Search contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/segments", + "raw": "https://api.intercom.io/contacts/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments" + "contacts", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of all segments.", - "header": [], - "body": {} + "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| 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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "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": "Retrieve a segment", + "name": "Create contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/segments/{id}", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments", - "{id}" + "contacts" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single segment.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new contact (ie. user or lead).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List subscription types", + "name": "Archive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/subscription_types", + "raw": "https://api.intercom.io/contacts/{id}/archive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "subscription_types" + "contacts", + "{id}", + "archive" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "description": "You can list all subscription types. A list of subscription type objects will be returned.", - "header": [], - "body": {} + "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 archive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all tags", + "name": "Unarchive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/tags", + "raw": "https://api.intercom.io/contacts/{id}/unarchive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags" + "contacts", + "{id}", + "unarchive" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch a list of all tags for a given workspace.\n\n", - "header": [], - "body": {} + "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 unarchive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Find a specific tag", + "name": "Update a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/tags/{id}", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags", + "contacts", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch the details of tags that are on the workspace by their id.\nThis will return a tag object.\n", - "header": [], - "body": {} + "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 contact (ie. user or lead).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all teams", + "name": "Delete a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/teams", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams" + "contacts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "id" + } ] }, - "description": "This will return a list of team objects for the App.", - "header": [], - "body": {} + "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": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Conversations", + "item": [ { - "name": "Retrieve a team", + "name": "List all conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/teams/{id}", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams", - "{id}" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single team, containing an array of admins that belong to this team.", - "header": [], - "body": {} + "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": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all ticket states", + "name": "Retrieve a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/ticket_states", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_states" + "conversations", + "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can get a list of all ticket states for a workspace.", - "header": [], - "body": {} + "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.\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": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all ticket types", + "name": "Creates a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/ticket_types", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types" + "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" + } ] }, - "description": "You can get a list of all ticket types for a workspace.", - "header": [], - "body": {} + "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": "2.12" + }, + { + "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 \"created_at\": 1671028894\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a ticket type", + "name": "Search conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/ticket_types/{id}", + "raw": "https://api.intercom.io/conversations/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{id}" + "conversations", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single ticket type.", - "header": [], - "body": {} + "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 as part of 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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "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": "Retrieve a ticket", + "name": "Reply to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/tickets/{id}", + "raw": "https://api.intercom.io/conversations/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{id}" + "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" + } ] }, - "description": "You can fetch the details of a single ticket.", - "header": [], - "body": {} + "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.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "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 \"admin_id\": \"3156780\",\n \"attachment_files\": [\n {\n \"content_type\": \"application/json\",\n \"data\": \"ewogICJ0ZXN0IjogMQp9\",\n \"name\": \"test.json\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a visitor with User ID", + "name": "Manage a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/visitors", + "raw": "https://api.intercom.io/conversations/{id}/parts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors" + "conversations", + "{id}", + "parts" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can fetch the details of a single visitor.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Create a content import source", + "name": "Attach a contact to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "POST", "url": { - "raw": "/ai/content_import_sources", + "raw": "https://api.intercom.io/conversations/{id}/customers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "content_import_sources" + "conversations", + "{id}", + "customers" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can create a new content import source by sending a POST request to this endpoint.", - "header": [], - "body": {} + "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": "2.12" + }, + { + "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": "Create an external page (or update an external page by external ID)", + "name": "Redact a conversation part", + "tags": [ + "Conversations" + ], "request": { - "method": "POST", "url": { - "raw": "/ai/external_pages", + "raw": "https://api.intercom.io/conversations/redact", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "external_pages" + "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" + } ] }, - "description": "You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead.", - "header": [], - "body": {} + "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": "2.12" + }, + { + "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": "Create an article", + "name": "Convert a conversation to a ticket", + "tags": [ + "Conversations" + ], "request": { - "method": "POST", "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/conversations/{id}/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles" + "conversations", + "{id}", + "convert" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", - "header": [], - "body": {} + "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": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ticket_type_id\": \"1234\",\n \"attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Create a collection", + "name": "Update a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "POST", "url": { - "raw": "/help_center/collections", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections" + "conversations", + "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"read\": true,\n \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Create or Update a company", + "name": "Detach a contact from a group conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "POST", "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/conversations/{conversation_id}/customers/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies" + "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." + } ] }, - "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": [], - "body": {} + "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 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": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"5017690\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Data Attributes", + "item": [ { - "name": "List all companies", + "name": "List all data attributes", + "tags": [ + "Data Attributes" + ], "request": { - "method": "POST", "url": { - "raw": "/companies/list", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "list" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Attach a Contact to a Company", + "name": "Create a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/companies", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "companies" + "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" + } ] }, - "description": "You can attach a company to a single contact.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a data attributes for a `contact` or a `company`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Data Attribute\",\n \"model\": \"contact\",\n \"data_type\": \"string\",\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Create a note", + "name": "Update a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/notes", + "raw": "https://api.intercom.io/data_attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "notes" + "data_attributes", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "1", + "disabled": false, + "description": "The data attribute id" + } ] }, - "description": "You can add a note to a single contact.", - "header": [], - "body": {} + "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": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"archived\": false,\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Data Events", + "item": [ { - "name": "Add subscription to a contact", + "name": "List all data events", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions" + "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" + } ] }, - "description": "You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", - "header": [], - "body": {} + "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": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Add tag to a contact", + "name": "Submit a data event", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags" + "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" + } ] }, - "description": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", - "header": [], - "body": {} + "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": "2.12" + }, + { + "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": "Merge a lead and a user", + "name": "Create event summaries", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/merge", + "raw": "https://api.intercom.io/events/summaries", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "merge" + "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" + } ] }, - "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", - "header": [], - "body": {} + "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": "2.12" + }, + { + "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": "Search contacts", + "name": "Show content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/search", + "raw": "https://api.intercom.io/export/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "search" + "export", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "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| 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", - "header": [], - "body": {} + "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": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create contact", + "name": "Download content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts", + "raw": "https://api.intercom.io/download/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts" - ] + "download", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } + ] }, - "description": "You can create a new contact (ie. user or lead).", - "header": [], - "body": {} + "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": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Archive contact", + "name": "Create content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/archive", + "raw": "https://api.intercom.io/export/content/data", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "archive" + "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" + } ] }, - "description": "You can archive a single contact.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "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": "Unarchive contact", + "name": "Cancel content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/unarchive", + "raw": "https://api.intercom.io/export/cancel/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "unarchive" + "export", + "cancel", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "description": "You can unarchive a single contact.", - "header": [], - "body": {} + "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": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Help Center", + "item": [ { - "name": "Add tag to a conversation", + "name": "List all collections", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{conversation_id}/tags", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags" + "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" + } ] }, - "description": "You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", - "header": [], - "body": {} + "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": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Creates a conversation", + "name": "Retrieve a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Search conversations", + "name": "Retrieve a Help Center", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/search", + "raw": "https://api.intercom.io/help_center/help_centers/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "search" + "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." + } ] }, - "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 as part of 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", - "header": [], - "body": {} + "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": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Reply to a conversation", + "name": "List all Help Centers", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/reply", + "raw": "https://api.intercom.io/help_center/help_centers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "reply" + "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" + } ] }, - "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.", - "header": [], - "body": {} + "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": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Manage a conversation", + "name": "Create a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/parts", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "parts" + "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" + } ] }, - "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", - "header": [], - "body": {} + "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": "2.12" + }, + { + "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": "Attach a contact to a conversation", + "name": "Update a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/customers", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "customers" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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": "2.12" + }, + { + "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": "Redact a conversation part", + "name": "Delete a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/redact", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "redact" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 collection by making a DELETE request to `https://api.intercom.io/collections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Messages", + "item": [ { - "name": "Convert a conversation to a ticket", + "name": "Create a message", + "tags": [ + "Messages" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/convert", + "raw": "https://api.intercom.io/messages", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "convert" + "messages" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can convert a conversation to a ticket.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\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", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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 \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n \"created_at\": 1590000000,\n \"create_conversation_without_contact_reply\": true\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "News", + "item": [ { - "name": "Create a data attribute", + "name": "List all news items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/data_attributes", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes" + "news", + "news_items" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a data attributes for a `contact` or a `company`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all news items", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Submit a data event", + "name": "Retrieve a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create event summaries", + "name": "List all live newsfeed items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/events/summaries", + "raw": "https://api.intercom.io/news/newsfeeds/{id}/items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events", - "summaries" + "news", + "newsfeeds", + "{id}", + "items" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 news items that are live on a given newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create content data export", + "name": "List all newsfeeds", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/export/content/data", + "raw": "https://api.intercom.io/news/newsfeeds", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data" + "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" + } ] }, - "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", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all newsfeeds", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Cancel content data export", + "name": "Retrieve a newsfeed", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/export/cancel/{job_identifier}", + "raw": "https://api.intercom.io/news/newsfeeds/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "cancel", - "{job_identifier}" + "news", + "newsfeeds", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } ] }, - "description": "You can cancel your job", - "header": [], - "body": {} + "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 newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a message", + "name": "Create a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/messages", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "messages" + "news", + "news_items" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\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": [], - "body": {} + "method": "POST", + "description": "You can create a news item", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Create a news item", + "name": "Update a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "news", - "news_items" + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "description": "You can create a news item", - "header": [], - "body": {} + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Create a phone Switch", + "name": "Delete a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/phone_call_redirects", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "phone_call_redirects" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", - "header": [], - "body": {} + "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 news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Notes", + "item": [ { - "name": "Create or update a tag, Tag or untag companies, Tag contacts", + "name": "List all notes", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/tags", + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags" + "contacts", + "{id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a contact." + } ] }, - "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", - "header": [], - "body": {} + "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 notes that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a new attribute for a ticket type", + "name": "Retrieve a note", + "tags": [ + "Notes" + ], "request": { - "method": "POST", "url": { - "raw": "/ticket_types/{ticket_type_id}/attributes", + "raw": "https://api.intercom.io/notes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{ticket_type_id}", - "attributes" + "notes", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "1", + "disabled": false, + "description": "The unique identifier of a given note" + } ] }, - "description": "You can create a new attribute for a ticket type.", - "header": [], - "body": {} + "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 note.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a ticket type", + "name": "Create a note", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/ticket_types", + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types" + "contacts", + "{id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given contact." + } ] }, - "description": "You can create a new ticket type.\n> 📘 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: _default_title_ and _default_description_.\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", - "header": [], - "body": {} + "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 a note to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"body\": \"New note\",\n \"contact_id\": \"123\",\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Segments", + "item": [ { - "name": "Reply to a ticket", + "name": "List all segments", + "tags": [ + "Segments" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/{id}/reply", + "raw": "https://api.intercom.io/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{id}", - "reply" + "segments" + ], + "query": [ + { + "key": "include_count", + "value": "true", + "description": "It includes the count of contacts that belong to each segment." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all segments.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Add tag to a ticket", + "name": "Retrieve a segment", + "tags": [ + "Segments" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/{ticket_id}/tags", + "raw": "https://api.intercom.io/segments/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{ticket_id}", - "tags" + "segments", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identified of a given segment." + } ] }, - "description": "You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", - "header": [], - "body": {} + "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 segment.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Subscription Types", + "item": [ { - "name": "Create a ticket", + "name": "List subscription types", + "tags": [ + "Subscription Types" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets", + "raw": "https://api.intercom.io/subscription_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets" + "subscription_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a new ticket.", - "header": [], - "body": {} + "method": "GET", + "description": "You can list all subscription types. A list of subscription type objects will be returned.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Search tickets", + "name": "Add subscription to a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/search", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "search" + "contacts", + "{contact_id}", + "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "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| _default_title_ | String |\n| _default_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### 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": [], - "body": {} + "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 a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"37846\",\n \"consent_type\": \"opt_in\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Convert a visitor", + "name": "Remove subscription from a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/visitors/convert", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors", - "convert" + "contacts", + "{contact_id}", + "subscriptions", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "value": "37846", + "disabled": false, + "description": "The unique identifier for the subscription type which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Switch", + "item": [ { - "name": "Set an admin to away", + "name": "Create a phone Switch", + "tags": [ + "Switch" + ], "request": { - "method": "PUT", "url": { - "raw": "/admins/{id}/away", + "raw": "https://api.intercom.io/phone_call_redirects", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins", - "{id}", - "away" + "phone_call_redirects" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can set an Admin as away for the Inbox.", - "header": [], - "body": {} + "method": "POST", + "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"phone\": \"+1 1234567890\",\n \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Tags", + "item": [ { - "name": "Update a content import source", + "name": "List all tags", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/ai/content_import_sources/{id}", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "content_import_sources", - "{id}" + "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can update an existing content import source.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all tags for a given workspace.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update an external page", + "name": "Find a specific tag", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/ai/external_pages/{id}", + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "external_pages", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } ] }, - "description": "You can update an existing external page (if it was created via the API).", - "header": [], - "body": {} + "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 tags that are on the workspace by their id.\nThis will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update an article", + "name": "Add tag to a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", - "{id}" + "contacts", + "{contact_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "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 tag a specific contact. This will return a tag object for the tag that was added to the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a collection", + "name": "Add tag to a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "PUT", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", - "{id}" + "conversations", + "{conversation_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + } ] }, - "description": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} + "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 tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"780\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a company", + "name": "Create or update a tag, Tag or untag companies, Tag contacts", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "{id}" + "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Independent\",\n \"id\": \"656452352\",\n \"companies\": [\n {\n \"id\": \"531ee472cce572a6ec000006\",\n \"company_id\": \"6\",\n \"untag\": \"true\"\n }\n ],\n \"users\": [\n {\n \"id\": \"5f7f0d217289f8d2f4262080\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a contact", + "name": "Add tag to a ticket", + "tags": [ + "Tags", + "Tickets" + ], "request": { - "method": "PUT", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}" + "tickets", + "{ticket_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "64619700005694", + "disabled": false, + "description": "ticket_id" + } ] }, - "description": "You can update an existing contact (ie. user or lead).", - "header": [], - "body": {} + "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 tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"780\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a conversation", + "name": "Remove tag from a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", + "contacts", + "{contact_id}", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier for the tag which is given by Intercom" + } ] }, - "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", - "header": [], - "body": {} + "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 tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a data attribute", + "name": "Remove tag from a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "PUT", "url": { - "raw": "/data_attributes/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes", + "conversations", + "{conversation_id}", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "id" + } ] }, - "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": [], - "body": {} + "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 tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a news item", + "name": "Delete tag", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } ] }, - "description": "", - "header": [], - "body": {} + "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 the details of tags that are on the workspace by passing in the id.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update an existing attribute for a ticket type", + "name": "Remove tag from a ticket", + "tags": [ + "Tags", + "Tickets" + ], "request": { - "method": "PUT", "url": { - "raw": "/ticket_types/{ticket_type_id}/attributes/{id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{ticket_type_id}", - "attributes", + "tickets", + "{ticket_id}", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "64619700005694", + "disabled": false, + "description": "ticket_id" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier for the tag which is given by Intercom" + } ] }, - "description": "You can update an existing attribute for a ticket type.", - "header": [], - "body": {} + "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 tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Teams", + "item": [ { - "name": "Update a ticket type", + "name": "List all teams", + "tags": [ + "Teams" + ], "request": { - "method": "PUT", "url": { - "raw": "/ticket_types/{id}", + "raw": "https://api.intercom.io/teams", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{id}" + "teams" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "\nYou can update a ticket type.\n\n> 📘 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", - "header": [], - "body": {} + "method": "GET", + "description": "This will return a list of team objects for the App.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a ticket", + "name": "Retrieve a team", + "tags": [ + "Teams" + ], "request": { - "method": "PUT", "url": { - "raw": "/tickets/{id}", + "raw": "https://api.intercom.io/teams/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", + "teams", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given team." + } ] }, - "description": "You can update a ticket.", - "header": [], - "body": {} + "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 team, containing an array of admins that belong to this team.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Ticket States", + "item": [ { - "name": "Update a visitor", + "name": "List all ticket states", + "tags": [ + "Ticket States" + ], "request": { - "method": "PUT", "url": { - "raw": "/visitors", + "raw": "https://api.intercom.io/ticket_states", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors" + "ticket_states" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can get a list of all ticket states for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Ticket Type Attributes", + "item": [ { - "name": "Delete a content import source", + "name": "Create a new attribute for a ticket type", + "tags": [ + "Ticket Type Attributes" + ], "request": { - "method": "DELETE", "url": { - "raw": "/ai/content_import_sources/{id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "content_import_sources", - "{id}" + "ticket_types", + "{ticket_type_id}", + "attributes" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } ] }, - "description": "You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source.", - "header": [], - "body": {} + "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 attribute for a ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug Priority\",\n \"description\": \"Priority level of the bug\",\n \"data_type\": \"string\",\n \"required_to_create\": false,\n \"required_to_create_for_contacts\": false,\n \"visible_on_create\": true,\n \"visible_to_contacts\": true,\n \"multiline\": false,\n \"list_items\": \"Low Priority,Medium Priority,High Priority\",\n \"allow_multiple_values\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete an external page", + "name": "Update an existing attribute for a ticket type", + "tags": [ + "Ticket Type Attributes" + ], "request": { - "method": "DELETE", "url": { - "raw": "/ai/external_pages/{id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "external_pages", + "ticket_types", + "{ticket_type_id}", + "attributes", "{id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + }, + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket type attribute which is given by Intercom." + } ] }, - "description": "Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers.", - "header": [], - "body": {} + "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 attribute for a ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug Priority\",\n \"description\": \"Priority level of the bug\",\n \"required_to_create\": false,\n \"required_to_create_for_contacts\": false,\n \"visible_on_create\": true,\n \"visible_to_contacts\": true,\n \"multiline\": false,\n \"list_items\": \"Low Priority,Medium Priority,High Priority\",\n \"allow_multiple_values\": false,\n \"archived\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Ticket Types", + "item": [ { - "name": "Delete an article", + "name": "List all ticket types", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/ticket_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", - "{id}" + "ticket_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can get a list of all ticket types for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete a collection", + "name": "Retrieve a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/ticket_types/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", + "ticket_types", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } ] }, - "description": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} + "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 ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete a company", + "name": "Create a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/ticket_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "{id}" + "ticket_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single company.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new ticket type.\n> 📘 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: _default_title_ and _default_description_.\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug\",\n \"description\": \"Used for tracking bugs\",\n \"category\": \"Customer\",\n \"icon\": \"🐞\",\n \"is_internal\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Detach a contact from a company", + "name": "Update a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/companies/{id}", + "raw": "https://api.intercom.io/ticket_types/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "companies", + "ticket_types", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } ] }, - "description": "You can detach a company from a single contact.", - "header": [], - "body": {} + "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 ticket type.\n\n> 📘 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug\",\n \"description\": \"A bug has been occured\",\n \"category\": \"Customer\",\n \"icon\": \"🐞\",\n \"archived\": false,\n \"is_internal\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Tickets", + "item": [ { - "name": "Remove subscription from a contact", + "name": "Retrieve a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/subscriptions/{id}", + "raw": "https://api.intercom.io/tickets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions", + "tickets", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom." + } ] }, - "description": "You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", - "header": [], - "body": {} + "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 ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Remove tag from a contact", + "name": "Reply to a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/tags/{id}", + "raw": "https://api.intercom.io/tickets/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags", - "{id}" + "tickets", + "{id}", + "reply" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false + } ] }, - "description": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", - "header": [], - "body": {} + "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 ticket with a message from an admin or on behalf of a contact, or with a note for admins.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "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 \"admin_id\": \"3156780\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a contact", + "name": "Create a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/tickets", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}" + "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" + } ] }, - "description": "You can delete a single contact.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "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 \"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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Remove tag from a conversation", + "name": "Search tickets", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{conversation_id}/tags/{id}", + "raw": "https://api.intercom.io/tickets/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags", - "{id}" + "tickets", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", - "header": [], - "body": {} + "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| _default_title_ | String |\n| _default_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### 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": "2.12" + }, + { + "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": "Detach a contact from a group conversation", + "name": "Update a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{conversation_id}/customers/{contact_id}", + "raw": "https://api.intercom.io/tickets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "customers", - "{contact_id}" + "tickets", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 a ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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 \"assignment\": {\n \"admin_id\": \"123\",\n \"assignee_id\": \"123\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Visitors", + "item": [ { - "name": "Delete a news item", + "name": "Retrieve a visitor with User ID", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{id}" + "visitors" + ], + "query": [ + { + "key": "user_id", + "value": "user_id", + "description": "The user_id of the Visitor you want to retrieve." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single news item.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single visitor.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.12" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete tag", + "name": "Convert a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/tags/{id}", + "raw": "https://api.intercom.io/visitors/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags", - "{id}" + "visitors", + "convert" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete the details of tags that are on the workspace by passing in the id.", - "header": [], - "body": {} + "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": "2.12" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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": "Remove tag from a ticket", + "name": "Update a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/tickets/{ticket_id}/tags/{id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{ticket_id}", - "tags", - "{id}" + "visitors" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.", - "header": [], - "body": {} + "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": "2.12" + }, + { + "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": [] + } }, "response": [] } @@ -2057,28 +7753,7 @@ "event": [], "variable": [ { - "id": "6cf3d4bc-34fb-48a9-9ac4-f1b31b89c341", - "key": "https://api.intercom.io", - "value": "https://api.intercom.io", - "type": "string", - "description": "The production API server" - }, - { - "id": "a1681354-8f79-4de4-9bce-830ca6ac8a6f", - "key": "https://api.eu.intercom.io", - "value": "https://api.eu.intercom.io", - "type": "string", - "description": "The european API server" - }, - { - "id": "43bbb147-7883-4b55-a416-66759b2ac5d1", - "key": "https://api.au.intercom.io", - "value": "https://api.au.intercom.io", - "type": "string", - "description": "The australian API server" - }, - { - "id": "e5ce57d2-0d34-4131-baa5-3189284e1220", + "id": "6fbd31d5-fc63-4ba8-84fa-5151b5ca7fbe", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/postman/2.13/README.md b/postman/2.13/README.md index a195547..78d93e6 100644 --- a/postman/2.13/README.md +++ b/postman/2.13/README.md @@ -12,4 +12,4 @@ This directory contains the Postman collection for Intercom API version 2.13. 3. Set your access token in the environment variables 4. Start making API calls! -Last updated: 2025-04-15T14:40:03.094Z +Last updated: 2025-04-25T10:49:25.273Z diff --git a/postman/2.13/intercom-api.postman_collection.json b/postman/2.13/intercom-api.postman_collection.json index 8fdc9fd..7b151bd 100644 --- a/postman/2.13/intercom-api.postman_collection.json +++ b/postman/2.13/intercom-api.postman_collection.json @@ -8,2203 +8,8309 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-04-15T14:40:03.093Z" + "updatedAt": "2025-04-25T10:49:25.271Z" }, "item": [ { - "name": "General", + "name": "AI Content", "item": [ { - "name": "Identify an admin", + "name": "List content import sources", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/me", + "raw": "https://api.intercom.io/ai/content_import_sources", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "me" + "ai", + "content_import_sources" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "\nYou can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology).\n\n> 🚧 Single Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.\n", - "header": [], - "body": {} + "method": "GET", + "description": "You can retrieve a list of all content import sources for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all activity logs", + "name": "Retrieve a content import source", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/activity_logs", + "raw": "https://api.intercom.io/ai/content_import_sources/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins", - "activity_logs" + "ai", + "content_import_sources", + "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can get a log of activities by all admins in an app.", - "header": [], - "body": {} + "method": "GET", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all admins", + "name": "List external pages", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/admins", + "raw": "https://api.intercom.io/ai/external_pages", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins" + "ai", + "external_pages" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of admins for a given workspace.", - "header": [], - "body": {} + "method": "GET", + "description": "You can retrieve a list of all external pages for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve an admin", + "name": "Retrieve an external page", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/{id}", + "raw": "https://api.intercom.io/ai/external_pages/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins", + "ai", + "external_pages", "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can retrieve the details of a single admin.", - "header": [], - "body": {} + "method": "GET", + "description": "You can retrieve an external page.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List content import sources", + "name": "Create a content import source", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/ai/content_import_sources", + "raw": "https://api.intercom.io/ai/content_import_sources", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "ai", "content_import_sources" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can retrieve a list of all content import sources for a workspace.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new content import source by sending a POST request to this endpoint.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"sync_behavior\": \"api\",\n \"status\": \"active\",\n \"url\": \"https://help.example.com\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a content import source", + "name": "Create an external page (or update an external page by external ID)", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/ai/content_import_sources/{id}", + "raw": "https://api.intercom.io/ai/external_pages", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "ai", - "content_import_sources", - "{id}" + "external_pages" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List external pages", + "name": "Update a content import source", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/ai/external_pages", + "raw": "https://api.intercom.io/ai/content_import_sources/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "ai", - "external_pages" + "content_import_sources", + "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can retrieve a list of all external pages for a workspace.", - "header": [], - "body": {} + "method": "PUT", + "description": "You can update an existing content import source.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"sync_behavior\": \"api\",\n \"status\": \"active\",\n \"url\": \"https://help.example.com\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve an external page", + "name": "Update an external page", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/ai/external_pages/{id}", + "raw": "https://api.intercom.io/ai/external_pages/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "ai", "external_pages", "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can retrieve an external page.", - "header": [], - "body": {} + "method": "PUT", + "description": "You can update an existing external page (if it was created via the API).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all articles", + "name": "Delete a content import source", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/ai/content_import_sources/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles" + "ai", + "content_import_sources", + "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "DELETE", + "description": "You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve an article", + "name": "Delete an external page", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/ai/external_pages/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", + "ai", + "external_pages", "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "method": "DELETE", + "description": "Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Admins", + "item": [ { - "name": "Search for articles", + "name": "Identify an admin", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/articles/search", + "raw": "https://api.intercom.io/me", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", - "search" + "me" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.", - "header": [], - "body": {} + "method": "GET", + "description": "\nYou can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology).\n\n> 🚧 Single Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all collections", + "name": "List all activity logs", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections", + "raw": "https://api.intercom.io/admins/activity_logs", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections" + "admins", + "activity_logs" + ], + "query": [ + { + "key": "created_at_after", + "value": "1677253093", + "description": "The start date that you request data for. It must be formatted as a UNIX timestamp." + }, + { + "key": "created_at_before", + "value": "1677861493", + "description": "The end date that you request data for. It must be formatted as a UNIX timestamp." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can get a log of activities by all admins in an app.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a collection", + "name": "List all admins", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/admins", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", - "{id}" + "admins" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of admins for a given workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a Help Center", + "name": "Retrieve an admin", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/help_centers/{id}", + "raw": "https://api.intercom.io/admins/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "help_centers", + "admins", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given admin" + } ] }, - "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": [], - "body": {} + "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 details of a single admin.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all Help Centers", + "name": "Set an admin to away", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/help_centers", + "raw": "https://api.intercom.io/admins/{id}/away", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "help_centers" + "admins", + "{id}", + "away" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a given admin" + } ] }, - "description": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", - "header": [], - "body": {} + "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 set an Admin as away for the Inbox.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"away_mode_enabled\": true,\n \"away_mode_reassign\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Articles", + "item": [ { - "name": "Retrieve companies", + "name": "List all articles", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies" + "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" + } ] }, - "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": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a company by ID", + "name": "Retrieve an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", + "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "description": "You can fetch a single company.", - "header": [], - "body": {} + "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 article by making a GET request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached contacts", + "name": "Search for articles", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}/contacts", + "raw": "https://api.intercom.io/articles/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "{id}", - "contacts" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of all contacts that belong to a company.", - "header": [], - "body": {} + "method": "GET", + "description": "You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached segments for companies", + "name": "Create an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}/segments", + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "{id}", - "segments" + "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" + } ] }, - "description": "You can fetch a list of all segments that belong to a company.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Scroll over all companies", + "name": "Update an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/scroll", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "scroll" + "articles", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 article by making a PUT request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List attached companies for contact", + "name": "Delete an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}/companies", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "companies" + "articles", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "description": "You can fetch a list of companies that are associated to a contact.", - "header": [], - "body": {} + "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 article by making a DELETE request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Companies", + "item": [ { - "name": "List all notes", + "name": "Retrieve companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}/notes", + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "notes" + "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" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of notes that are associated to a contact.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached segments for contact", + "name": "Retrieve a company by ID", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/segments", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "segments" + "companies", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch a list of segments that are associated to a contact.", - "header": [], - "body": {} + "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 company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List subscriptions for a contact", + "name": "List attached contacts", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/companies/{id}/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions" + "companies", + "{id}", + "contacts" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "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", - "header": [], - "body": {} + "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 contacts that belong to a company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List tags attached to a contact", + "name": "List attached segments for companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/companies/{id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags" + "companies", + "{id}", + "segments" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch a list of all tags that are attached to a specific contact.", - "header": [], - "body": {} + "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 segments that belong to a company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Get a contact", + "name": "Scroll over all companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/companies/scroll", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}" + "companies", + "scroll" + ], + "query": [ + { + "key": "scroll_param", + "value": "scroll_param", + "description": "" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single contact.", - "header": [], - "body": {} + "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", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all contacts", + "name": "Create or Update a company", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts", + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts" + "companies" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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", - "header": [], - "body": {} + "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": "2.13" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Get a contact by External ID", + "name": "List all companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/find_by_external_id/{external_id}", + "raw": "https://api.intercom.io/companies/list", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "find_by_external_id", - "{external_id}" + "companies", + "list" + ], + "query": [ + { + "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", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads.", - "header": [], - "body": {} + "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", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all conversations", + "name": "Attach a Contact to a Company", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/contacts/{id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "contacts", + "{id}", + "companies" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 attach a company to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"58a430d35458202d41b1e65b\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a conversation", + "name": "Update a company", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", + "companies", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "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", - "header": [], - "body": {} + "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 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", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Get Custom Object Instance by External ID", + "name": "Delete a company", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/custom_object_instances/{custom_object_type_identifier}", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}" + "companies", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "Fetch a Custom Object Instance by external_id.", - "header": [], - "body": {} + "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 company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Get Custom Object Instance by ID", + "name": "Detach a contact from a company", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/custom_object_instances/{custom_object_type_identifier}/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}", + "contacts", + "{contact_id}", + "companies", "{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", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "Fetch a Custom Object Instance by id.", - "header": [], - "body": {} + "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 detach a company from a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Contacts", + "item": [ { - "name": "List all data attributes", + "name": "List attached companies for contact", + "tags": [ + "Contacts", + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/data_attributes", + "raw": "https://api.intercom.io/contacts/{id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes" + "contacts", + "{id}", + "companies" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", - "header": [], - "body": {} + "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 companies that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all data events", + "name": "List attached segments for contact", + "tags": [ + "Contacts", + "Segments" + ], "request": { - "method": "GET", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/contacts/{contact_id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "contacts", + "{contact_id}", + "segments" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 segments that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Show content data export", + "name": "List subscriptions for a contact", + "tags": [ + "Contacts", + "Subscription Types" + ], "request": { - "method": "GET", "url": { - "raw": "/export/content/data/{job_identifier}", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data", - "{job_identifier}" + "contacts", + "{contact_id}", + "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Download content data export", + "name": "List tags attached to a contact", + "tags": [ + "Contacts", + "Tags" + ], "request": { - "method": "GET", "url": { - "raw": "/download/content/data/{job_identifier}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "download", - "content", - "data", - "{job_identifier}" + "contacts", + "{contact_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 tags that are attached to a specific contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all news items", + "name": "Get a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items" + "contacts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch a list of all news items", - "header": [], - "body": {} + "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 contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a news item", + "name": "List all contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{id}" + "contacts" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single news item.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all live newsfeed items", + "name": "Get a contact by External ID", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{id}/items", + "raw": "https://api.intercom.io/contacts/find_by_external_id/{external_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", - "{id}", - "items" + "contacts", + "find_by_external_id", + "{external_id}" + ], + "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" + } ] }, - "description": "You can fetch a list of all news items that are live on a given newsfeed", - "header": [], - "body": {} + "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 contact by external ID. Note that this endpoint only supports users and not leads.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all newsfeeds", + "name": "Merge a lead and a user", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds", + "raw": "https://api.intercom.io/contacts/merge", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds" + "contacts", + "merge" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of all newsfeeds", - "header": [], - "body": {} + "method": "POST", + "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"from\": \"5d70dd30de4efd54f42fd526\",\n \"into\": \"5ba682d23d7cf92bef87bfd4\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a newsfeed", + "name": "Search contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{id}", + "raw": "https://api.intercom.io/contacts/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", - "{id}" + "contacts", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single newsfeed", - "header": [], - "body": {} + "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| 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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "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": "Retrieve a note", + "name": "Create contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/notes/{id}", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "notes", - "{id}" + "contacts" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single note.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new contact (ie. user or lead).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all segments", + "name": "Archive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/segments", + "raw": "https://api.intercom.io/contacts/{id}/archive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments" + "contacts", + "{id}", + "archive" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch a list of all segments.", - "header": [], - "body": {} + "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 archive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a segment", + "name": "Unarchive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/segments/{id}", + "raw": "https://api.intercom.io/contacts/{id}/unarchive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments", - "{id}" + "contacts", + "{id}", + "unarchive" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch the details of a single segment.", - "header": [], - "body": {} + "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 unarchive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List subscription types", + "name": "Block contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/subscription_types", + "raw": "https://api.intercom.io/contacts/{id}/block", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "subscription_types" + "contacts", + "{id}", + "block" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "description": "You can list all subscription types. A list of subscription type objects will be returned.", - "header": [], - "body": {} + "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": "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", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all tags", + "name": "Update a contact", + "tags": [ + "Contacts", + "Custom Object Instances" + ], "request": { - "method": "GET", "url": { - "raw": "/tags", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags" + "contacts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch a list of all tags for a given workspace.\n\n", - "header": [], - "body": {} + "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 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", + "value": "2.13" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Find a specific tag", + "name": "Delete a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/tags/{id}", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags", + "contacts", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch the details of tags that are on the workspace by their id.\nThis will return a tag object.\n", - "header": [], - "body": {} + "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": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Conversations", + "item": [ { - "name": "List all teams", + "name": "List all conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/teams", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "This will return a list of team objects for the App.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a team", + "name": "Retrieve a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/teams/{id}", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams", + "conversations", "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can fetch the details of a single team, containing an array of admins that belong to this team.", - "header": [], - "body": {} + "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.\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": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all ticket states", + "name": "Creates a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/ticket_states", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_states" + "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" + } ] }, - "description": "You can get a list of all ticket states for a workspace.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "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 \"created_at\": 1671028894\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all ticket types", + "name": "Search conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/ticket_types", + "raw": "https://api.intercom.io/conversations/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types" + "conversations", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can get a list of all ticket types for a workspace.", - "header": [], - "body": {} + "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 as part of 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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "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": "Retrieve a ticket type", + "name": "Reply to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/ticket_types/{id}", + "raw": "https://api.intercom.io/conversations/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{id}" + "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" + } ] }, - "description": "You can fetch the details of a single ticket type.", - "header": [], - "body": {} + "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.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "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 \"admin_id\": \"3156780\",\n \"attachment_files\": [\n {\n \"content_type\": \"application/json\",\n \"data\": \"ewogICJ0ZXN0IjogMQp9\",\n \"name\": \"test.json\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a ticket", + "name": "Manage a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/tickets/{id}", + "raw": "https://api.intercom.io/conversations/{id}/parts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{id}" + "conversations", + "{id}", + "parts" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can fetch the details of a single ticket.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Retrieve a visitor with User ID", + "name": "Attach a contact to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/visitors", + "raw": "https://api.intercom.io/conversations/{id}/customers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors" + "conversations", + "{id}", + "customers" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can fetch the details of a single visitor.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "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": "Create a content import source", + "name": "Redact a conversation part", + "tags": [ + "Conversations" + ], "request": { - "method": "POST", "url": { - "raw": "/ai/content_import_sources", + "raw": "https://api.intercom.io/conversations/redact", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "content_import_sources" + "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" + } ] }, - "description": "You can create a new content import source by sending a POST request to this endpoint.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "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": "Create an external page (or update an external page by external ID)", + "name": "Convert a conversation to a ticket", + "tags": [ + "Conversations" + ], "request": { - "method": "POST", "url": { - "raw": "/ai/external_pages", + "raw": "https://api.intercom.io/conversations/{id}/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "external_pages" + "conversations", + "{id}", + "convert" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ticket_type_id\": \"1234\",\n \"attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Create an article", + "name": "Update a conversation", + "tags": [ + "Conversations", + "Custom Object Instances" + ], "request": { - "method": "POST", "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles" + "conversations", + "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Create a collection", + "name": "Delete a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "POST", "url": { - "raw": "/help_center/collections", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections" + "conversations", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "id" + } ] }, - "description": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", - "header": [], - "body": {} + "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 conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create or Update a company", + "name": "Detach a contact from a group conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "POST", "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/conversations/{conversation_id}/customers/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies" + "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." + } ] }, - "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": [], - "body": {} + "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 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": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"5017690\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Custom Object Instances", + "item": [ { - "name": "List all companies", + "name": "Get Custom Object Instance by External ID", + "tags": [ + "Custom Object Instances" + ], "request": { - "method": "POST", "url": { - "raw": "/companies/list", + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "list" + "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" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "Fetch a Custom Object Instance by external_id.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Attach a Contact to a Company", + "name": "Get Custom Object Instance by ID", + "tags": [ + "Custom Object Instances" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/companies", + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "companies" + "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" + } ] }, - "description": "You can attach a company to a single contact.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a note", + "name": "Create or Update a Custom Object Instance", + "tags": [ + "Custom Object Instances" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/notes", + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "notes" + "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" + } ] }, - "description": "You can add a note to a single contact.", - "header": [], - "body": {} + "method": "POST", + "description": "Create or update a custom object instance", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "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": "Add subscription to a contact", + "name": "Delete a Custom Object Instance by External ID", + "tags": [ + "Custom Object Instances" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions" + "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" + } ] }, - "description": "You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", - "header": [], - "body": {} + "method": "DELETE", + "description": "Delete a single Custom Object instance by external_id.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Add tag to a contact", + "name": "Delete a Custom Object Instance by ID", + "tags": [ + "Custom Object Instances" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags" + "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" + } ] }, - "description": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Data Attributes", + "item": [ { - "name": "Merge a lead and a user", + "name": "List all data attributes", + "tags": [ + "Data Attributes" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/merge", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "merge" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Search contacts", + "name": "Create a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/search", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "search" + "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" + } ] }, - "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| 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", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a data attributes for a `contact` or a `company`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Data Attribute\",\n \"model\": \"contact\",\n \"data_type\": \"string\",\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Create contact", + "name": "Update a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts", + "raw": "https://api.intercom.io/data_attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts" + "data_attributes", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "1", + "disabled": false, + "description": "The data attribute id" + } ] }, - "description": "You can create a new contact (ie. user or lead).", - "header": [], - "body": {} + "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": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"archived\": false,\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Data Events", + "item": [ { - "name": "Archive contact", + "name": "List all data events", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/archive", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "archive" + "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" + } ] }, - "description": "You can archive a single contact.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Unarchive contact", + "name": "Submit a data event", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/unarchive", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "unarchive" + "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" + } ] }, - "description": "You can unarchive a single contact.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "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": "Block contact", + "name": "Create event summaries", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/block", + "raw": "https://api.intercom.io/events/summaries", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "block" + "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" + } ] }, - "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": [], - "body": {} + "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": "2.13" + }, + { + "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": "Add tag to a conversation", + "name": "Show content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{conversation_id}/tags", + "raw": "https://api.intercom.io/export/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags" + "export", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "description": "You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Creates a conversation", + "name": "Download content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/download/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "download", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "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": [], - "body": {} + "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": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Search conversations", + "name": "Create content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/search", + "raw": "https://api.intercom.io/export/content/data", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "search" + "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" + } ] }, - "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 as part of 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", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "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": "Reply to a conversation", + "name": "Cancel content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/reply", + "raw": "https://api.intercom.io/export/cancel/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "reply" + "export", + "cancel", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "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.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Help Center", + "item": [ { - "name": "Manage a conversation", + "name": "List all collections", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/parts", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "parts" + "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" + } ] }, - "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", - "header": [], - "body": {} + "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": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Attach a contact to a conversation", + "name": "Retrieve a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/customers", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "customers" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Redact a conversation part", + "name": "Retrieve a Help Center", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/redact", + "raw": "https://api.intercom.io/help_center/help_centers/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "redact" + "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." + } ] }, - "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": [], - "body": {} + "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": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Convert a conversation to a ticket", + "name": "List all Help Centers", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/convert", + "raw": "https://api.intercom.io/help_center/help_centers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "convert" + "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" + } ] }, - "description": "You can convert a conversation to a ticket.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create or Update a Custom Object Instance", + "name": "Create a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/custom_object_instances/{custom_object_type_identifier}", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}" + "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" + } ] }, - "description": "Create or update a custom object instance", - "header": [], - "body": {} + "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": "2.13" + }, + { + "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": "Create a data attribute", + "name": "Update a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/data_attributes", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "description": "You can create a data attributes for a `contact` or a `company`.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "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": "Submit a data event", + "name": "Delete a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 collection by making a DELETE request to `https://api.intercom.io/collections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Messages", + "item": [ { - "name": "Create event summaries", + "name": "Create a message", + "tags": [ + "Messages" + ], "request": { - "method": "POST", "url": { - "raw": "/events/summaries", + "raw": "https://api.intercom.io/messages", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events", - "summaries" + "messages" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\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", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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 \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n \"created_at\": 1590000000,\n \"create_conversation_without_contact_reply\": true\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "News", + "item": [ { - "name": "Create content data export", + "name": "List all news items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/export/content/data", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data" + "news", + "news_items" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all news items", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Cancel content data export", + "name": "Retrieve a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/export/cancel/{job_identifier}", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "cancel", - "{job_identifier}" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "description": "You can cancel your job", - "header": [], - "body": {} + "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 news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a message", + "name": "List all live newsfeed items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/messages", + "raw": "https://api.intercom.io/news/newsfeeds/{id}/items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "messages" + "news", + "newsfeeds", + "{id}", + "items" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } ] }, - "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\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": [], - "body": {} + "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 news items that are live on a given newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a news item", + "name": "List all newsfeeds", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/news/newsfeeds", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "news", - "news_items" + "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" + } ] }, - "description": "You can create a news item", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all newsfeeds", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a phone Switch", + "name": "Retrieve a newsfeed", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/phone_call_redirects", + "raw": "https://api.intercom.io/news/newsfeeds/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "phone_call_redirects" + "news", + "newsfeeds", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } ] }, - "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", - "header": [], - "body": {} + "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 newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create or update a tag, Tag or untag companies, Tag contacts", + "name": "Create a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/tags", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags" + "news", + "news_items" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a news item", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Create a new attribute for a ticket type", + "name": "Update a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/ticket_types/{ticket_type_id}/attributes", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{ticket_type_id}", - "attributes" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "description": "You can create a new attribute for a ticket type.", - "header": [], - "body": {} + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Create a ticket type", + "name": "Delete a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/ticket_types", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "description": "You can create a new ticket type.\n> 📘 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: _default_title_ and _default_description_.\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", - "header": [], - "body": {} + "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 news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Notes", + "item": [ { - "name": "Reply to a ticket", + "name": "List all notes", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/{id}/reply", + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", + "contacts", "{id}", - "reply" + "notes" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a contact." + } ] }, - "description": "You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins.", - "header": [], - "body": {} + "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 notes that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Add tag to a ticket", + "name": "Retrieve a note", + "tags": [ + "Notes" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/{ticket_id}/tags", + "raw": "https://api.intercom.io/notes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{ticket_id}", - "tags" + "notes", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "1", + "disabled": false, + "description": "The unique identifier of a given note" + } ] }, - "description": "You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", - "header": [], - "body": {} + "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 note.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a ticket", + "name": "Create a note", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets", + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets" + "contacts", + "{id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given contact." + } ] }, - "description": "You can create a new ticket.", - "header": [], - "body": {} + "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 a note to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"body\": \"New note\",\n \"contact_id\": \"123\",\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Segments", + "item": [ { - "name": "Search tickets", + "name": "List all segments", + "tags": [ + "Segments" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/search", + "raw": "https://api.intercom.io/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "search" + "segments" + ], + "query": [ + { + "key": "include_count", + "value": "true", + "description": "It includes the count of contacts that belong to each segment." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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| _default_title_ | String |\n| _default_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### 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": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all segments.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Convert a visitor", + "name": "Retrieve a segment", + "tags": [ + "Segments" + ], "request": { - "method": "POST", "url": { - "raw": "/visitors/convert", + "raw": "https://api.intercom.io/segments/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors", - "convert" + "segments", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identified of a given segment." + } ] }, - "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": [], - "body": {} + "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 segment.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Subscription Types", + "item": [ { - "name": "Set an admin to away", + "name": "List subscription types", + "tags": [ + "Subscription Types" + ], "request": { - "method": "PUT", "url": { - "raw": "/admins/{id}/away", + "raw": "https://api.intercom.io/subscription_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins", - "{id}", - "away" + "subscription_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can set an Admin as away for the Inbox.", - "header": [], - "body": {} + "method": "GET", + "description": "You can list all subscription types. A list of subscription type objects will be returned.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a content import source", + "name": "Add subscription to a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/ai/content_import_sources/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "content_import_sources", - "{id}" + "contacts", + "{contact_id}", + "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can update an existing content import source.", - "header": [], - "body": {} + "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 a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"37846\",\n \"consent_type\": \"opt_in\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update an external page", + "name": "Remove subscription from a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/ai/external_pages/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "external_pages", + "contacts", + "{contact_id}", + "subscriptions", "{id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "value": "37846", + "disabled": false, + "description": "The unique identifier for the subscription type which is given by Intercom" + } ] }, - "description": "You can update an existing external page (if it was created via the API).", - "header": [], - "body": {} + "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 a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Switch", + "item": [ { - "name": "Update an article", + "name": "Create a phone Switch", + "tags": [ + "Switch" + ], "request": { - "method": "PUT", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/phone_call_redirects", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", - "{id}" + "phone_call_redirects" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "method": "POST", + "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"phone\": \"+1 1234567890\",\n \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Tags", + "item": [ { - "name": "Update a collection", + "name": "List all tags", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", - "{id}" + "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all tags for a given workspace.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a company", + "name": "Find a specific tag", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } ] }, - "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": [], - "body": {} + "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 tags that are on the workspace by their id.\nThis will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a contact", + "name": "Add tag to a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", - "{id}" + "{contact_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 tag a specific contact. This will return a tag object for the tag that was added to the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a conversation", + "name": "Add tag to a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "PUT", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "conversations", - "{id}" + "{conversation_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + } ] }, - "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", - "header": [], - "body": {} + "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 tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"780\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a data attribute", + "name": "Create or update a tag, Tag or untag companies, Tag contacts", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/data_attributes/{id}", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes", - "{id}" + "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Independent\",\n \"id\": \"656452352\",\n \"companies\": [\n {\n \"id\": \"531ee472cce572a6ec000006\",\n \"company_id\": \"6\",\n \"untag\": \"true\"\n }\n ],\n \"users\": [\n {\n \"id\": \"5f7f0d217289f8d2f4262080\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a news item", + "name": "Add tag to a ticket", + "tags": [ + "Tags", + "Tickets" + ], "request": { - "method": "PUT", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{id}" + "tickets", + "{ticket_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "64619700005694", + "disabled": false, + "description": "ticket_id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "", - "header": [], - "body": {} + "method": "POST", + "description": "You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"780\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update an existing attribute for a ticket type", + "name": "Remove tag from a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/ticket_types/{ticket_type_id}/attributes/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{ticket_type_id}", - "attributes", + "contacts", + "{contact_id}", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier for the tag which is given by Intercom" + } ] }, - "description": "You can update an existing attribute for a ticket type.", - "header": [], - "body": {} + "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 tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a ticket type", + "name": "Remove tag from a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "PUT", "url": { - "raw": "/ticket_types/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", + "conversations", + "{conversation_id}", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "id" + } ] }, - "description": "\nYou can update a ticket type.\n\n> 📘 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", - "header": [], - "body": {} + "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 tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a ticket", + "name": "Delete tag", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/tickets/{id}", + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } ] }, - "description": "You can update a ticket.", - "header": [], - "body": {} + "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 the details of tags that are on the workspace by passing in the id.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a visitor", + "name": "Remove tag from a ticket", + "tags": [ + "Tags", + "Tickets" + ], "request": { - "method": "PUT", "url": { - "raw": "/visitors", + "raw": "https://api.intercom.io/tickets/{ticket_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors" + "tickets", + "{ticket_id}", + "tags", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "64619700005694", + "disabled": false, + "description": "ticket_id" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier for the tag 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" + } ] }, - "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": [], - "body": {} + "method": "DELETE", + "description": "You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Teams", + "item": [ { - "name": "Delete a content import source", + "name": "List all teams", + "tags": [ + "Teams" + ], "request": { - "method": "DELETE", "url": { - "raw": "/ai/content_import_sources/{id}", + "raw": "https://api.intercom.io/teams", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "content_import_sources", - "{id}" + "teams" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source.", - "header": [], - "body": {} + "method": "GET", + "description": "This will return a list of team objects for the App.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete an external page", + "name": "Retrieve a team", + "tags": [ + "Teams" + ], "request": { - "method": "DELETE", "url": { - "raw": "/ai/external_pages/{id}", + "raw": "https://api.intercom.io/teams/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "external_pages", + "teams", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given team." + } ] }, - "description": "Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers.", - "header": [], - "body": {} + "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 team, containing an array of admins that belong to this team.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Ticket States", + "item": [ { - "name": "Delete an article", + "name": "List all ticket states", + "tags": [ + "Ticket States" + ], "request": { - "method": "DELETE", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/ticket_states", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", - "{id}" + "ticket_states" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can get a list of all ticket states for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Ticket Type Attributes", + "item": [ { - "name": "Delete a collection", + "name": "Create a new attribute for a ticket type", + "tags": [ + "Ticket Type Attributes" + ], "request": { - "method": "DELETE", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", - "{id}" + "ticket_types", + "{ticket_type_id}", + "attributes" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } ] }, - "description": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} + "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 attribute for a ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug Priority\",\n \"description\": \"Priority level of the bug\",\n \"data_type\": \"string\",\n \"required_to_create\": false,\n \"required_to_create_for_contacts\": false,\n \"visible_on_create\": true,\n \"visible_to_contacts\": true,\n \"multiline\": false,\n \"list_items\": \"Low Priority,Medium Priority,High Priority\",\n \"allow_multiple_values\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a company", + "name": "Update an existing attribute for a ticket type", + "tags": [ + "Ticket Type Attributes" + ], "request": { - "method": "DELETE", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", + "ticket_types", + "{ticket_type_id}", + "attributes", "{id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + }, + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket type attribute which is given by Intercom." + } ] }, - "description": "You can delete a single company.", - "header": [], - "body": {} + "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 attribute for a ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug Priority\",\n \"description\": \"Priority level of the bug\",\n \"required_to_create\": false,\n \"required_to_create_for_contacts\": false,\n \"visible_on_create\": true,\n \"visible_to_contacts\": true,\n \"multiline\": false,\n \"list_items\": \"Low Priority,Medium Priority,High Priority\",\n \"allow_multiple_values\": false,\n \"archived\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Ticket Types", + "item": [ { - "name": "Detach a contact from a company", + "name": "List all ticket types", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/companies/{id}", + "raw": "https://api.intercom.io/ticket_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "companies", - "{id}" + "ticket_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can detach a company from a single contact.", - "header": [], - "body": {} + "method": "GET", + "description": "You can get a list of all ticket types for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Remove subscription from a contact", + "name": "Retrieve a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/subscriptions/{id}", + "raw": "https://api.intercom.io/ticket_types/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions", + "ticket_types", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } ] }, - "description": "You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", - "header": [], - "body": {} + "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 ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Remove tag from a contact", + "name": "Create a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/tags/{id}", + "raw": "https://api.intercom.io/ticket_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags", - "{id}" + "ticket_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new ticket type.\n> 📘 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: _default_title_ and _default_description_.\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug\",\n \"description\": \"Used for tracking bugs\",\n \"category\": \"Customer\",\n \"icon\": \"🐞\",\n \"is_internal\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a contact", + "name": "Update a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/ticket_types/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", + "ticket_types", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } ] }, - "description": "You can delete a single contact.", - "header": [], - "body": {} + "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 ticket type.\n\n> 📘 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug\",\n \"description\": \"A bug has been occured\",\n \"category\": \"Customer\",\n \"icon\": \"🐞\",\n \"archived\": false,\n \"is_internal\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Tickets", + "item": [ { - "name": "Remove tag from a conversation", + "name": "Retrieve a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{conversation_id}/tags/{id}", + "raw": "https://api.intercom.io/tickets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags", + "tickets", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom." + } ] }, - "description": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", - "header": [], - "body": {} + "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 ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete a conversation", + "name": "Reply to a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/tickets/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}" + "tickets", + "{id}", + "reply" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false + } ] }, - "description": "You can delete a single conversation.", - "header": [], - "body": {} + "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 ticket with a message from an admin or on behalf of a contact, or with a note for admins.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "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 \"admin_id\": \"3156780\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Detach a contact from a group conversation", + "name": "Create a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{conversation_id}/customers/{contact_id}", + "raw": "https://api.intercom.io/tickets", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "customers", - "{contact_id}" + "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" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can create a new ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "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 \"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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a Custom Object Instance by External ID", + "name": "Search tickets", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/custom_object_instances/{custom_object_type_identifier}", + "raw": "https://api.intercom.io/tickets/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}" + "tickets", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "Delete a single Custom Object instance by external_id.", - "header": [], - "body": {} + "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| _default_title_ | String |\n| _default_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### 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": "2.13" + }, + { + "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": "Delete a Custom Object Instance by ID", + "name": "Update a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/custom_object_instances/{custom_object_type_identifier}/{id}", + "raw": "https://api.intercom.io/tickets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}", + "tickets", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom" + } ] }, - "description": "Delete a single Custom Object instance using the Intercom defined id.", - "header": [], - "body": {} + "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 a ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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 \"assignment\": {\n \"admin_id\": \"123\",\n \"assignee_id\": \"123\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a news item", + "name": "Delete a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/tickets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", + "tickets", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom." + } ] }, - "description": "You can delete a single news item.", - "header": [], - "body": {} + "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 ticket using the Intercom provided ID.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Visitors", + "item": [ { - "name": "Delete tag", + "name": "Retrieve a visitor with User ID", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/tags/{id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags", - "{id}" + "visitors" + ], + "query": [ + { + "key": "user_id", + "value": "user_id", + "description": "The user_id of the Visitor you want to retrieve." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete the details of tags that are on the workspace by passing in the id.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single visitor.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Remove tag from a ticket", + "name": "Convert a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/tickets/{ticket_id}/tags/{id}", + "raw": "https://api.intercom.io/visitors/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{ticket_id}", - "tags", - "{id}" + "visitors", + "convert" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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": "Delete a ticket", + "name": "Update a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/tickets/{id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{id}" + "visitors" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a ticket using the Intercom provided ID.", - "header": [], - "body": {} + "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": "2.13" + }, + { + "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": [] + } }, "response": [] } @@ -2214,28 +8320,7 @@ "event": [], "variable": [ { - "id": "2a91ef54-b011-4e48-a1da-ffbb3643fe54", - "key": "https://api.intercom.io", - "value": "https://api.intercom.io", - "type": "string", - "description": "The production API server" - }, - { - "id": "34ef03aa-6af8-46de-86eb-cc0ccd7d2668", - "key": "https://api.eu.intercom.io", - "value": "https://api.eu.intercom.io", - "type": "string", - "description": "The european API server" - }, - { - "id": "13a5da53-58e4-4e81-8f77-d937cc46c213", - "key": "https://api.au.intercom.io", - "value": "https://api.au.intercom.io", - "type": "string", - "description": "The australian API server" - }, - { - "id": "531454af-c64c-4920-89fe-066a7b9682a6", + "id": "c7432dd1-7f9a-4e2b-b645-9d07d6aae903", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/postman/2.7/README.md b/postman/2.7/README.md index 68e3bb1..ec69d7e 100644 --- a/postman/2.7/README.md +++ b/postman/2.7/README.md @@ -12,4 +12,4 @@ This directory contains the Postman collection for Intercom API version 2.7. 3. Set your access token in the environment variables 4. Start making API calls! -Last updated: 2025-04-15T14:40:03.263Z +Last updated: 2025-04-25T10:49:25.444Z diff --git a/postman/2.7/intercom-api.postman_collection.json b/postman/2.7/intercom-api.postman_collection.json index e47b91a..10a2937 100644 --- a/postman/2.7/intercom-api.postman_collection.json +++ b/postman/2.7/intercom-api.postman_collection.json @@ -8,1700 +8,6419 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-04-15T14:40:03.262Z" + "updatedAt": "2025-04-25T10:49:25.442Z" }, "item": [ { - "name": "General", + "name": "Admins", "item": [ { "name": "Identify an admin", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/me", + "raw": "https://api.intercom.io/me", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "me" + ], + "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": "\nYou can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology).\n\n> 🚧 Single Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.\n", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List all activity logs", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/activity_logs", + "raw": "https://api.intercom.io/admins/activity_logs", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "admins", "activity_logs" + ], + "query": [ + { + "key": "created_at_after", + "value": "1677253093", + "description": "The start date that you request data for. It must be formatted as a UNIX timestamp." + }, + { + "key": "created_at_before", + "value": "1677861493", + "description": "The end date that you request data for. It must be formatted as a UNIX timestamp." + } + ], + "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 get a log of activities by all admins in an app.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List all admins", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/admins", + "raw": "https://api.intercom.io/admins", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "admins" + ], + "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 admins for a given workspace.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Retrieve an admin", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/{id}", + "raw": "https://api.intercom.io/admins/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "admins", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given admin" + } + ] + }, + "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 details of a single admin.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, + { + "name": "Set an admin to away", + "tags": [ + "Admins" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/admins/{id}/away", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "admins", + "{id}", + "away" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a given admin" + } + ] + }, + "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 set an Admin as away for the Inbox.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"away_mode_enabled\": true,\n \"away_mode_reassign\": false\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Articles", + "item": [ { "name": "List all articles", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "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": "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", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Retrieve an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article 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 article by making a GET request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all collections", + "name": "Create an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections", + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections" + "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" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a collection", + "name": "Update an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", + "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "description": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", - "header": [], - "body": {} + "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 article by making a PUT request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a Help Center", + "name": "Delete an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/help_centers/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "help_centers", + "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 article by making a DELETE request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Companies", + "item": [ { - "name": "List all Help Centers", + "name": "Retrieve companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/help_centers", + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "help_centers" + "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" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", - "header": [], - "body": {} + "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": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all sections", + "name": "Retrieve a company by ID", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/sections", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "sections" + "companies", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch a list of all sections by making a GET request to `https://api.intercom.io/help_center/sections`.\n> 📘 How are the sections sorted and ordered?\n>\n> Sections 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 sections first.\n", - "header": [], - "body": {} + "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 company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a section", + "name": "List attached contacts", + "tags": [ + "Companies", + "Contacts" + ], "request": { + "url": { + "raw": "https://api.intercom.io/companies/{id}/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "{id}", + "contacts" + ], + "query": [], + "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", + "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 contacts that belong to a company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List attached segments for companies", + "tags": [ + "Companies" + ], + "request": { "url": { - "raw": "/help_center/sections/{id}", + "raw": "https://api.intercom.io/companies/{id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "sections", - "{id}" + "companies", + "{id}", + "segments" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch the details of a single section by making a GET request to `https://api.intercom.io/help_center/sections/`.", - "header": [], - "body": {} + "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 segments that belong to a company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve companies", + "name": "Scroll over all companies", + "tags": [ + "Companies" + ], "request": { + "url": { + "raw": "https://api.intercom.io/companies/scroll", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "scroll" + ], + "query": [ + { + "key": "scroll_param", + "value": "scroll_param", + "description": "" + } + ], + "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": " 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", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create or Update a company", + "tags": [ + "Companies" + ], + "request": { "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "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": "2.7" + }, + { + "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\": \"Technology\",\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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a company by ID", + "name": "List all companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/companies/list", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", - "{id}" + "list" + ], + "query": [ + { + "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", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a single company.", - "header": [], - "body": {} + "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", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached contacts", + "name": "Attach a Contact to a Company", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}/contacts", + "raw": "https://api.intercom.io/contacts/{id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", + "contacts", "{id}", - "contacts" + "companies" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can fetch a list of all contacts that belong to a company.", - "header": [], - "body": {} + "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 attach a company to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"58a430d35458202d41b1e65b\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List attached segments for companies", + "name": "Update a company", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}/segments", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", - "{id}", - "segments" + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch a list of all segments that belong to a company.", - "header": [], - "body": {} + "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 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", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Scroll over all companies", + "name": "Delete a company", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/scroll", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", - "scroll" + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached companies for contact", + "name": "Detach a contact from a company", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}/companies", + "raw": "https://api.intercom.io/contacts/{contact_id}/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", - "{id}", - "companies" + "{contact_id}", + "companies", + "{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", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch a list of companies that are associated to a contact.", - "header": [], - "body": {} + "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 detach a company from a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Contacts", + "item": [ { - "name": "List all notes", + "name": "List attached companies for contact", + "tags": [ + "Contacts", + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}/notes", + "raw": "https://api.intercom.io/contacts/{id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{id}", - "notes" + "companies" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can fetch a list of notes that are associated to a contact.", - "header": [], - "body": {} + "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 companies that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List attached segments for contact", + "tags": [ + "Contacts", + "Segments" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/segments", + "raw": "https://api.intercom.io/contacts/{contact_id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "segments" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 a list of segments that are associated to a contact.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List subscriptions for a contact", + "tags": [ + "Contacts", + "Subscription Types" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 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", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List tags attached to a contact", + "tags": [ + "Contacts", + "Tags" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 a list of all tags that are attached to a specific contact.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Get a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "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": "GET", "description": "You can fetch the details of a single contact.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List all contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts" + ], + "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 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", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all conversations", + "name": "Merge a lead and a user", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/contacts/merge", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "contacts", + "merge" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"from\": \"5d70dd30de4efd54f42fd526\",\n \"into\": \"5ba682d23d7cf92bef87bfd4\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a conversation", + "name": "Search contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/contacts/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}" - ] + "contacts", + "search" + ], + "query": [], + "variable": [] }, - "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", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "List all data attributes", - "request": { - "method": "GET", - "url": { - "raw": "/data_attributes", - "path": [ - "data_attributes" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", - "header": [], - "body": {} + "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| 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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "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": "List all data events", + "name": "Create contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "contacts" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can create a new contact (ie. user or lead).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Show content data export", + "name": "Archive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/export/content/data/{job_identifier}", + "raw": "https://api.intercom.io/contacts/{id}/archive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data", - "{job_identifier}" + "contacts", + "{id}", + "archive" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "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": [], - "body": {} - }, - "response": [] - }, - { - "name": "Download content data export", - "request": { - "method": "GET", - "url": { - "raw": "/download/content/data/{job_identifier}", - "path": [ - "download", - "content", - "data", - "{job_identifier}" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can archive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all news items", + "name": "Unarchive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/contacts/{id}/unarchive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items" + "contacts", + "{id}", + "unarchive" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch a list of all news items", - "header": [], - "body": {} + "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 unarchive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a news item", + "name": "Update a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", + "contacts", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch the details of a single news item.", - "header": [], - "body": {} + "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 contact (ie. user or lead).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all live newsfeed items", + "name": "Delete a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{id}/items", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", - "{id}", - "items" + "contacts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch a list of all news items that are live on a given newsfeed", - "header": [], - "body": {} + "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": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Conversations", + "item": [ { - "name": "List all newsfeeds", + "name": "List all conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of all newsfeeds", - "header": [], - "body": {} + "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": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a newsfeed", + "name": "Retrieve a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{id}", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", + "conversations", "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can fetch the details of a single newsfeed", - "header": [], - "body": {} + "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.\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": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a note", + "name": "Creates a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/notes/{id}", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "notes", - "{id}" + "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" + } ] }, - "description": "You can fetch the details of a single note.", - "header": [], - "body": {} + "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": "2.7" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all segments", + "name": "Search conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/segments", + "raw": "https://api.intercom.io/conversations/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments" + "conversations", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of all segments.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "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": "Retrieve a segment", + "name": "Reply to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/segments/{id}", + "raw": "https://api.intercom.io/conversations/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments", - "{id}" + "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" + } ] }, - "description": "You can fetch the details of a single segment.", - "header": [], - "body": {} + "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.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "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 \"attachment_urls\": \"\",\n \"admin_id\": \"3156780\",\n \"created_at\": 1590000000,\n \"attachment_files\": [\n {\n \"content_type\": \"application/json\",\n \"data\": \"ewogICJ0ZXN0IjogMQp9\",\n \"name\": \"test.json\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List subscription types", + "name": "Manage a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/subscription_types", + "raw": "https://api.intercom.io/conversations/{id}/parts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "subscription_types" + "conversations", + "{id}", + "parts" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can list all subscription types. A list of subscription type objects will be returned.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "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": [] + } }, "response": [] }, { - "name": "List all tags", + "name": "Run Assignment Rules on a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/tags", + "raw": "https://api.intercom.io/conversations/{id}/run_assignment_rules", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags" + "conversations", + "{id}", + "run_assignment_rules" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can fetch a list of all tags for a given workspace.\n\n", - "header": [], - "body": {} + "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=\"danger\" name=\"Deprecation of Run Assignment Rules\" %}\nRun assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail.\n{% /admonition %}\nYou can let a conversation be automatically assigned following assignment rules.\n{% admonition type=\"warning\" name=\"When using workflows\" %}\nIt is not possible to use this endpoint with Workflows.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Find a specific tag", + "name": "Attach a contact to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/tags/{id}", + "raw": "https://api.intercom.io/conversations/{id}/customers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags", - "{id}" + "conversations", + "{id}", + "customers" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can fetch the details of tags that are on the workspace by their id.\nThis will return a tag object.\n", - "header": [], - "body": {} + "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": "2.7" + }, + { + "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\": \"joe@example.com\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all teams", + "name": "Redact a conversation part", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/teams", + "raw": "https://api.intercom.io/conversations/redact", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams" + "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" + } ] }, - "description": "This will return a list of team objects for the App.", - "header": [], - "body": {} + "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": "2.7" + }, + { + "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": "Retrieve a team", + "name": "Update a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/teams/{id}", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams", + "conversations", "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can fetch the details of a single team, containing an array of admins that belong to this team.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"read\": true,\n \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a visitor with User ID", + "name": "Detach a contact from a group conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/visitors", + "raw": "https://api.intercom.io/conversations/{conversation_id}/customers/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors" + "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." + } ] }, - "description": "You can fetch the details of a single visitor.", - "header": [], - "body": {} + "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 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": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"5017690\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Data Attributes", + "item": [ { - "name": "Create an article", + "name": "List all data attributes", + "tags": [ + "Data Attributes" + ], "request": { - "method": "POST", "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a collection", + "name": "Create a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "POST", "url": { - "raw": "/help_center/collections", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections" + "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" + } ] }, - "description": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a data attributes for a `contact` or a `company`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Data Attribute\",\n \"model\": \"contact\",\n \"data_type\": \"string\",\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Create a section", + "name": "Update a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "POST", "url": { - "raw": "/help_center/sections", + "raw": "https://api.intercom.io/data_attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "sections" + "data_attributes", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "1", + "disabled": false, + "description": "The data attribute id" + } ] }, - "description": "You can create a new section by making a POST request to `https://api.intercom.io/help_center/sections.`", - "header": [], - "body": {} + "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": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"archived\": false,\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Data Events", + "item": [ { - "name": "Create or Update a company", + "name": "List all data events", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies" + "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" + } ] }, - "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": [], - "body": {} + "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": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all companies", + "name": "Submit a data event", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/companies/list", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "list" + "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" + } ] }, - "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": [], - "body": {} + "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": "2.7" + }, + { + "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": "Attach a Contact to a Company", + "name": "Create event summaries", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/companies", + "raw": "https://api.intercom.io/events/summaries", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "companies" + "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" + } ] }, - "description": "You can attach a company to a single contact.", - "header": [], - "body": {} + "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": "2.7" + }, + { + "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": "Create a note", + "name": "Show content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/notes", + "raw": "https://api.intercom.io/export/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "notes" + "export", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "description": "You can add a note to a single contact.", - "header": [], - "body": {} + "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": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Add subscription to a contact", + "name": "Download content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/download/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions" + "download", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "description": "You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", - "header": [], - "body": {} + "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": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Add tag to a contact", + "name": "Create content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/export/content/data", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags" + "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" + } ] }, - "description": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "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": "Merge a lead and a user", + "name": "Cancel content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/merge", + "raw": "https://api.intercom.io/export/cancel/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "merge" + "export", + "cancel", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", - "header": [], - "body": {} + "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": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Help Center", + "item": [ { - "name": "Search contacts", + "name": "List all collections", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/search", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "search" + "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" + } ] }, - "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| 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", - "header": [], - "body": {} + "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": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create contact", + "name": "Retrieve a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "description": "You can create a new contact (ie. user or lead).", - "header": [], - "body": {} + "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": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Archive contact", + "name": "Retrieve a Help Center", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/archive", + "raw": "https://api.intercom.io/help_center/help_centers/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "archive" + "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." + } ] }, - "description": "You can archive a single contact.", - "header": [], - "body": {} + "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": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Unarchive contact", + "name": "List all Help Centers", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/unarchive", + "raw": "https://api.intercom.io/help_center/help_centers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "unarchive" + "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" + } ] }, - "description": "You can unarchive a single contact.", - "header": [], - "body": {} + "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": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Add tag to a conversation", + "name": "List all sections", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{conversation_id}/tags", + "raw": "https://api.intercom.io/help_center/sections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags" + "help_center", + "sections" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all sections by making a GET request to `https://api.intercom.io/help_center/sections`.\n> 📘 How are the sections sorted and ordered?\n>\n> Sections 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 sections first.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Creates a conversation", + "name": "Retrieve a section", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/help_center/sections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "help_center", + "sections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the section which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 section by making a GET request to `https://api.intercom.io/help_center/sections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Search conversations", + "name": "Create a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/search", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "search" + "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" + } ] }, - "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", - "header": [], - "body": {} + "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": "2.7" + }, + { + "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 \"help_center_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Reply to a conversation", + "name": "Create a section", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/reply", + "raw": "https://api.intercom.io/help_center/sections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "reply" + "help_center", + "sections" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new section by making a POST request to `https://api.intercom.io/help_center/sections.`", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Section 51\",\n \"parent_id\": 18,\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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Manage a conversation", + "name": "Update a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/parts", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "parts" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "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", - "header": [], - "body": {} + "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": "2.7" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Run Assignment Rules on a conversation", + "name": "Update a section", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/run_assignment_rules", + "raw": "https://api.intercom.io/help_center/sections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "run_assignment_rules" + "help_center", + "sections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the section which is given by Intercom." + } ] }, - "description": "{% admonition type=\"danger\" name=\"Deprecation of Run Assignment Rules\" %}\nRun assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail.\n{% /admonition %}\nYou can let a conversation be automatically assigned following assignment rules.\n{% admonition type=\"warning\" name=\"When using workflows\" %}\nIt is not possible to use this endpoint with Workflows.\n{% /admonition %}\n", - "header": [], - "body": {} + "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 section by making a PUT request to `https://api.intercom.io/sections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Section 51\",\n \"parent_id\": 18,\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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Attach a contact to a conversation", + "name": "Delete a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/customers", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "customers" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 collection by making a DELETE request to `https://api.intercom.io/collections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Redact a conversation part", + "name": "Delete a section", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/redact", + "raw": "https://api.intercom.io/help_center/sections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "redact" + "help_center", + "sections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the section which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 section by making a DELETE request to `https://api.intercom.io/sections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Messages", + "item": [ { - "name": "Create a data attribute", + "name": "Create a message", + "tags": [ + "Messages" + ], "request": { - "method": "POST", "url": { - "raw": "/data_attributes", + "raw": "https://api.intercom.io/messages", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes" + "messages" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a data attributes for a `contact` or a `company`.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\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", + "value": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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 \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n \"create_conversation_without_contact_reply\": true\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "News", + "item": [ { - "name": "Submit a data event", + "name": "List all news items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "news", + "news_items" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all news items", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create event summaries", + "name": "Retrieve a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/events/summaries", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events", - "summaries" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create content data export", + "name": "List all live newsfeed items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/export/content/data", + "raw": "https://api.intercom.io/news/newsfeeds/{id}/items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data" + "news", + "newsfeeds", + "{id}", + "items" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } ] }, - "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", - "header": [], - "body": {} + "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 news items that are live on a given newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Cancel content data export", + "name": "List all newsfeeds", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/export/cancel/{job_identifier}", + "raw": "https://api.intercom.io/news/newsfeeds", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "cancel", - "{job_identifier}" + "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" + } ] }, - "description": "You can cancel your job", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all newsfeeds", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a message", + "name": "Retrieve a newsfeed", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/messages", + "raw": "https://api.intercom.io/news/newsfeeds/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "messages" + "news", + "newsfeeds", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } ] }, - "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\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": [], - "body": {} + "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 newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Create a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "news", "news_items" + ], + "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 news item", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Create a phone Switch", + "name": "Update a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/phone_call_redirects", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "phone_call_redirects" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Create or update a tag, Tag or untag companies, Tag contacts", - "request": { - "method": "POST", - "url": { - "raw": "/tags", - "path": [ - "tags" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", - "header": [], - "body": {} + "method": "PUT", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Convert a visitor", + "name": "Delete a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/visitors/convert", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors", - "convert" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Notes", + "item": [ { - "name": "Set an admin to away", + "name": "List all notes", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/admins/{id}/away", + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins", + "contacts", "{id}", - "away" + "notes" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a contact." + } ] }, - "description": "You can set an Admin as away for the Inbox.", - "header": [], - "body": {} + "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 notes that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update an article", + "name": "Retrieve a note", + "tags": [ + "Notes" + ], "request": { - "method": "PUT", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/notes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", + "notes", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "1", + "disabled": false, + "description": "The unique identifier of a given note" + } ] }, - "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "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 note.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a collection", + "name": "Create a note", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", - "{id}" + "contacts", + "{id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given contact." + } ] }, - "description": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} + "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 a note to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"body\": \"New note\",\n \"contact_id\": \"123\",\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Segments", + "item": [ { - "name": "Update a section", + "name": "List all segments", + "tags": [ + "Segments" + ], "request": { - "method": "PUT", "url": { - "raw": "/help_center/sections/{id}", + "raw": "https://api.intercom.io/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "sections", - "{id}" + "segments" + ], + "query": [ + { + "key": "include_count", + "value": "true", + "description": "It includes the count of contacts that belong to each segment." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can update the details of a single section by making a PUT request to `https://api.intercom.io/sections/`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all segments.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a company", + "name": "Retrieve a segment", + "tags": [ + "Segments" + ], "request": { - "method": "PUT", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/segments/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", + "segments", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identified of a given segment." + } ] }, - "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": [], - "body": {} + "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 segment.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Subscription Types", + "item": [ { - "name": "Update a contact", + "name": "List subscription types", + "tags": [ + "Subscription Types" + ], "request": { - "method": "PUT", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/subscription_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}" + "subscription_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can update an existing contact (ie. user or lead).", - "header": [], - "body": {} + "method": "GET", + "description": "You can list all subscription types. A list of subscription type objects will be returned.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a conversation", + "name": "Add subscription to a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}" + "contacts", + "{contact_id}", + "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "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", - "header": [], - "body": {} + "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 a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"37846\",\n \"consent_type\": \"opt_in\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a data attribute", + "name": "Remove subscription from a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/data_attributes/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes", + "contacts", + "{contact_id}", + "subscriptions", "{id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "value": "37846", + "disabled": false, + "description": "The unique identifier for the subscription type which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Switch", + "item": [ { - "name": "Update a news item", + "name": "Create a phone Switch", + "tags": [ + "Switch" + ], "request": { - "method": "PUT", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/phone_call_redirects", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{id}" + "phone_call_redirects" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "", - "header": [], - "body": {} + "method": "POST", + "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"phone\": \"+1 1234567890\",\n \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Tags", + "item": [ { - "name": "Update a visitor", + "name": "List all tags", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/visitors", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors" + "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all tags for a given workspace.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete an article", + "name": "Find a specific tag", + "tags": [ + "Tags" + ], "request": { - "method": "DELETE", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } ] }, - "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "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 tags that are on the workspace by their id.\nThis will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete a collection", + "name": "Add tag to a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "DELETE", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", - "{id}" + "contacts", + "{contact_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} + "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 tag a specific contact. This will return a tag object for the tag that was added to the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a section", + "name": "Add tag to a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "DELETE", "url": { - "raw": "/help_center/sections/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "sections", - "{id}" + "conversations", + "{conversation_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + } ] }, - "description": "You can delete a single section by making a DELETE request to `https://api.intercom.io/sections/`.", - "header": [], - "body": {} + "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 tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"780\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a company", + "name": "Create or update a tag, Tag or untag companies, Tag contacts", + "tags": [ + "Tags" + ], "request": { - "method": "DELETE", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "{id}" + "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single company.", - "header": [], - "body": {} + "method": "POST", + "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Independent\",\n \"id\": \"656452352\",\n \"companies\": [\n {\n \"id\": \"531ee472cce572a6ec000006\",\n \"company_id\": \"6\",\n \"untag\": \"true\"\n }\n ],\n \"users\": [\n {\n \"id\": \"5f7f0d217289f8d2f4262080\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Detach a contact from a company", + "name": "Remove tag from a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/companies/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", - "companies", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier for the tag which is given by Intercom" + } ] }, - "description": "You can detach a company from a single contact.", - "header": [], - "body": {} + "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 tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Remove subscription from a contact", + "name": "Remove tag from a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/subscriptions/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions", + "conversations", + "{conversation_id}", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "id" + } ] }, - "description": "You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", - "header": [], - "body": {} + "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 tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Remove tag from a contact", + "name": "Delete tag", + "tags": [ + "Tags" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/tags/{id}", + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } ] }, - "description": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", - "header": [], - "body": {} + "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 the details of tags that are on the workspace by passing in the id.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Teams", + "item": [ { - "name": "Delete a contact", + "name": "List all teams", + "tags": [ + "Teams" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/teams", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}" + "teams" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single contact.", - "header": [], - "body": {} + "method": "GET", + "description": "This will return a list of team objects for the App.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Remove tag from a conversation", + "name": "Retrieve a team", + "tags": [ + "Teams" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{conversation_id}/tags/{id}", + "raw": "https://api.intercom.io/teams/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags", + "teams", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given team." + } ] }, - "description": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", - "header": [], - "body": {} + "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 team, containing an array of admins that belong to this team.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Visitors", + "item": [ { - "name": "Detach a contact from a group conversation", + "name": "Retrieve a visitor with User ID", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{conversation_id}/customers/{contact_id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "customers", - "{contact_id}" + "visitors" + ], + "query": [ + { + "key": "user_id", + "value": "user_id", + "description": "The user_id of the Visitor you want to retrieve." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single visitor.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.7" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete a news item", + "name": "Convert a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/visitors/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{id}" + "visitors", + "convert" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single news item.", - "header": [], - "body": {} + "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": "2.7" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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\": \"joe@example.com\"\n },\n \"visitor\": {\n \"id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"user_id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"email\": \"joe@example.com\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete tag", + "name": "Update a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/tags/{id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags", - "{id}" + "visitors" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete the details of tags that are on the workspace by passing in the id.", - "header": [], - "body": {} + "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": "2.7" + }, + { + "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": [] + } }, "response": [] } @@ -1711,28 +6430,7 @@ "event": [], "variable": [ { - "id": "4e4661fa-189b-4650-90d1-a68c9b10cc54", - "key": "https://api.intercom.io", - "value": "https://api.intercom.io", - "type": "string", - "description": "The production API server" - }, - { - "id": "c6f33b2c-3fa5-4c20-b1e3-92c7cbd3dc59", - "key": "https://api.eu.intercom.io", - "value": "https://api.eu.intercom.io", - "type": "string", - "description": "The european API server" - }, - { - "id": "4fd2fd9b-d120-4015-91ce-c40178e6d5d0", - "key": "https://api.au.intercom.io", - "value": "https://api.au.intercom.io", - "type": "string", - "description": "The australian API server" - }, - { - "id": "a56e3c18-6718-4e70-99fb-ab47e1efc6cd", + "id": "c4ba1111-57a6-4ce2-a926-7c0dea6c69a9", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/postman/2.8/README.md b/postman/2.8/README.md index eea4f0b..a733543 100644 --- a/postman/2.8/README.md +++ b/postman/2.8/README.md @@ -12,4 +12,4 @@ This directory contains the Postman collection for Intercom API version 2.8. 3. Set your access token in the environment variables 4. Start making API calls! -Last updated: 2025-04-15T14:40:03.437Z +Last updated: 2025-04-25T10:49:25.623Z diff --git a/postman/2.8/intercom-api.postman_collection.json b/postman/2.8/intercom-api.postman_collection.json index fa01935..4d845a7 100644 --- a/postman/2.8/intercom-api.postman_collection.json +++ b/postman/2.8/intercom-api.postman_collection.json @@ -8,1700 +8,6419 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-04-15T14:40:03.436Z" + "updatedAt": "2025-04-25T10:49:25.621Z" }, "item": [ { - "name": "General", + "name": "Admins", "item": [ { "name": "Identify an admin", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/me", + "raw": "https://api.intercom.io/me", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "me" + ], + "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": "\nYou can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology).\n\n> 🚧 Single Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.\n", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List all activity logs", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/activity_logs", + "raw": "https://api.intercom.io/admins/activity_logs", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "admins", "activity_logs" + ], + "query": [ + { + "key": "created_at_after", + "value": "1677253093", + "description": "The start date that you request data for. It must be formatted as a UNIX timestamp." + }, + { + "key": "created_at_before", + "value": "1677861493", + "description": "The end date that you request data for. It must be formatted as a UNIX timestamp." + } + ], + "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 get a log of activities by all admins in an app.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List all admins", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/admins", + "raw": "https://api.intercom.io/admins", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "admins" + ], + "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 admins for a given workspace.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Retrieve an admin", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/{id}", + "raw": "https://api.intercom.io/admins/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "admins", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given admin" + } + ] + }, + "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 details of a single admin.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, + { + "name": "Set an admin to away", + "tags": [ + "Admins" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/admins/{id}/away", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "admins", + "{id}", + "away" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a given admin" + } + ] + }, + "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 set an Admin as away for the Inbox.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"away_mode_enabled\": true,\n \"away_mode_reassign\": false\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Articles", + "item": [ { "name": "List all articles", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "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": "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", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Retrieve an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article 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 article by making a GET request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all collections", + "name": "Create an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections", + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections" + "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" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a collection", + "name": "Update an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", + "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "description": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", - "header": [], - "body": {} + "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 article by making a PUT request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a Help Center", + "name": "Delete an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/help_centers/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "help_centers", + "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 article by making a DELETE request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Companies", + "item": [ { - "name": "List all Help Centers", + "name": "Retrieve companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/help_centers", + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "help_centers" + "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" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", - "header": [], - "body": {} + "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": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all sections", + "name": "Retrieve a company by ID", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/sections", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "sections" + "companies", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch a list of all sections by making a GET request to `https://api.intercom.io/help_center/sections`.\n> 📘 How are the sections sorted and ordered?\n>\n> Sections 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 sections first.\n", - "header": [], - "body": {} + "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 company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a section", + "name": "List attached contacts", + "tags": [ + "Companies", + "Contacts" + ], "request": { + "url": { + "raw": "https://api.intercom.io/companies/{id}/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "{id}", + "contacts" + ], + "query": [], + "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", + "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 contacts that belong to a company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List attached segments for companies", + "tags": [ + "Companies" + ], + "request": { "url": { - "raw": "/help_center/sections/{id}", + "raw": "https://api.intercom.io/companies/{id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "sections", - "{id}" + "companies", + "{id}", + "segments" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch the details of a single section by making a GET request to `https://api.intercom.io/help_center/sections/`.", - "header": [], - "body": {} + "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 segments that belong to a company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve companies", + "name": "Scroll over all companies", + "tags": [ + "Companies" + ], "request": { + "url": { + "raw": "https://api.intercom.io/companies/scroll", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "scroll" + ], + "query": [ + { + "key": "scroll_param", + "value": "scroll_param", + "description": "" + } + ], + "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": " 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", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create or Update a company", + "tags": [ + "Companies" + ], + "request": { "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "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": "2.8" + }, + { + "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\": \"Technology\",\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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a company by ID", + "name": "List all companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/companies/list", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", - "{id}" + "list" + ], + "query": [ + { + "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", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a single company.", - "header": [], - "body": {} + "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", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached contacts", + "name": "Attach a Contact to a Company", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}/contacts", + "raw": "https://api.intercom.io/contacts/{id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", + "contacts", "{id}", - "contacts" + "companies" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can fetch a list of all contacts that belong to a company.", - "header": [], - "body": {} + "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 attach a company to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"58a430d35458202d41b1e65b\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List attached segments for companies", + "name": "Update a company", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}/segments", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", - "{id}", - "segments" + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch a list of all segments that belong to a company.", - "header": [], - "body": {} + "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 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", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Scroll over all companies", + "name": "Delete a company", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/scroll", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", - "scroll" + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached companies for contact", + "name": "Detach a contact from a company", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}/companies", + "raw": "https://api.intercom.io/contacts/{contact_id}/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", - "{id}", - "companies" + "{contact_id}", + "companies", + "{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", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch a list of companies that are associated to a contact.", - "header": [], - "body": {} + "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 detach a company from a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Contacts", + "item": [ { - "name": "List all notes", + "name": "List attached companies for contact", + "tags": [ + "Contacts", + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}/notes", + "raw": "https://api.intercom.io/contacts/{id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{id}", - "notes" + "companies" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can fetch a list of notes that are associated to a contact.", - "header": [], - "body": {} + "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 companies that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List attached segments for contact", + "tags": [ + "Contacts", + "Segments" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/segments", + "raw": "https://api.intercom.io/contacts/{contact_id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "segments" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 a list of segments that are associated to a contact.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List subscriptions for a contact", + "tags": [ + "Contacts", + "Subscription Types" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 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", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List tags attached to a contact", + "tags": [ + "Contacts", + "Tags" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 a list of all tags that are attached to a specific contact.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Get a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "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": "GET", "description": "You can fetch the details of a single contact.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List all contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts" + ], + "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 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", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all conversations", + "name": "Merge a lead and a user", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/contacts/merge", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "contacts", + "merge" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"from\": \"5d70dd30de4efd54f42fd526\",\n \"into\": \"5ba682d23d7cf92bef87bfd4\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a conversation", + "name": "Search contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/contacts/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}" - ] + "contacts", + "search" + ], + "query": [], + "variable": [] }, - "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", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "List all data attributes", - "request": { - "method": "GET", - "url": { - "raw": "/data_attributes", - "path": [ - "data_attributes" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", - "header": [], - "body": {} + "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| 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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "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": "List all data events", + "name": "Create contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "contacts" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can create a new contact (ie. user or lead).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Show content data export", + "name": "Archive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/export/content/data/{job_identifier}", + "raw": "https://api.intercom.io/contacts/{id}/archive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data", - "{job_identifier}" + "contacts", + "{id}", + "archive" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "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": [], - "body": {} - }, - "response": [] - }, - { - "name": "Download content data export", - "request": { - "method": "GET", - "url": { - "raw": "/download/content/data/{job_identifier}", - "path": [ - "download", - "content", - "data", - "{job_identifier}" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can archive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all news items", + "name": "Unarchive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/contacts/{id}/unarchive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items" + "contacts", + "{id}", + "unarchive" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch a list of all news items", - "header": [], - "body": {} + "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 unarchive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a news item", + "name": "Update a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", + "contacts", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch the details of a single news item.", - "header": [], - "body": {} + "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 contact (ie. user or lead).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all live newsfeed items", + "name": "Delete a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{id}/items", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", - "{id}", - "items" + "contacts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch a list of all news items that are live on a given newsfeed", - "header": [], - "body": {} + "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": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Conversations", + "item": [ { - "name": "List all newsfeeds", + "name": "List all conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of all newsfeeds", - "header": [], - "body": {} + "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": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a newsfeed", + "name": "Retrieve a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{id}", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", + "conversations", "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can fetch the details of a single newsfeed", - "header": [], - "body": {} + "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.\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": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a note", + "name": "Creates a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/notes/{id}", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "notes", - "{id}" + "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" + } ] }, - "description": "You can fetch the details of a single note.", - "header": [], - "body": {} + "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": "2.8" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all segments", + "name": "Search conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/segments", + "raw": "https://api.intercom.io/conversations/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments" + "conversations", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of all segments.", - "header": [], - "body": {} + "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 as part of 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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "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": "Retrieve a segment", + "name": "Reply to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/segments/{id}", + "raw": "https://api.intercom.io/conversations/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments", - "{id}" + "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" + } ] }, - "description": "You can fetch the details of a single segment.", - "header": [], - "body": {} + "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.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "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 \"attachment_urls\": \"\",\n \"admin_id\": \"3156780\",\n \"created_at\": 1590000000,\n \"attachment_files\": [\n {\n \"content_type\": \"application/json\",\n \"data\": \"ewogICJ0ZXN0IjogMQp9\",\n \"name\": \"test.json\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List subscription types", + "name": "Manage a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/subscription_types", + "raw": "https://api.intercom.io/conversations/{id}/parts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "subscription_types" + "conversations", + "{id}", + "parts" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can list all subscription types. A list of subscription type objects will be returned.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "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": [] + } }, "response": [] }, { - "name": "List all tags", + "name": "Run Assignment Rules on a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/tags", + "raw": "https://api.intercom.io/conversations/{id}/run_assignment_rules", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags" + "conversations", + "{id}", + "run_assignment_rules" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can fetch a list of all tags for a given workspace.\n\n", - "header": [], - "body": {} + "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=\"danger\" name=\"Deprecation of Run Assignment Rules\" %}\nRun assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail.\n{% /admonition %}\nYou can let a conversation be automatically assigned following assignment rules.\n{% admonition type=\"warning\" name=\"When using workflows\" %}\nIt is not possible to use this endpoint with Workflows.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Find a specific tag", + "name": "Attach a contact to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/tags/{id}", + "raw": "https://api.intercom.io/conversations/{id}/customers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags", - "{id}" + "conversations", + "{id}", + "customers" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can fetch the details of tags that are on the workspace by their id.\nThis will return a tag object.\n", - "header": [], - "body": {} + "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": "2.8" + }, + { + "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\": \"joe@example.com\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all teams", + "name": "Redact a conversation part", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/teams", + "raw": "https://api.intercom.io/conversations/redact", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams" + "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" + } ] }, - "description": "This will return a list of team objects for the App.", - "header": [], - "body": {} + "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": "2.8" + }, + { + "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": "Retrieve a team", + "name": "Update a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/teams/{id}", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams", + "conversations", "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can fetch the details of a single team, containing an array of admins that belong to this team.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"read\": true,\n \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a visitor with User ID", + "name": "Detach a contact from a group conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/visitors", + "raw": "https://api.intercom.io/conversations/{conversation_id}/customers/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors" + "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." + } ] }, - "description": "You can fetch the details of a single visitor.", - "header": [], - "body": {} + "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 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": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"5017690\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Data Attributes", + "item": [ { - "name": "Create an article", + "name": "List all data attributes", + "tags": [ + "Data Attributes" + ], "request": { - "method": "POST", "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a collection", + "name": "Create a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "POST", "url": { - "raw": "/help_center/collections", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections" + "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" + } ] }, - "description": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a data attributes for a `contact` or a `company`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Data Attribute\",\n \"model\": \"contact\",\n \"data_type\": \"string\",\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Create a section", + "name": "Update a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "POST", "url": { - "raw": "/help_center/sections", + "raw": "https://api.intercom.io/data_attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "sections" + "data_attributes", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "1", + "disabled": false, + "description": "The data attribute id" + } ] }, - "description": "You can create a new section by making a POST request to `https://api.intercom.io/help_center/sections.`", - "header": [], - "body": {} + "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": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"archived\": false,\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Data Events", + "item": [ { - "name": "Create or Update a company", + "name": "List all data events", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies" + "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" + } ] }, - "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": [], - "body": {} + "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": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all companies", + "name": "Submit a data event", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/companies/list", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "list" + "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" + } ] }, - "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": [], - "body": {} + "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": "2.8" + }, + { + "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": "Attach a Contact to a Company", + "name": "Create event summaries", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/companies", + "raw": "https://api.intercom.io/events/summaries", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "companies" + "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" + } ] }, - "description": "You can attach a company to a single contact.", - "header": [], - "body": {} + "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": "2.8" + }, + { + "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": "Create a note", + "name": "Show content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/notes", + "raw": "https://api.intercom.io/export/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "notes" + "export", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "description": "You can add a note to a single contact.", - "header": [], - "body": {} + "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": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Add subscription to a contact", + "name": "Download content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/download/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions" + "download", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "description": "You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", - "header": [], - "body": {} + "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": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Add tag to a contact", + "name": "Create content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/export/content/data", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags" + "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" + } ] }, - "description": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "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": "Merge a lead and a user", + "name": "Cancel content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/merge", + "raw": "https://api.intercom.io/export/cancel/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "merge" + "export", + "cancel", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", - "header": [], - "body": {} + "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": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Help Center", + "item": [ { - "name": "Search contacts", + "name": "List all collections", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/search", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "search" + "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" + } ] }, - "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| 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", - "header": [], - "body": {} + "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": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create contact", + "name": "Retrieve a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "description": "You can create a new contact (ie. user or lead).", - "header": [], - "body": {} + "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": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Archive contact", + "name": "Retrieve a Help Center", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/archive", + "raw": "https://api.intercom.io/help_center/help_centers/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "archive" + "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." + } ] }, - "description": "You can archive a single contact.", - "header": [], - "body": {} + "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": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Unarchive contact", + "name": "List all Help Centers", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/unarchive", + "raw": "https://api.intercom.io/help_center/help_centers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "unarchive" + "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" + } ] }, - "description": "You can unarchive a single contact.", - "header": [], - "body": {} + "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": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Add tag to a conversation", + "name": "List all sections", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{conversation_id}/tags", + "raw": "https://api.intercom.io/help_center/sections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags" + "help_center", + "sections" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all sections by making a GET request to `https://api.intercom.io/help_center/sections`.\n> 📘 How are the sections sorted and ordered?\n>\n> Sections 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 sections first.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Creates a conversation", + "name": "Retrieve a section", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/help_center/sections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "help_center", + "sections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the section which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 section by making a GET request to `https://api.intercom.io/help_center/sections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Search conversations", + "name": "Create a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/search", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "search" + "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" + } ] }, - "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 as part of 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", - "header": [], - "body": {} + "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": "2.8" + }, + { + "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 \"help_center_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Reply to a conversation", + "name": "Create a section", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/reply", + "raw": "https://api.intercom.io/help_center/sections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "reply" + "help_center", + "sections" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new section by making a POST request to `https://api.intercom.io/help_center/sections.`", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Section 51\",\n \"parent_id\": 18,\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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Manage a conversation", + "name": "Update a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/parts", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "parts" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "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", - "header": [], - "body": {} + "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": "2.8" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Run Assignment Rules on a conversation", + "name": "Update a section", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/run_assignment_rules", + "raw": "https://api.intercom.io/help_center/sections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "run_assignment_rules" + "help_center", + "sections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the section which is given by Intercom." + } ] }, - "description": "{% admonition type=\"danger\" name=\"Deprecation of Run Assignment Rules\" %}\nRun assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail.\n{% /admonition %}\nYou can let a conversation be automatically assigned following assignment rules.\n{% admonition type=\"warning\" name=\"When using workflows\" %}\nIt is not possible to use this endpoint with Workflows.\n{% /admonition %}\n", - "header": [], - "body": {} + "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 section by making a PUT request to `https://api.intercom.io/sections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Section 51\",\n \"parent_id\": 18,\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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Attach a contact to a conversation", + "name": "Delete a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/customers", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "customers" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 collection by making a DELETE request to `https://api.intercom.io/collections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Redact a conversation part", + "name": "Delete a section", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/redact", + "raw": "https://api.intercom.io/help_center/sections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "redact" + "help_center", + "sections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the section which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 section by making a DELETE request to `https://api.intercom.io/sections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Messages", + "item": [ { - "name": "Create a data attribute", + "name": "Create a message", + "tags": [ + "Messages" + ], "request": { - "method": "POST", "url": { - "raw": "/data_attributes", + "raw": "https://api.intercom.io/messages", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes" + "messages" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a data attributes for a `contact` or a `company`.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\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", + "value": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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 \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n \"create_conversation_without_contact_reply\": true\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "News", + "item": [ { - "name": "Submit a data event", + "name": "List all news items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "news", + "news_items" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all news items", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create event summaries", + "name": "Retrieve a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/events/summaries", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events", - "summaries" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create content data export", + "name": "List all live newsfeed items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/export/content/data", + "raw": "https://api.intercom.io/news/newsfeeds/{id}/items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data" + "news", + "newsfeeds", + "{id}", + "items" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } ] }, - "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", - "header": [], - "body": {} + "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 news items that are live on a given newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Cancel content data export", + "name": "List all newsfeeds", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/export/cancel/{job_identifier}", + "raw": "https://api.intercom.io/news/newsfeeds", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "cancel", - "{job_identifier}" + "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" + } ] }, - "description": "You can cancel your job", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all newsfeeds", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a message", + "name": "Retrieve a newsfeed", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/messages", + "raw": "https://api.intercom.io/news/newsfeeds/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "messages" + "news", + "newsfeeds", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } ] }, - "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\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": [], - "body": {} + "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 newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Create a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "news", "news_items" + ], + "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 news item", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Create a phone Switch", + "name": "Update a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/phone_call_redirects", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "phone_call_redirects" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Create or update a tag, Tag or untag companies, Tag contacts", - "request": { - "method": "POST", - "url": { - "raw": "/tags", - "path": [ - "tags" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", - "header": [], - "body": {} + "method": "PUT", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Convert a visitor", + "name": "Delete a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/visitors/convert", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors", - "convert" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Notes", + "item": [ { - "name": "Set an admin to away", + "name": "List all notes", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/admins/{id}/away", + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins", + "contacts", "{id}", - "away" + "notes" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a contact." + } ] }, - "description": "You can set an Admin as away for the Inbox.", - "header": [], - "body": {} + "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 notes that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update an article", + "name": "Retrieve a note", + "tags": [ + "Notes" + ], "request": { - "method": "PUT", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/notes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", + "notes", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "1", + "disabled": false, + "description": "The unique identifier of a given note" + } ] }, - "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "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 note.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a collection", + "name": "Create a note", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", - "{id}" + "contacts", + "{id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given contact." + } ] }, - "description": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} + "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 a note to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"body\": \"New note\",\n \"contact_id\": \"123\",\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Segments", + "item": [ { - "name": "Update a section", + "name": "List all segments", + "tags": [ + "Segments" + ], "request": { - "method": "PUT", "url": { - "raw": "/help_center/sections/{id}", + "raw": "https://api.intercom.io/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "sections", - "{id}" + "segments" + ], + "query": [ + { + "key": "include_count", + "value": "true", + "description": "It includes the count of contacts that belong to each segment." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can update the details of a single section by making a PUT request to `https://api.intercom.io/sections/`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all segments.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a company", + "name": "Retrieve a segment", + "tags": [ + "Segments" + ], "request": { - "method": "PUT", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/segments/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", + "segments", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identified of a given segment." + } ] }, - "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": [], - "body": {} + "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 segment.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Subscription Types", + "item": [ { - "name": "Update a contact", + "name": "List subscription types", + "tags": [ + "Subscription Types" + ], "request": { - "method": "PUT", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/subscription_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}" + "subscription_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can update an existing contact (ie. user or lead).", - "header": [], - "body": {} + "method": "GET", + "description": "You can list all subscription types. A list of subscription type objects will be returned.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a conversation", + "name": "Add subscription to a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}" + "contacts", + "{contact_id}", + "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "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", - "header": [], - "body": {} + "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 a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"37846\",\n \"consent_type\": \"opt_in\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a data attribute", + "name": "Remove subscription from a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/data_attributes/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes", + "contacts", + "{contact_id}", + "subscriptions", "{id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "value": "37846", + "disabled": false, + "description": "The unique identifier for the subscription type which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Switch", + "item": [ { - "name": "Update a news item", + "name": "Create a phone Switch", + "tags": [ + "Switch" + ], "request": { - "method": "PUT", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/phone_call_redirects", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{id}" + "phone_call_redirects" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "", - "header": [], - "body": {} + "method": "POST", + "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"phone\": \"+1 1234567890\",\n \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Tags", + "item": [ { - "name": "Update a visitor", + "name": "List all tags", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/visitors", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors" + "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all tags for a given workspace.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete an article", + "name": "Find a specific tag", + "tags": [ + "Tags" + ], "request": { - "method": "DELETE", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } ] }, - "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "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 tags that are on the workspace by their id.\nThis will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete a collection", + "name": "Add tag to a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "DELETE", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", - "{id}" + "contacts", + "{contact_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} + "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 tag a specific contact. This will return a tag object for the tag that was added to the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a section", + "name": "Add tag to a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "DELETE", "url": { - "raw": "/help_center/sections/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "sections", - "{id}" + "conversations", + "{conversation_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + } ] }, - "description": "You can delete a single section by making a DELETE request to `https://api.intercom.io/sections/`.", - "header": [], - "body": {} + "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 tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"780\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a company", + "name": "Create or update a tag, Tag or untag companies, Tag contacts", + "tags": [ + "Tags" + ], "request": { - "method": "DELETE", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "{id}" + "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single company.", - "header": [], - "body": {} + "method": "POST", + "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Independent\",\n \"id\": \"656452352\",\n \"companies\": [\n {\n \"id\": \"531ee472cce572a6ec000006\",\n \"company_id\": \"6\",\n \"untag\": \"true\"\n }\n ],\n \"users\": [\n {\n \"id\": \"5f7f0d217289f8d2f4262080\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Detach a contact from a company", + "name": "Remove tag from a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/companies/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", - "companies", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier for the tag which is given by Intercom" + } ] }, - "description": "You can detach a company from a single contact.", - "header": [], - "body": {} + "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 tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Remove subscription from a contact", + "name": "Remove tag from a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/subscriptions/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions", + "conversations", + "{conversation_id}", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "id" + } ] }, - "description": "You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", - "header": [], - "body": {} + "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 tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Remove tag from a contact", + "name": "Delete tag", + "tags": [ + "Tags" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/tags/{id}", + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } ] }, - "description": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", - "header": [], - "body": {} + "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 the details of tags that are on the workspace by passing in the id.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Teams", + "item": [ { - "name": "Delete a contact", + "name": "List all teams", + "tags": [ + "Teams" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/teams", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}" + "teams" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single contact.", - "header": [], - "body": {} + "method": "GET", + "description": "This will return a list of team objects for the App.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Remove tag from a conversation", + "name": "Retrieve a team", + "tags": [ + "Teams" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{conversation_id}/tags/{id}", + "raw": "https://api.intercom.io/teams/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags", + "teams", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given team." + } ] }, - "description": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", - "header": [], - "body": {} + "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 team, containing an array of admins that belong to this team.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Visitors", + "item": [ { - "name": "Detach a contact from a group conversation", + "name": "Retrieve a visitor with User ID", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{conversation_id}/customers/{contact_id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "customers", - "{contact_id}" + "visitors" + ], + "query": [ + { + "key": "user_id", + "value": "user_id", + "description": "The user_id of the Visitor you want to retrieve." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single visitor.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.8" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete a news item", + "name": "Convert a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/visitors/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{id}" + "visitors", + "convert" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single news item.", - "header": [], - "body": {} + "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": "2.8" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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\": \"joe@example.com\"\n },\n \"visitor\": {\n \"id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"user_id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"email\": \"joe@example.com\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete tag", + "name": "Update a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/tags/{id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags", - "{id}" + "visitors" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete the details of tags that are on the workspace by passing in the id.", - "header": [], - "body": {} + "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": "2.8" + }, + { + "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": [] + } }, "response": [] } @@ -1711,28 +6430,7 @@ "event": [], "variable": [ { - "id": "4b388d48-91d8-491f-a315-f1c8933484d5", - "key": "https://api.intercom.io", - "value": "https://api.intercom.io", - "type": "string", - "description": "The production API server" - }, - { - "id": "b352c0ce-fad2-4691-83ba-29dcc8aa42a2", - "key": "https://api.eu.intercom.io", - "value": "https://api.eu.intercom.io", - "type": "string", - "description": "The european API server" - }, - { - "id": "6b34f174-1348-41c3-8787-b800e239eee5", - "key": "https://api.au.intercom.io", - "value": "https://api.au.intercom.io", - "type": "string", - "description": "The australian API server" - }, - { - "id": "f8a4626c-c870-4246-a37d-36463679ed44", + "id": "b06e7ef5-721c-466b-b605-687447e475b6", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/postman/2.9/README.md b/postman/2.9/README.md index f6c4491..d55fa4e 100644 --- a/postman/2.9/README.md +++ b/postman/2.9/README.md @@ -12,4 +12,4 @@ This directory contains the Postman collection for Intercom API version 2.9. 3. Set your access token in the environment variables 4. Start making API calls! -Last updated: 2025-04-15T14:40:03.618Z +Last updated: 2025-04-25T10:49:25.825Z diff --git a/postman/2.9/intercom-api.postman_collection.json b/postman/2.9/intercom-api.postman_collection.json index 9e267e4..cf6e1ae 100644 --- a/postman/2.9/intercom-api.postman_collection.json +++ b/postman/2.9/intercom-api.postman_collection.json @@ -8,1871 +8,7102 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-04-15T14:40:03.617Z" + "updatedAt": "2025-04-25T10:49:25.822Z" }, "item": [ { - "name": "General", + "name": "Admins", "item": [ { "name": "Identify an admin", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/me", + "raw": "https://api.intercom.io/me", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "me" + ], + "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": "\nYou can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology).\n\n> 🚧 Single Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.\n", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List all activity logs", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/activity_logs", + "raw": "https://api.intercom.io/admins/activity_logs", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "admins", "activity_logs" + ], + "query": [ + { + "key": "created_at_after", + "value": "1677253093", + "description": "The start date that you request data for. It must be formatted as a UNIX timestamp." + }, + { + "key": "created_at_before", + "value": "1677861493", + "description": "The end date that you request data for. It must be formatted as a UNIX timestamp." + } + ], + "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 get a log of activities by all admins in an app.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List all admins", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/admins", + "raw": "https://api.intercom.io/admins", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "admins" + ], + "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 admins for a given workspace.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Retrieve an admin", + "tags": [ + "Admins" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/{id}", + "raw": "https://api.intercom.io/admins/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "admins", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given admin" + } + ] + }, + "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 details of a single admin.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, + { + "name": "Set an admin to away", + "tags": [ + "Admins" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/admins/{id}/away", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "admins", + "{id}", + "away" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a given admin" + } + ] + }, + "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 set an Admin as away for the Inbox.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"away_mode_enabled\": true,\n \"away_mode_reassign\": false\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Articles", + "item": [ { "name": "List all articles", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "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": "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", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Retrieve an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article 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 article by making a GET request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all collections", + "name": "Create an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections", + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections" + "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" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a collection", + "name": "Update an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", + "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "description": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", - "header": [], - "body": {} + "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 article by making a PUT request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a Help Center", + "name": "Delete an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/help_centers/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "help_centers", + "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 article by making a DELETE request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Companies", + "item": [ { - "name": "List all Help Centers", + "name": "Retrieve companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/help_centers", + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "help_centers" + "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" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", - "header": [], - "body": {} + "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": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all sections", + "name": "Retrieve a company by ID", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/sections", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "sections" + "companies", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch a list of all sections by making a GET request to `https://api.intercom.io/help_center/sections`.\n> 📘 How are the sections sorted and ordered?\n>\n> Sections 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 sections first.\n", - "header": [], - "body": {} + "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 company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a section", + "name": "List attached contacts", + "tags": [ + "Companies", + "Contacts" + ], "request": { + "url": { + "raw": "https://api.intercom.io/companies/{id}/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "{id}", + "contacts" + ], + "query": [], + "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", + "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 contacts that belong to a company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List attached segments for companies", + "tags": [ + "Companies" + ], + "request": { "url": { - "raw": "/help_center/sections/{id}", + "raw": "https://api.intercom.io/companies/{id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "sections", - "{id}" + "companies", + "{id}", + "segments" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch the details of a single section by making a GET request to `https://api.intercom.io/help_center/sections/`.", - "header": [], - "body": {} + "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 segments that belong to a company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve companies", + "name": "Scroll over all companies", + "tags": [ + "Companies" + ], "request": { + "url": { + "raw": "https://api.intercom.io/companies/scroll", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "scroll" + ], + "query": [ + { + "key": "scroll_param", + "value": "scroll_param", + "description": "" + } + ], + "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": " 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", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create or Update a company", + "tags": [ + "Companies" + ], + "request": { "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "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": "2.9" + }, + { + "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\": \"Technology\",\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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a company by ID", + "name": "List all companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/companies/list", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", - "{id}" + "list" + ], + "query": [ + { + "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", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a single company.", - "header": [], - "body": {} + "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", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached contacts", + "name": "Attach a Contact to a Company", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}/contacts", + "raw": "https://api.intercom.io/contacts/{id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", + "contacts", "{id}", - "contacts" + "companies" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can fetch a list of all contacts that belong to a company.", - "header": [], - "body": {} + "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 attach a company to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"58a430d35458202d41b1e65b\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List attached segments for companies", + "name": "Update a company", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}/segments", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", - "{id}", - "segments" + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch a list of all segments that belong to a company.", - "header": [], - "body": {} + "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 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", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Scroll over all companies", + "name": "Delete a company", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/scroll", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", - "scroll" + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached companies for contact", + "name": "Detach a contact from a company", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}/companies", + "raw": "https://api.intercom.io/contacts/{contact_id}/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", - "{id}", - "companies" + "{contact_id}", + "companies", + "{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", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } ] }, - "description": "You can fetch a list of companies that are associated to a contact.", - "header": [], - "body": {} + "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 detach a company from a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Contacts", + "item": [ { - "name": "List all notes", + "name": "List attached companies for contact", + "tags": [ + "Contacts", + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}/notes", + "raw": "https://api.intercom.io/contacts/{id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{id}", - "notes" + "companies" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "description": "You can fetch a list of notes that are associated to a contact.", - "header": [], - "body": {} + "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 companies that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List attached segments for contact", + "tags": [ + "Contacts", + "Segments" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/segments", + "raw": "https://api.intercom.io/contacts/{contact_id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "segments" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 a list of segments that are associated to a contact.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List subscriptions for a contact", + "tags": [ + "Contacts", + "Subscription Types" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 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", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List tags attached to a contact", + "tags": [ + "Contacts", + "Tags" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{contact_id}", "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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 a list of all tags that are attached to a specific contact.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Get a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "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": "GET", "description": "You can fetch the details of a single contact.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List all contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts" + ], + "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 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", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all conversations", + "name": "Merge a lead and a user", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/contacts/merge", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "contacts", + "merge" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"from\": \"5d70dd30de4efd54f42fd526\",\n \"into\": \"5ba682d23d7cf92bef87bfd4\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a conversation", + "name": "Search contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/contacts/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}" - ] + "contacts", + "search" + ], + "query": [], + "variable": [] }, - "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", - "header": [], - "body": {} + "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 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| 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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "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": "List all data attributes", + "name": "Create contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/data_attributes", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes" + "contacts" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new contact (ie. user or lead).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all data events", + "name": "Archive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/contacts/{id}/archive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "contacts", + "{id}", + "archive" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "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": [], - "body": {} + "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 archive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Show content data export", + "name": "Unarchive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/export/content/data/{job_identifier}", + "raw": "https://api.intercom.io/contacts/{id}/unarchive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data", - "{job_identifier}" + "contacts", + "{id}", + "unarchive" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "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": [], - "body": {} + "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 unarchive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Download content data export", + "name": "Update a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/download/content/data/{job_identifier}", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "download", - "content", - "data", - "{job_identifier}" + "contacts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } ] }, - "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": [], - "body": {} + "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 contact (ie. user or lead).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all news items", + "name": "Delete a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items" + "contacts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "id" + } ] }, - "description": "You can fetch a list of all news items", - "header": [], - "body": {} + "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": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Conversations", + "item": [ { - "name": "Retrieve a news item", + "name": "List all conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{id}" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single news item.", - "header": [], - "body": {} + "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": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all live newsfeed items", + "name": "Retrieve a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{id}/items", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", - "{id}", - "items" + "conversations", + "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can fetch a list of all news items that are live on a given newsfeed", - "header": [], - "body": {} + "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.\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": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all newsfeeds", + "name": "Creates a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds" + "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" + } ] }, - "description": "You can fetch a list of all newsfeeds", - "header": [], - "body": {} + "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": "2.9" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a newsfeed", + "name": "Search conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{id}", + "raw": "https://api.intercom.io/conversations/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", - "{id}" + "conversations", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single newsfeed", - "header": [], - "body": {} + "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 is 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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "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": "Retrieve a note", + "name": "Reply to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/notes/{id}", + "raw": "https://api.intercom.io/conversations/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "notes", - "{id}" + "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" + } ] }, - "description": "You can fetch the details of a single note.", - "header": [], - "body": {} + "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.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "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 \"attachment_urls\": \"\",\n \"admin_id\": \"3156780\",\n \"created_at\": 1590000000,\n \"attachment_files\": [\n {\n \"content_type\": \"application/json\",\n \"data\": \"ewogICJ0ZXN0IjogMQp9\",\n \"name\": \"test.json\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all segments", + "name": "Manage a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/segments", + "raw": "https://api.intercom.io/conversations/{id}/parts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments" + "conversations", + "{id}", + "parts" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can fetch a list of all segments.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Retrieve a segment", + "name": "Run Assignment Rules on a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/segments/{id}", + "raw": "https://api.intercom.io/conversations/{id}/run_assignment_rules", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments", - "{id}" + "conversations", + "{id}", + "run_assignment_rules" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can fetch the details of a single segment.", - "header": [], - "body": {} + "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=\"danger\" name=\"Deprecation of Run Assignment Rules\" %}\nRun assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail.\n{% /admonition %}\nYou can let a conversation be automatically assigned following assignment rules.\n{% admonition type=\"warning\" name=\"When using workflows\" %}\nIt is not possible to use this endpoint with Workflows.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List subscription types", + "name": "Attach a contact to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/subscription_types", + "raw": "https://api.intercom.io/conversations/{id}/customers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "subscription_types" + "conversations", + "{id}", + "customers" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } ] }, - "description": "You can list all subscription types. A list of subscription type objects will be returned.", - "header": [], - "body": {} + "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": "2.9" + }, + { + "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\": \"joe@example.com\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all tags", + "name": "Redact a conversation part", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/tags", + "raw": "https://api.intercom.io/conversations/redact", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags" + "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" + } ] }, - "description": "You can fetch a list of all tags for a given workspace.\n\n", - "header": [], - "body": {} + "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": "2.9" + }, + { + "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": "Find a specific tag", + "name": "Update a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/tags/{id}", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags", + "conversations", "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } ] }, - "description": "You can fetch the details of tags that are on the workspace by their id.\nThis will return a tag object.\n", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"read\": true,\n \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all teams", + "name": "Detach a contact from a group conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/teams", + "raw": "https://api.intercom.io/conversations/{conversation_id}/customers/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams" + "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." + } ] }, - "description": "This will return a list of team objects for the App.", - "header": [], - "body": {} + "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 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": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"5017690\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Data Attributes", + "item": [ { - "name": "Retrieve a team", + "name": "List all data attributes", + "tags": [ + "Data Attributes" + ], "request": { - "method": "GET", "url": { - "raw": "/teams/{id}", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams", - "{id}" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single team, containing an array of admins that belong to this team.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all ticket types", + "name": "Create a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "GET", "url": { - "raw": "/ticket_types", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types" + "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" + } ] }, - "description": "You can get a list of all ticket types for a workspace.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a data attributes for a `contact` or a `company`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Data Attribute\",\n \"model\": \"contact\",\n \"data_type\": \"string\",\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a ticket type", + "name": "Update a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "GET", "url": { - "raw": "/ticket_types/{id}", + "raw": "https://api.intercom.io/data_attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", + "data_attributes", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "1", + "disabled": false, + "description": "The data attribute id" + } ] }, - "description": "You can fetch the details of a single ticket type.", - "header": [], - "body": {} + "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": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"archived\": false,\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Data Events", + "item": [ { - "name": "Retrieve a ticket", + "name": "List all data events", + "tags": [ + "Data Events" + ], "request": { - "method": "GET", "url": { - "raw": "/tickets/{id}", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{id}" + "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" + } ] }, - "description": "You can fetch the details of a single ticket.", - "header": [], - "body": {} + "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": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a visitor with User ID", + "name": "Submit a data event", + "tags": [ + "Data Events" + ], "request": { - "method": "GET", "url": { - "raw": "/visitors", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors" + "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" + } ] }, - "description": "You can fetch the details of a single visitor.", - "header": [], - "body": {} + "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": "2.9" + }, + { + "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 an article", + "name": "Create event summaries", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/events/summaries", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles" + "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" + } ] }, - "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", - "header": [], - "body": {} + "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": "2.9" + }, + { + "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": "Create a collection", + "name": "Show content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/help_center/collections", + "raw": "https://api.intercom.io/export/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections" + "export", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "description": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Create a section", - "request": { - "method": "POST", - "url": { - "raw": "/help_center/sections", - "path": [ - "help_center", - "sections" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a new section by making a POST request to `https://api.intercom.io/help_center/sections.`", - "header": [], - "body": {} + "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": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create or Update a company", + "name": "Download content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/download/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies" + "download", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "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": [], - "body": {} - }, - "response": [] - }, - { - "name": "List all companies", - "request": { - "method": "POST", - "url": { - "raw": "/companies/list", - "path": [ - "companies", - "list" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "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": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Attach a Contact to a Company", + "name": "Create content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/companies", + "raw": "https://api.intercom.io/export/content/data", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "companies" + "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" + } ] }, - "description": "You can attach a company to a single contact.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "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": "Create a note", + "name": "Cancel content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/notes", + "raw": "https://api.intercom.io/export/cancel/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "notes" + "export", + "cancel", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } ] }, - "description": "You can add a note to a single contact.", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Add subscription to a contact", - "request": { - "method": "POST", - "url": { - "raw": "/contacts/{contact_id}/subscriptions", - "path": [ - "contacts", - "{contact_id}", - "subscriptions" + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", - "header": [], - "body": {} + "method": "POST", + "description": "You can cancel your job", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Help Center", + "item": [ { - "name": "Add tag to a contact", + "name": "List all collections", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags" + "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" + } ] }, - "description": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", - "header": [], - "body": {} + "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": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Merge a lead and a user", + "name": "Retrieve a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/merge", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "merge" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", - "header": [], - "body": {} + "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": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Search contacts", + "name": "Retrieve a Help Center", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/search", + "raw": "https://api.intercom.io/help_center/help_centers/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "search" + "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." + } ] }, - "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| 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", - "header": [], - "body": {} + "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": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create contact", + "name": "List all Help Centers", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts", + "raw": "https://api.intercom.io/help_center/help_centers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts" + "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" + } ] }, - "description": "You can create a new contact (ie. user or lead).", - "header": [], - "body": {} + "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": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Archive contact", + "name": "List all sections", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/archive", + "raw": "https://api.intercom.io/help_center/sections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "archive" + "help_center", + "sections" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can archive a single contact.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all sections by making a GET request to `https://api.intercom.io/help_center/sections`.\n> 📘 How are the sections sorted and ordered?\n>\n> Sections 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 sections first.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Unarchive contact", + "name": "Retrieve a section", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/unarchive", + "raw": "https://api.intercom.io/help_center/sections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "unarchive" + "help_center", + "sections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the section which is given by Intercom." + } ] }, - "description": "You can unarchive a single contact.", - "header": [], - "body": {} + "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 section by making a GET request to `https://api.intercom.io/help_center/sections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Add tag to a conversation", + "name": "Create a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{conversation_id}/tags", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags" + "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" + } ] }, - "description": "You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", - "header": [], - "body": {} + "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": "2.9" + }, + { + "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 \"help_center_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Creates a conversation", + "name": "Create a section", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/help_center/sections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "help_center", + "sections" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can create a new section by making a POST request to `https://api.intercom.io/help_center/sections.`", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Section 51\",\n \"parent_id\": 18,\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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Search conversations", + "name": "Update a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/search", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "search" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "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 is 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", - "header": [], - "body": {} + "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": "2.9" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Reply to a conversation", + "name": "Update a section", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/reply", + "raw": "https://api.intercom.io/help_center/sections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "reply" + "help_center", + "sections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the section which is given by Intercom." + } ] }, - "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.", - "header": [], - "body": {} + "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 section by making a PUT request to `https://api.intercom.io/sections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Section 51\",\n \"parent_id\": 18,\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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Manage a conversation", + "name": "Delete a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/parts", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "parts" + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } ] }, - "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", - "header": [], - "body": {} + "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 collection by making a DELETE request to `https://api.intercom.io/collections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Run Assignment Rules on a conversation", + "name": "Delete a section", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/run_assignment_rules", + "raw": "https://api.intercom.io/help_center/sections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "run_assignment_rules" + "help_center", + "sections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the section which is given by Intercom." + } ] }, - "description": "{% admonition type=\"danger\" name=\"Deprecation of Run Assignment Rules\" %}\nRun assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail.\n{% /admonition %}\nYou can let a conversation be automatically assigned following assignment rules.\n{% admonition type=\"warning\" name=\"When using workflows\" %}\nIt is not possible to use this endpoint with Workflows.\n{% /admonition %}\n", - "header": [], - "body": {} + "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 section by making a DELETE request to `https://api.intercom.io/sections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Messages", + "item": [ { - "name": "Attach a contact to a conversation", + "name": "Create a message", + "tags": [ + "Messages" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/customers", + "raw": "https://api.intercom.io/messages", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "customers" + "messages" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\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", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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 \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n \"create_conversation_without_contact_reply\": true\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "News", + "item": [ { - "name": "Redact a conversation part", + "name": "List all news items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/redact", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "redact" + "news", + "news_items" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all news items", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a data attribute", + "name": "Retrieve a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/data_attributes", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "description": "You can create a data attributes for a `contact` or a `company`.", - "header": [], - "body": {} + "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 news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Submit a data event", + "name": "List all live newsfeed items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/news/newsfeeds/{id}/items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "news", + "newsfeeds", + "{id}", + "items" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 news items that are live on a given newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create event summaries", + "name": "List all newsfeeds", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/events/summaries", + "raw": "https://api.intercom.io/news/newsfeeds", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events", - "summaries" + "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" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all newsfeeds", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create content data export", + "name": "Retrieve a newsfeed", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/export/content/data", + "raw": "https://api.intercom.io/news/newsfeeds/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data" + "news", + "newsfeeds", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } ] }, - "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", - "header": [], - "body": {} + "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 newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Cancel content data export", + "name": "Create a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/export/cancel/{job_identifier}", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "cancel", - "{job_identifier}" + "news", + "news_items" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can cancel your job", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a news item", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Create a message", + "name": "Update a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/messages", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "messages" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\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": [], - "body": {} + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Create a news item", + "name": "Delete a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "news", - "news_items" + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } ] }, - "description": "You can create a news item", - "header": [], - "body": {} + "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 news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Notes", + "item": [ { - "name": "Create a phone Switch", + "name": "List all notes", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/phone_call_redirects", + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "phone_call_redirects" + "contacts", + "{id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a contact." + } ] }, - "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", - "header": [], - "body": {} + "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 notes that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create or update a tag, Tag or untag companies, Tag contacts", + "name": "Retrieve a note", + "tags": [ + "Notes" + ], "request": { - "method": "POST", "url": { - "raw": "/tags", + "raw": "https://api.intercom.io/notes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags" + "notes", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "1", + "disabled": false, + "description": "The unique identifier of a given note" + } ] }, - "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", - "header": [], - "body": {} + "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 note.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a new attribute for a ticket type", + "name": "Create a note", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/ticket_types/{ticket_type_id}/attributes", + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{ticket_type_id}", - "attributes" + "contacts", + "{id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given contact." + } ] }, - "description": "You can create a new attribute for a ticket type.", - "header": [], - "body": {} + "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 a note to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"body\": \"New note\",\n \"contact_id\": \"123\",\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Segments", + "item": [ { - "name": "Create a ticket type", + "name": "List all segments", + "tags": [ + "Segments" + ], "request": { - "method": "POST", "url": { - "raw": "/ticket_types", + "raw": "https://api.intercom.io/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types" + "segments" + ], + "query": [ + { + "key": "include_count", + "value": "true", + "description": "It includes the count of contacts that belong to each segment." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a new ticket type.\n> 📘 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: _default_title_ and _default_description_.\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all segments.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Reply to a ticket", + "name": "Retrieve a segment", + "tags": [ + "Segments" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/{id}/reply", + "raw": "https://api.intercom.io/segments/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{id}", - "reply" + "segments", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identified of a given segment." + } ] }, - "description": "You can reply to a ticket with a note from an admin.", - "header": [], - "body": {} + "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 segment.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Subscription Types", + "item": [ { - "name": "Create a ticket", + "name": "List subscription types", + "tags": [ + "Subscription Types" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets", + "raw": "https://api.intercom.io/subscription_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets" + "subscription_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a new ticket.", - "header": [], - "body": {} + "method": "GET", + "description": "You can list all subscription types. A list of subscription type objects will be returned.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Convert a visitor", + "name": "Add subscription to a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/visitors/convert", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors", - "convert" + "contacts", + "{contact_id}", + "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"37846\",\n \"consent_type\": \"opt_in\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Set an admin to away", + "name": "Remove subscription from a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/admins/{id}/away", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins", - "{id}", - "away" + "contacts", + "{contact_id}", + "subscriptions", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "value": "37846", + "disabled": false, + "description": "The unique identifier for the subscription type which is given by Intercom" + } ] }, - "description": "You can set an Admin as away for the Inbox.", - "header": [], - "body": {} + "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 a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Switch", + "item": [ { - "name": "Update an article", + "name": "Create a phone Switch", + "tags": [ + "Switch" + ], "request": { - "method": "PUT", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/phone_call_redirects", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", - "{id}" + "phone_call_redirects" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "method": "POST", + "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"phone\": \"+1 1234567890\",\n \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Tags", + "item": [ { - "name": "Update a collection", + "name": "List all tags", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", - "{id}" + "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all tags for a given workspace.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a section", + "name": "Find a specific tag", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/help_center/sections/{id}", + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "sections", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } ] }, - "description": "You can update the details of a single section by making a PUT request to `https://api.intercom.io/sections/`.", - "header": [], - "body": {} + "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 tags that are on the workspace by their id.\nThis will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a company", + "name": "Add tag to a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "{id}" + "contacts", + "{contact_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 tag a specific contact. This will return a tag object for the tag that was added to the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a contact", + "name": "Add tag to a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "PUT", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}" + "conversations", + "{conversation_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + } ] }, - "description": "You can update an existing contact (ie. user or lead).", - "header": [], - "body": {} + "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 tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"780\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a conversation", + "name": "Create or update a tag, Tag or untag companies, Tag contacts", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}" + "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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", - "header": [], - "body": {} + "method": "POST", + "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Independent\",\n \"id\": \"656452352\",\n \"companies\": [\n {\n \"id\": \"531ee472cce572a6ec000006\",\n \"company_id\": \"6\",\n \"untag\": \"true\"\n }\n ],\n \"users\": [\n {\n \"id\": \"5f7f0d217289f8d2f4262080\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a data attribute", + "name": "Remove tag from a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/data_attributes/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes", + "contacts", + "{contact_id}", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier for the tag which is given by Intercom" + } ] }, - "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": [], - "body": {} + "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 tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a news item", + "name": "Remove tag from a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "PUT", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", + "conversations", + "{conversation_id}", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + }, + { + "key": "id", + "value": "7522907", + "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" + } ] }, - "description": "", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update an existing attribute for a ticket type", + "name": "Delete tag", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/ticket_types/{ticket_type_id}/attributes/{id}", + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{ticket_type_id}", - "attributes", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } ] }, - "description": "You can update an existing attribute for a ticket type.", - "header": [], - "body": {} + "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 the details of tags that are on the workspace by passing in the id.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Teams", + "item": [ { - "name": "Update a ticket type", + "name": "List all teams", + "tags": [ + "Teams" + ], "request": { - "method": "PUT", "url": { - "raw": "/ticket_types/{id}", + "raw": "https://api.intercom.io/teams", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{id}" + "teams" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "\nYou can update a ticket type.\n\n> 📘 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", - "header": [], - "body": {} + "method": "GET", + "description": "This will return a list of team objects for the App.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a ticket", + "name": "Retrieve a team", + "tags": [ + "Teams" + ], "request": { - "method": "PUT", "url": { - "raw": "/tickets/{id}", + "raw": "https://api.intercom.io/teams/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", + "teams", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given team." + } ] }, - "description": "You can update a ticket.", - "header": [], - "body": {} + "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 team, containing an array of admins that belong to this team.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Ticket Type Attributes", + "item": [ { - "name": "Update a visitor", + "name": "Create a new attribute for a ticket type", + "tags": [ + "Ticket Type Attributes" + ], "request": { - "method": "PUT", "url": { - "raw": "/visitors", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors" + "ticket_types", + "{ticket_type_id}", + "attributes" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } ] }, - "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": [], - "body": {} + "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 attribute for a ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug Priority\",\n \"description\": \"Priority level of the bug\",\n \"data_type\": \"string\",\n \"required_to_create\": false,\n \"required_to_create_for_contacts\": false,\n \"visible_on_create\": true,\n \"visible_to_contacts\": true,\n \"multiline\": false,\n \"list_items\": \"Low Priority,Medium Priority,High Priority\",\n \"allow_multiple_values\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete an article", + "name": "Update an existing attribute for a ticket type", + "tags": [ + "Ticket Type Attributes" + ], "request": { - "method": "DELETE", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", + "ticket_types", + "{ticket_type_id}", + "attributes", "{id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + }, + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket type attribute which is given by Intercom." + } ] }, - "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "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 attribute for a ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug Priority\",\n \"description\": \"Priority level of the bug\",\n \"required_to_create\": false,\n \"required_to_create_for_contacts\": false,\n \"visible_on_create\": true,\n \"visible_to_contacts\": true,\n \"multiline\": false,\n \"list_items\": \"Low Priority,Medium Priority,High Priority\",\n \"allow_multiple_values\": false,\n \"archived\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Ticket Types", + "item": [ { - "name": "Delete a collection", + "name": "List all ticket types", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/ticket_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", - "{id}" + "ticket_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can get a list of all ticket types for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete a section", + "name": "Retrieve a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/help_center/sections/{id}", + "raw": "https://api.intercom.io/ticket_types/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "sections", + "ticket_types", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } ] }, - "description": "You can delete a single section by making a DELETE request to `https://api.intercom.io/sections/`.", - "header": [], - "body": {} + "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 ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete a company", + "name": "Create a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/ticket_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "{id}" + "ticket_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single company.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new ticket type.\n> 📘 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: _default_title_ and _default_description_.\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug\",\n \"description\": \"Used for tracking bugs\",\n \"icon\": \"🐞\",\n \"is_internal\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Detach a contact from a company", + "name": "Update a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/companies/{id}", + "raw": "https://api.intercom.io/ticket_types/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "companies", + "ticket_types", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } ] }, - "description": "You can detach a company from a single contact.", - "header": [], - "body": {} + "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 ticket type.\n\n> 📘 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug\",\n \"description\": \"A bug has been occured\",\n \"icon\": \"🐞\",\n \"archived\": false,\n \"is_internal\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Tickets", + "item": [ { - "name": "Remove subscription from a contact", + "name": "Retrieve a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/subscriptions/{id}", + "raw": "https://api.intercom.io/tickets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions", + "tickets", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom." + } ] }, - "description": "You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", - "header": [], - "body": {} + "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 ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Remove tag from a contact", + "name": "Reply to a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/tags/{id}", + "raw": "https://api.intercom.io/tickets/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags", - "{id}" + "tickets", + "{id}", + "reply" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false + } ] }, - "description": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", - "header": [], - "body": {} + "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 ticket with a note from an admin.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"body\": \"

Okay!

\",\n \"message_type\": \"note\",\n \"admin_id\": \"1234\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a contact", + "name": "Create a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/tickets", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}" + "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" + } ] }, - "description": "You can delete a single contact.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "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 \"company_id\": \"1234\",\n \"ticket_attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Remove tag from a conversation", + "name": "Update a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{conversation_id}/tags/{id}", + "raw": "https://api.intercom.io/tickets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags", + "tickets", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom" + } ] }, - "description": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", - "header": [], - "body": {} + "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 a ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ticket_attributes\": {\n \"_default_title_\": \"example\",\n \"_default_description_\": \"having a problem\"\n },\n \"state\": \"submitted\",\n \"is_shared\": true,\n \"assignment\": {\n \"admin_id\": \"123\",\n \"assignee_id\": \"123\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Visitors", + "item": [ { - "name": "Detach a contact from a group conversation", + "name": "Retrieve a visitor with User ID", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{conversation_id}/customers/{contact_id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "customers", - "{contact_id}" + "visitors" + ], + "query": [ + { + "key": "user_id", + "value": "user_id", + "description": "The user_id of the Visitor you want to retrieve." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single visitor.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.9" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete a news item", + "name": "Convert a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/visitors/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{id}" + "visitors", + "convert" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single news item.", - "header": [], - "body": {} + "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": "2.9" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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\": \"joe@example.com\"\n },\n \"visitor\": {\n \"id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"user_id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"email\": \"joe@example.com\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete tag", + "name": "Update a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/tags/{id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags", - "{id}" + "visitors" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete the details of tags that are on the workspace by passing in the id.", - "header": [], - "body": {} + "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": "2.9" + }, + { + "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": [] + } }, "response": [] } @@ -1882,28 +7113,7 @@ "event": [], "variable": [ { - "id": "60167912-5632-4d65-9914-7918df9a3e5b", - "key": "https://api.intercom.io", - "value": "https://api.intercom.io", - "type": "string", - "description": "The production API server" - }, - { - "id": "9abe27b7-def6-4964-83ec-f55cdb15e70b", - "key": "https://api.eu.intercom.io", - "value": "https://api.eu.intercom.io", - "type": "string", - "description": "The european API server" - }, - { - "id": "ad955e7f-67a5-4ada-afec-eaee68fa2219", - "key": "https://api.au.intercom.io", - "value": "https://api.au.intercom.io", - "type": "string", - "description": "The australian API server" - }, - { - "id": "65ec7c79-bcc2-482f-8d39-8905884c70fb", + "id": "29388de1-da62-4158-966c-1fa8df19b721", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/postman/README.md b/postman/README.md deleted file mode 100644 index e0ccfb5..0000000 --- a/postman/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Intercom API Postman Collections -... \ No newline at end of file diff --git a/postman/Unstable/README.md b/postman/Unstable/README.md index f01ec3c..49b48d5 100644 --- a/postman/Unstable/README.md +++ b/postman/Unstable/README.md @@ -12,4 +12,4 @@ This directory contains the Postman collection for Intercom API version Unstable 3. Set your access token in the environment variables 4. Start making API calls! -Last updated: 2025-04-15T14:40:02.148Z +Last updated: 2025-04-25T10:49:24.297Z diff --git a/postman/Unstable/intercom-api.postman_collection.json b/postman/Unstable/intercom-api.postman_collection.json index 29c8c97..58a8b4a 100644 --- a/postman/Unstable/intercom-api.postman_collection.json +++ b/postman/Unstable/intercom-api.postman_collection.json @@ -8,2254 +8,8500 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-04-15T14:40:02.147Z" + "updatedAt": "2025-04-25T10:49:24.294Z" }, "item": [ { - "name": "General", + "name": "AI Content", "item": [ { - "name": "Identify an admin", + "name": "List content import sources", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/me", + "raw": "https://api.intercom.io/ai/content_import_sources", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "me" + "ai", + "content_import_sources" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "\nYou can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology).\n\n> 🚧 Single Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.\n", - "header": [], - "body": {} + "method": "GET", + "description": "You can retrieve a list of all content import sources for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all activity logs", + "name": "Retrieve a content import source", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/activity_logs", + "raw": "https://api.intercom.io/ai/content_import_sources/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins", - "activity_logs" + "ai", + "content_import_sources", + "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can get a log of activities by all admins in an app.", - "header": [], - "body": {} + "method": "GET", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all admins", + "name": "List external pages", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/admins", + "raw": "https://api.intercom.io/ai/external_pages", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins" + "ai", + "external_pages" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of admins for a given workspace.", - "header": [], - "body": {} + "method": "GET", + "description": "You can retrieve a list of all external pages for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve an admin", + "name": "Retrieve an external page", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/admins/{id}", + "raw": "https://api.intercom.io/ai/external_pages/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins", + "ai", + "external_pages", "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can retrieve the details of a single admin.", - "header": [], - "body": {} + "method": "GET", + "description": "You can retrieve an external page.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List content import sources", + "name": "Create a content import source", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/ai/content_import_sources", + "raw": "https://api.intercom.io/ai/content_import_sources", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "ai", "content_import_sources" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can retrieve a list of all content import sources for a workspace.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new content import source by sending a POST request to this endpoint.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"sync_behavior\": \"api\",\n \"status\": \"active\",\n \"url\": \"https://help.example.com\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a content import source", + "name": "Create an external page (or update an external page by external ID)", + "tags": [ + "AI Content" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/ai/external_pages", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ai", + "external_pages" + ], + "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 external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Update a content import source", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/ai/content_import_sources/{id}", + "raw": "https://api.intercom.io/ai/content_import_sources/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "ai", "content_import_sources", "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "", - "header": [], - "body": {} + "method": "PUT", + "description": "You can update an existing content import source.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"sync_behavior\": \"api\",\n \"status\": \"active\",\n \"url\": \"https://help.example.com\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List external pages", + "name": "Update an external page", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/ai/external_pages", + "raw": "https://api.intercom.io/ai/external_pages/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "ai", - "external_pages" + "external_pages", + "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can retrieve a list of all external pages for a workspace.", - "header": [], - "body": {} + "method": "PUT", + "description": "You can update an existing external page (if it was created via the API).", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve an external page", + "name": "Delete a content import source", + "tags": [ + "AI Content" + ], "request": { - "method": "GET", "url": { - "raw": "/ai/external_pages/{id}", + "raw": "https://api.intercom.io/ai/content_import_sources/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "ai", - "external_pages", + "content_import_sources", "{id}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can retrieve an external page.", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all articles", + "name": "Delete an external page", + "tags": [ + "AI Content" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/ai/external_pages/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ai", + "external_pages", + "{id}" + ], + "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": "DELETE", + "description": "Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Admins", + "item": [ + { + "name": "Identify an admin", + "tags": [ + "Admins" + ], "request": { + "url": { + "raw": "https://api.intercom.io/me", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "me" + ], + "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": "\nYou can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology).\n\n> 🚧 Single Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List all activity logs", + "tags": [ + "Admins" + ], + "request": { "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/admins/activity_logs", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles" + "admins", + "activity_logs" + ], + "query": [ + { + "key": "created_at_after", + "value": "1677253093", + "description": "The start date that you request data for. It must be formatted as a UNIX timestamp." + }, + { + "key": "created_at_before", + "value": "1677861493", + "description": "The end date that you request data for. It must be formatted as a UNIX timestamp." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can get a log of activities by all admins in an app.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve an article", + "name": "List all admins", + "tags": [ + "Admins" + ], "request": { + "url": { + "raw": "https://api.intercom.io/admins", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "admins" + ], + "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 admins for a given workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve an admin", + "tags": [ + "Admins" + ], + "request": { "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/admins/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", + "admins", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given admin" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can retrieve the details of a single admin.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Search for articles", + "name": "Set an admin to away", + "tags": [ + "Admins" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/admins/{id}/away", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "admins", + "{id}", + "away" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a given admin" + } + ] + }, + "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 set an Admin as away for the Inbox.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"away_mode_enabled\": true,\n \"away_mode_reassign\": false,\n \"away_status_reason_id\": 12345\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Articles", + "item": [ + { + "name": "List all articles", + "tags": [ + "Articles" + ], "request": { + "url": { + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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": "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", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve an article", + "tags": [ + "Articles" + ], + "request": { "url": { - "raw": "/articles/search", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "articles", - "search" + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article 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" + } ] }, - "description": "You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.", - "header": [], - "body": {} + "method": "GET", + "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", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all away status reasons", + "name": "Search for articles", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "Returns a list of all away status reasons configured for the workspace, including deleted ones.", - "header": [], - "body": {} + "method": "GET", + "description": "You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all collections", + "name": "Create an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections", + "raw": "https://api.intercom.io/articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections" + "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" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a collection", + "name": "Update an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", + "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article 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" + } ] }, - "description": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", - "header": [], - "body": {} + "method": "PUT", + "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a Help Center", + "name": "Delete an article", + "tags": [ + "Articles" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/help_centers/{id}", + "raw": "https://api.intercom.io/articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "help_centers", + "articles", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article 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" + } ] }, - "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": [], - "body": {} + "method": "DELETE", + "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Away Status Reasons", + "item": [ { - "name": "List all Help Centers", + "name": "List all away status reasons", + "tags": [ + "Away Status Reasons" + ], "request": { - "method": "GET", "url": { - "raw": "/help_center/help_centers", + "raw": "https://api.intercom.io/away_status_reasons", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "help_centers" + "away_status_reasons" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", - "header": [], - "body": {} + "method": "GET", + "description": "Returns a list of all away status reasons configured for the workspace, including deleted ones.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Companies", + "item": [ { "name": "Retrieve companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "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" + } + ], + "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 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": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Retrieve a company by ID", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", "{id}" + ], + "query": [], + "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", + "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 company.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List attached contacts", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}/contacts", + "raw": "https://api.intercom.io/companies/{id}/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", "{id}", "contacts" + ], + "query": [], + "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", + "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 contacts that belong to a company.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "List attached segments for companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/{id}/segments", + "raw": "https://api.intercom.io/companies/{id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", "{id}", "segments" + ], + "query": [], + "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", + "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 segments that belong to a company.", - "header": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { "name": "Scroll over all companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/companies/scroll", + "raw": "https://api.intercom.io/companies/scroll", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "companies", "scroll" + ], + "query": [ + { + "key": "scroll_param", + "value": "scroll_param", + "description": "" + } + ], + "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": " 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": [], - "body": {} + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached companies for contact", + "name": "Create or Update a company", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}/companies", + "raw": "https://api.intercom.io/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", "companies" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of companies that are associated to a contact.", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all notes", + "name": "List all companies", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}/notes", + "raw": "https://api.intercom.io/companies/list", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "notes" + "companies", + "list" + ], + "query": [ + { + "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", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of notes that are associated to a contact.", - "header": [], - "body": {} + "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", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List attached segments for contact", + "name": "Attach a Contact to a Company", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/segments", + "raw": "https://api.intercom.io/contacts/{id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", - "{contact_id}", - "segments" + "{id}", + "companies" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the contact 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" + } ] }, - "description": "You can fetch a list of segments that are associated to a contact.", - "header": [], - "body": {} + "method": "POST", + "description": "You can attach a company to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"58a430d35458202d41b1e65b\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List subscriptions for a contact", + "name": "Update a company", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions" + "companies", + "{id}" + ], + "query": [], + "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", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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", - "header": [], - "body": {} + "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", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List tags attached to a contact", + "name": "Delete a company", + "tags": [ + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags" + "companies", + "{id}" + ], + "query": [], + "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", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of all tags that are attached to a specific contact.", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can delete a single company.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Get a contact", + "name": "Detach a contact from a company", + "tags": [ + "Companies", + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/companies/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", + "{contact_id}", + "companies", "{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", + "disabled": false, + "description": "The unique identifier for the company 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" + } ] }, - "description": "You can fetch the details of a single contact.", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can detach a company from a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Contacts", + "item": [ { - "name": "List all contacts", + "name": "List attached companies for contact", + "tags": [ + "Contacts", + "Companies" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts", + "raw": "https://api.intercom.io/contacts/{id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts" + "contacts", + "{id}", + "companies" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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" + } ] }, - "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", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of companies that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Get a contact by External ID", + "name": "List attached segments for contact", + "tags": [ + "Contacts", + "Segments" + ], "request": { - "method": "GET", "url": { - "raw": "/contacts/find_by_external_id/{external_id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "contacts", - "find_by_external_id", - "{external_id}" + "{contact_id}", + "segments" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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" + } ] }, - "description": "You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of segments that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all conversations", + "name": "List subscriptions for a contact", + "tags": [ + "Contacts", + "Subscription Types" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "contacts", + "{contact_id}", + "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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" + } ] }, - "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": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a conversation", + "name": "List tags attached to a contact", + "tags": [ + "Contacts", + "Tags" + ], "request": { - "method": "GET", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}" + "contacts", + "{contact_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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" + } ] }, - "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", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all tags that are attached to a specific contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Get Custom Object Instance by External ID", + "name": "Get a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/custom_object_instances/{custom_object_type_identifier}", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}" + "contacts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "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" + } ] }, - "description": "Fetch a Custom Object Instance by external_id.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Get Custom Object Instance by ID", + "name": "List all contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/custom_object_instances/{custom_object_type_identifier}/{id}", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}", - "{id}" + "contacts" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "Fetch a Custom Object Instance by id.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all data attributes", + "name": "Get a contact by External ID", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/data_attributes", + "raw": "https://api.intercom.io/contacts/find_by_external_id/{external_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes" + "contacts", + "find_by_external_id", + "{external_id}" + ], + "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": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", - "header": [], - "body": {} + "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.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all data events", + "name": "Merge a lead and a user", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/contacts/merge", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "contacts", + "merge" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"from\": \"5d70dd30de4efd54f42fd526\",\n \"into\": \"5ba682d23d7cf92bef87bfd4\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Show content data export", + "name": "Search contacts", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/export/content/data/{job_identifier}", + "raw": "https://api.intercom.io/contacts/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data", - "{job_identifier}" + "contacts", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "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": "Download content data export", + "name": "Create contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/download/content/data/{job_identifier}", + "raw": "https://api.intercom.io/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "download", - "content", - "data", - "{job_identifier}" + "contacts" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can create a new contact (ie. user or lead).", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve job status", + "name": "Archive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/jobs/status/{id}", + "raw": "https://api.intercom.io/contacts/{id}/archive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "jobs", - "status", - "{id}" + "contacts", + "{id}", + "archive" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "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" + } ] }, - "description": "Retrieve the status of job execution.", - "header": [], - "body": {} + "method": "POST", + "description": "You can archive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all news items", + "name": "Unarchive contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/contacts/{id}/unarchive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items" + "contacts", + "{id}", + "unarchive" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "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" + } ] }, - "description": "You can fetch a list of all news items", - "header": [], - "body": {} + "method": "POST", + "description": "You can unarchive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a news item", + "name": "Block contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/contacts/{id}/block", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", - "{id}" + "contacts", + "{id}", + "block" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "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" + } ] }, - "description": "You can fetch the details of a single news item.", - "header": [], - "body": {} + "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", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all live newsfeed items", + "name": "Update a contact", + "tags": [ + "Contacts", + "Custom Object Instances" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{id}/items", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", - "{id}", - "items" + "contacts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "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" + } ] }, - "description": "You can fetch a list of all news items that are live on a given newsfeed", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "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 \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all newsfeeds", + "name": "Delete a contact", + "tags": [ + "Contacts" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds", + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds" + "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" + } ] }, - "description": "You can fetch a list of all newsfeeds", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can delete a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Conversations", + "item": [ { - "name": "Retrieve a newsfeed", + "name": "List all conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/news/newsfeeds/{id}", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "newsfeeds", - "{id}" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single newsfeed", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a note", + "name": "Retrieve a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/notes/{id}", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "notes", + "conversations", "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain 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" + } ] }, - "description": "You can fetch the details of a single note.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all segments", + "name": "Creates a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/segments", + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments" + "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" + } ] }, - "description": "You can fetch a list of all segments.", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "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 \"created_at\": 1671028894\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a segment", + "name": "Search conversations", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/segments/{id}", + "raw": "https://api.intercom.io/conversations/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "segments", - "{id}" + "conversations", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can fetch the details of a single segment.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "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": "List subscription types", + "name": "Reply to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/subscription_types", + "raw": "https://api.intercom.io/conversations/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "subscription_types" - ] - }, - "description": "You can list all subscription types. A list of subscription type objects will be returned.", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "List all tags", - "request": { - "method": "GET", - "url": { - "raw": "/tags", - "path": [ - "tags" - ] - }, - "description": "You can fetch a list of all tags for a given workspace.\n\n", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Find a specific tag", - "request": { - "method": "GET", - "url": { - "raw": "/tags/{id}", - "path": [ - "tags", - "{id}" + "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" + } ] }, - "description": "You can fetch the details of tags that are on the workspace by their id.\nThis will return a tag object.\n", - "header": [], - "body": {} + "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.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "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 \"admin_id\": \"3156780\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"attachment_files\": [\n {\n \"content_type\": \"application/json\",\n \"data\": \"ewogICJ0ZXN0IjogMQp9\",\n \"name\": \"test.json\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all teams", + "name": "Manage a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/teams", + "raw": "https://api.intercom.io/conversations/{id}/parts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams" + "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" + } ] }, - "description": "This will return a list of team objects for the App.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Retrieve a team", + "name": "Attach a contact to a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/teams/{id}", + "raw": "https://api.intercom.io/conversations/{id}/customers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "teams", - "{id}" + "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" + } ] }, - "description": "You can fetch the details of a single team, containing an array of admins that belong to this team.", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "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": "List all ticket states", + "name": "Redact a conversation part", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/ticket_states", + "raw": "https://api.intercom.io/conversations/redact", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_states" + "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" + } ] }, - "description": "You can get a list of all ticket states for a workspace.", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "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": "List all ticket types", + "name": "Convert a conversation to a ticket", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/ticket_types", + "raw": "https://api.intercom.io/conversations/{id}/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types" + "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" + } ] }, - "description": "You can get a list of all ticket types for a workspace.", - "header": [], - "body": {} + "method": "POST", + "description": "You can convert a conversation to a ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ticket_type_id\": \"1234\",\n \"attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a ticket type", + "name": "Update a conversation", + "tags": [ + "Conversations", + "Custom Object Instances" + ], "request": { - "method": "GET", "url": { - "raw": "/ticket_types/{id}", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", + "conversations", "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain 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" + } ] }, - "description": "You can fetch the details of a single ticket type.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "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 }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a ticket", + "name": "Delete a conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/tickets/{id}", + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", + "conversations", "{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" + } ] }, - "description": "You can fetch the details of a single ticket.", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can delete a single conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Retrieve a visitor with User ID", + "name": "Detach a contact from a group conversation", + "tags": [ + "Conversations" + ], "request": { - "method": "GET", "url": { - "raw": "/visitors", + "raw": "https://api.intercom.io/conversations/{conversation_id}/customers/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors" + "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" + } ] }, - "description": "You can fetch the details of a single visitor.", - "header": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"5017690\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Custom Object Instances", + "item": [ { - "name": "Create a content import source", + "name": "Get Custom Object Instance by External ID", + "tags": [ + "Custom Object Instances" + ], "request": { - "method": "POST", "url": { - "raw": "/ai/content_import_sources", + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "content_import_sources" + "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" + } ] }, - "description": "You can create a new content import source by sending a POST request to this endpoint.", - "header": [], - "body": {} + "method": "GET", + "description": "Fetch a Custom Object Instance by external_id.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create an external page (or update an external page by external ID)", + "name": "Get Custom Object Instance by ID", + "tags": [ + "Custom Object Instances" + ], "request": { - "method": "POST", "url": { - "raw": "/ai/external_pages", + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "external_pages" + "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" + } ] }, - "description": "You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead.", - "header": [], - "body": {} + "method": "GET", + "description": "Fetch a Custom Object Instance by id.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create an article", + "name": "Create or Update a Custom Object Instance", + "tags": [ + "Custom Object Instances" + ], "request": { - "method": "POST", "url": { - "raw": "/articles", + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles" + "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" + } ] }, - "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Create a collection", - "request": { "method": "POST", - "url": { - "raw": "/help_center/collections", - "path": [ - "help_center", - "collections" - ] - }, - "description": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", - "header": [], - "body": {} + "description": "Create or update a custom object instance", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "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": "Create or Update a company", + "name": "Delete a Custom Object Instance by External ID", + "tags": [ + "Custom Object Instances" + ], "request": { - "method": "POST", "url": { - "raw": "/companies", + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies" + "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" + } ] }, - "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": [], - "body": {} + "method": "DELETE", + "description": "Delete a single Custom Object instance by external_id.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "List all companies", + "name": "Delete a Custom Object Instance by ID", + "tags": [ + "Custom Object Instances" + ], "request": { - "method": "POST", "url": { - "raw": "/companies/list", + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "list" + "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" + } ] }, - "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": [], - "body": {} + "method": "DELETE", + "description": "Delete a single Custom Object instance using the Intercom defined id.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Data Attributes", + "item": [ { - "name": "Attach a Contact to a Company", + "name": "List all data attributes", + "tags": [ + "Data Attributes" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/companies", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "companies" + "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." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can attach a company to a single contact.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a note", + "name": "Create a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/notes", + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "notes" + "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" + } ] }, - "description": "You can add a note to a single contact.", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Add subscription to a contact", - "request": { "method": "POST", - "url": { - "raw": "/contacts/{contact_id}/subscriptions", - "path": [ - "contacts", - "{contact_id}", - "subscriptions" - ] - }, - "description": "You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", - "header": [], - "body": {} + "description": "You can create a data attributes for a `contact` or a `company`.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Data Attribute\",\n \"model\": \"contact\",\n \"data_type\": \"string\",\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Add tag to a contact", + "name": "Update a data attribute", + "tags": [ + "Data Attributes" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/data_attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags" + "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" + } ] }, - "description": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"archived\": false,\n \"description\": \"My Data Attribute Description\",\n \"options\": [\n \"option1\",\n \"option2\"\n ],\n \"messenger_writable\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Data Events", + "item": [ { - "name": "Merge a lead and a user", + "name": "List all data events", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/merge", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "merge" + "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" + } ] }, - "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Search contacts", + "name": "Submit a data event", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/search", + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "search" + "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" + } ] }, - "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", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Create contact", - "request": { "method": "POST", - "url": { - "raw": "/contacts", - "path": [ - "contacts" - ] - }, - "description": "You can create a new contact (ie. user or lead).", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "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": "Archive contact", + "name": "Create event summaries", + "tags": [ + "Data Events" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/archive", + "raw": "https://api.intercom.io/events/summaries", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "archive" + "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" + } ] }, - "description": "You can archive a single contact.", - "header": [], - "body": {} - }, - "response": [] - }, - { - "name": "Unarchive contact", - "request": { "method": "POST", - "url": { - "raw": "/contacts/{id}/unarchive", - "path": [ - "contacts", - "{id}", - "unarchive" - ] - }, - "description": "You can unarchive a single contact.", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "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": "Block contact", + "name": "Show content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/contacts/{id}/block", + "raw": "https://api.intercom.io/export/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}", - "block" + "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" + } ] }, - "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": [], - "body": {} + "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": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Add tag to a conversation", + "name": "Download content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{conversation_id}/tags", + "raw": "https://api.intercom.io/download/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags" + "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" + } ] }, - "description": "You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Creates a conversation", + "name": "Create content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations", + "raw": "https://api.intercom.io/export/content/data", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations" + "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" + } ] }, - "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": [], - "body": {} + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "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": "Search conversations", + "name": "Cancel content data export", + "tags": [ + "Data Export" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/search", + "raw": "https://api.intercom.io/export/cancel/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "search" + "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" + } ] }, - "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", - "header": [], - "body": {} + "method": "POST", + "description": "You can cancel your job", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Help Center", + "item": [ { - "name": "Reply to a conversation", + "name": "List all collections", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/reply", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "reply" + "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" + } ] }, - "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.", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Manage a conversation", + "name": "Retrieve a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/parts", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "parts" + "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" + } ] }, - "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", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Attach a contact to a conversation", + "name": "Retrieve a Help Center", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/customers", + "raw": "https://api.intercom.io/help_center/help_centers/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "customers" + "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" + } ] }, - "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": [], - "body": {} + "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": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Redact a conversation part", + "name": "List all Help Centers", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/redact", + "raw": "https://api.intercom.io/help_center/help_centers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "redact" + "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" + } ] }, - "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": [], - "body": {} + "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": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Convert a conversation to a ticket", + "name": "Create a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/conversations/{id}/convert", + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}", - "convert" + "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" + } ] }, - "description": "You can convert a conversation to a ticket.", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "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": "Create or Update a Custom Object Instance", + "name": "Update a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/custom_object_instances/{custom_object_type_identifier}", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}" + "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" + } ] }, - "description": "Create or update a custom object instance", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "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": "Create a data attribute", + "name": "Delete a collection", + "tags": [ + "Help Center" + ], "request": { - "method": "POST", "url": { - "raw": "/data_attributes", + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes" + "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" + } ] }, - "description": "You can create a data attributes for a `contact` or a `company`.", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Jobs", + "item": [ { - "name": "Submit a data event", + "name": "Retrieve job status", + "tags": [ + "Jobs" + ], "request": { - "method": "POST", "url": { - "raw": "/events", + "raw": "https://api.intercom.io/jobs/status/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events" + "jobs", + "status", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the job 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" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "Retrieve the status of job execution.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Messages", + "item": [ { - "name": "Create event summaries", + "name": "Create a message", + "tags": [ + "Messages" + ], "request": { - "method": "POST", "url": { - "raw": "/events/summaries", + "raw": "https://api.intercom.io/messages", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "events", - "summaries" + "messages" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "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 or sms.\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", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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 \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n \"created_at\": 1590000000,\n \"create_conversation_without_contact_reply\": true\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "News", + "item": [ { - "name": "Create content data export", + "name": "List all news items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/export/content/data", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "content", - "data" + "news", + "news_items" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all news items", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Cancel content data export", + "name": "Retrieve a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/export/cancel/{job_identifier}", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "export", - "cancel", - "{job_identifier}" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item 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" + } ] }, - "description": "You can cancel your job", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a message", + "name": "List all live newsfeed items", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/messages", + "raw": "https://api.intercom.io/news/newsfeeds/{id}/items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "messages" + "news", + "newsfeeds", + "{id}", + "items" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item 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" + } ] }, - "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message, an email or sms.\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": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all news items that are live on a given newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a news item", + "name": "List all newsfeeds", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/news/news_items", + "raw": "https://api.intercom.io/news/newsfeeds", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "news", - "news_items" + "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" + } ] }, - "description": "You can create a news item", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all newsfeeds", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a phone Switch", + "name": "Retrieve a newsfeed", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/phone_call_redirects", + "raw": "https://api.intercom.io/news/newsfeeds/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "phone_call_redirects" + "news", + "newsfeeds", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item 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" + } ] }, - "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create or update a tag, Tag or untag companies, Tag contacts", + "name": "Create a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/tags", + "raw": "https://api.intercom.io/news/news_items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags" + "news", + "news_items" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a news item", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Create a new attribute for a ticket type", + "name": "Update a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/ticket_types/{ticket_type_id}/attributes", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{ticket_type_id}", - "attributes" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item 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" + } ] }, - "description": "You can create a new attribute for a ticket type.", - "header": [], - "body": {} + "method": "PUT", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "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": [] + } }, "response": [] }, { - "name": "Create a ticket type", + "name": "Delete a news item", + "tags": [ + "News" + ], "request": { - "method": "POST", "url": { - "raw": "/ticket_types", + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types" + "news", + "news_items", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item 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" + } ] }, - "description": "You can create a new ticket type.\n> 📘 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: _default_title_ and _default_description_.\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can delete a single news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Notes", + "item": [ { - "name": "Reply to a ticket", + "name": "List all notes", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/{id}/reply", + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", + "contacts", "{id}", - "reply" + "notes" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of a contact." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of notes that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Add tag to a ticket", + "name": "Retrieve a note", + "tags": [ + "Notes" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/{ticket_id}/tags", + "raw": "https://api.intercom.io/notes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{ticket_id}", - "tags" + "notes", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "1", + "disabled": false, + "description": "The unique identifier of a given note" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single note.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Create a ticket", + "name": "Create a note", + "tags": [ + "Notes", + "Contacts" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets", + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets" + "contacts", + "{id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given contact." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can create a new ticket.", - "header": [], - "body": {} + "method": "POST", + "description": "You can add a note to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"body\": \"New note\",\n \"contact_id\": \"123\",\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Segments", + "item": [ { - "name": "Enqueue create ticket", + "name": "List all segments", + "tags": [ + "Segments" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/enqueue", + "raw": "https://api.intercom.io/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "enqueue" + "segments" + ], + "query": [ + { + "key": "include_count", + "value": "true", + "description": "It includes the count of contacts that belong to each segment." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all segments.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Search tickets", + "name": "Retrieve a segment", + "tags": [ + "Segments" + ], "request": { - "method": "POST", "url": { - "raw": "/tickets/search", + "raw": "https://api.intercom.io/segments/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "search" + "segments", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identified of a given segment." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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| _default_title_ | String |\n| _default_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### 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": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single segment.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Subscription Types", + "item": [ { - "name": "Convert a visitor", + "name": "List subscription types", + "tags": [ + "Subscription Types" + ], "request": { - "method": "POST", "url": { - "raw": "/visitors/convert", + "raw": "https://api.intercom.io/subscription_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors", - "convert" + "subscription_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "You can list all subscription types. A list of subscription type objects will be returned.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Set an admin to away", + "name": "Add subscription to a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/admins/{id}/away", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "admins", - "{id}", - "away" + "contacts", + "{contact_id}", + "subscriptions" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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" + } ] }, - "description": "You can set an Admin as away for the Inbox.", - "header": [], - "body": {} + "method": "POST", + "description": "You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"37846\",\n \"consent_type\": \"opt_in\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a content import source", + "name": "Remove subscription from a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/ai/content_import_sources/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "content_import_sources", + "contacts", + "{contact_id}", + "subscriptions", "{id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "value": "37846", + "disabled": false, + "description": "The unique identifier for the subscription type 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" + } ] }, - "description": "You can update an existing content import source.", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Switch", + "item": [ { - "name": "Update an external page", + "name": "Create a phone Switch", + "tags": [ + "Switch" + ], "request": { - "method": "PUT", "url": { - "raw": "/ai/external_pages/{id}", + "raw": "https://api.intercom.io/phone_call_redirects", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "external_pages", - "{id}" + "phone_call_redirects" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can update an existing external page (if it was created via the API).", - "header": [], - "body": {} + "method": "POST", + "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"phone\": \"+1 1234567890\",\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 }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Tags", + "item": [ { - "name": "Update an article", + "name": "List all tags", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", - "{id}" + "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch a list of all tags for a given workspace.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a collection", + "name": "Find a specific tag", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of tags that are on the workspace by their id.\nThis will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a company", + "name": "Add tag to a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "{id}" + "contacts", + "{contact_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact 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" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a contact", + "name": "Add tag to a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "PUT", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{id}" + "conversations", + "{conversation_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"780\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a conversation", + "name": "Create or update a tag, Tag or untag companies, Tag contacts", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}" + "tags" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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", - "header": [], - "body": {} + "method": "POST", + "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Independent\",\n \"id\": \"656452352\",\n \"companies\": [\n {\n \"id\": \"531ee472cce572a6ec000006\",\n \"company_id\": \"6\",\n \"untag\": \"true\"\n }\n ],\n \"users\": [\n {\n \"id\": \"5f7f0d217289f8d2f4262080\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a data attribute", + "name": "Add tag to a ticket", + "tags": [ + "Tags", + "Tickets" + ], "request": { - "method": "PUT", "url": { - "raw": "/data_attributes/{id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "data_attributes", - "{id}" + "tickets", + "{ticket_id}", + "tags" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "64619700005694", + "disabled": false, + "description": "ticket_id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "POST", + "description": "You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"780\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a news item", + "name": "Remove tag from a contact", + "tags": [ + "Tags", + "Contacts" + ], "request": { - "method": "PUT", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", + "contacts", + "{contact_id}", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier for the tag 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" + } ] }, - "description": "", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update an existing attribute for a ticket type", + "name": "Remove tag from a conversation", + "tags": [ + "Tags", + "Conversations" + ], "request": { - "method": "PUT", "url": { - "raw": "/ticket_types/{ticket_type_id}/attributes/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", - "{ticket_type_id}", - "attributes", + "conversations", + "{conversation_id}", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + }, + { + "key": "id", + "value": "7522907", + "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" + } ] }, - "description": "You can update an existing attribute for a ticket type.", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Update a ticket type", + "name": "Delete tag", + "tags": [ + "Tags" + ], "request": { - "method": "PUT", "url": { - "raw": "/ticket_types/{id}", + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ticket_types", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given tag" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "\nYou can update a ticket type.\n\n> 📘 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can delete the details of tags that are on the workspace by passing in the id.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Update a ticket", + "name": "Remove tag from a ticket", + "tags": [ + "Tags", + "Tickets" + ], "request": { - "method": "PUT", "url": { - "raw": "/tickets/{id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ "tickets", + "{ticket_id}", + "tags", "{id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "64619700005694", + "disabled": false, + "description": "ticket_id" + }, + { + "key": "id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier for the tag 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" + } ] }, - "description": "You can update a ticket.", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Teams", + "item": [ { - "name": "Update a visitor", + "name": "List all teams", + "tags": [ + "Teams" + ], "request": { - "method": "PUT", "url": { - "raw": "/visitors", + "raw": "https://api.intercom.io/teams", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "visitors" + "teams" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "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": [], - "body": {} + "method": "GET", + "description": "This will return a list of team objects for the App.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Delete a content import source", + "name": "Retrieve a team", + "tags": [ + "Teams" + ], "request": { - "method": "DELETE", "url": { - "raw": "/ai/content_import_sources/{id}", + "raw": "https://api.intercom.io/teams/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "content_import_sources", + "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" + } ] }, - "description": "You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single team, containing an array of admins that belong to this team.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Ticket States", + "item": [ { - "name": "Delete an external page", + "name": "List all ticket states", + "tags": [ + "Ticket States" + ], "request": { - "method": "DELETE", "url": { - "raw": "/ai/external_pages/{id}", + "raw": "https://api.intercom.io/ticket_states", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "ai", - "external_pages", - "{id}" + "ticket_states" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers.", - "header": [], - "body": {} + "method": "GET", + "description": "You can get a list of all ticket states for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Ticket Type Attributes", + "item": [ { - "name": "Delete an article", + "name": "Create a new attribute for a ticket type", + "tags": [ + "Ticket Type Attributes" + ], "request": { - "method": "DELETE", "url": { - "raw": "/articles/{id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "articles", - "{id}" + "ticket_types", + "{ticket_type_id}", + "attributes" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type 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" + } ] }, - "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new attribute for a ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug Priority\",\n \"description\": \"Priority level of the bug\",\n \"data_type\": \"string\",\n \"required_to_create\": false,\n \"required_to_create_for_contacts\": false,\n \"visible_on_create\": true,\n \"visible_to_contacts\": true,\n \"multiline\": false,\n \"list_items\": \"Low Priority,Medium Priority,High Priority\",\n \"allow_multiple_values\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a collection", + "name": "Update an existing attribute for a ticket type", + "tags": [ + "Ticket Type Attributes" + ], "request": { - "method": "DELETE", "url": { - "raw": "/help_center/collections/{id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "help_center", - "collections", + "ticket_types", + "{ticket_type_id}", + "attributes", "{id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + }, + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket type attribute 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" + } ] }, - "description": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", - "header": [], - "body": {} + "method": "PUT", + "description": "You can update an existing attribute for a ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug Priority\",\n \"description\": \"Priority level of the bug\",\n \"required_to_create\": false,\n \"required_to_create_for_contacts\": false,\n \"visible_on_create\": true,\n \"visible_to_contacts\": true,\n \"multiline\": false,\n \"list_items\": \"Low Priority,Medium Priority,High Priority\",\n \"allow_multiple_values\": false,\n \"archived\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Ticket Types", + "item": [ { - "name": "Delete a company", + "name": "List all ticket types", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/companies/{id}", + "raw": "https://api.intercom.io/ticket_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "companies", - "{id}" + "ticket_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a single company.", - "header": [], - "body": {} + "method": "GET", + "description": "You can get a list of all ticket types for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Detach a contact from a company", + "name": "Retrieve a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/companies/{id}", + "raw": "https://api.intercom.io/ticket_types/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "companies", + "ticket_types", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket type 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" + } ] }, - "description": "You can detach a company from a single contact.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Remove subscription from a contact", + "name": "Create a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/subscriptions/{id}", + "raw": "https://api.intercom.io/ticket_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "subscriptions", - "{id}" + "ticket_types" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new ticket type.\n> 📘 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: _default_title_ and _default_description_.\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug\",\n \"description\": \"Used for tracking bugs\",\n \"category\": \"Customer\",\n \"icon\": \"🐞\",\n \"is_internal\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Remove tag from a contact", + "name": "Update a ticket type", + "tags": [ + "Ticket Types" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{contact_id}/tags/{id}", + "raw": "https://api.intercom.io/ticket_types/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", - "{contact_id}", - "tags", + "ticket_types", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket type 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" + } ] }, - "description": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", - "header": [], - "body": {} + "method": "PUT", + "description": "\nYou can update a ticket type.\n\n> 📘 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Bug\",\n \"description\": \"A bug has been occured\",\n \"category\": \"Customer\",\n \"icon\": \"🐞\",\n \"archived\": false,\n \"is_internal\": false\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Tickets", + "item": [ { - "name": "Delete a contact", + "name": "Retrieve a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/contacts/{id}", + "raw": "https://api.intercom.io/tickets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "contacts", + "tickets", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket 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" + } ] }, - "description": "You can delete a single contact.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Remove tag from a conversation", + "name": "Reply to a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{conversation_id}/tags/{id}", + "raw": "https://api.intercom.io/tickets/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "tags", - "{id}" + "tickets", + "{id}", + "reply" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", - "header": [], - "body": {} + "method": "POST", + "description": "You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "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 \"admin_id\": \"3156780\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a conversation", + "name": "Create a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{id}", + "raw": "https://api.intercom.io/tickets", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{id}" + "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" + } ] }, - "description": "You can delete a single conversation.", - "header": [], - "body": {} + "method": "POST", + "description": "You can create a new ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "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": "Detach a contact from a group conversation", + "name": "Enqueue create ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/conversations/{conversation_id}/customers/{contact_id}", + "raw": "https://api.intercom.io/tickets/enqueue", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "conversations", - "{conversation_id}", - "customers", - "{contact_id}" + "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" + } ] }, - "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": [], - "body": {} + "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": "Unstable" + }, + { + "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": "Delete a Custom Object Instance by External ID", + "name": "Search tickets", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/custom_object_instances/{custom_object_type_identifier}", + "raw": "https://api.intercom.io/tickets/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}" + "tickets", + "search" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "Delete a single Custom Object instance by external_id.", - "header": [], - "body": {} + "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| _default_title_ | String |\n| _default_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### 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": "Unstable" + }, + { + "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": "Delete a Custom Object Instance by ID", + "name": "Update a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/custom_object_instances/{custom_object_type_identifier}/{id}", + "raw": "https://api.intercom.io/tickets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}", + "tickets", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket 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" + } ] }, - "description": "Delete a single Custom Object instance using the Intercom defined id.", - "header": [], - "body": {} + "method": "PUT", + "description": "You can update a ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a news item", + "name": "Delete a ticket", + "tags": [ + "Tickets" + ], "request": { - "method": "DELETE", "url": { - "raw": "/news/news_items/{id}", + "raw": "https://api.intercom.io/tickets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "news", - "news_items", + "tickets", "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the ticket 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" + } ] }, - "description": "You can delete a single news item.", - "header": [], - "body": {} + "method": "DELETE", + "description": "You can delete a ticket using the Intercom provided ID.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Visitors", + "item": [ { - "name": "Delete tag", + "name": "Retrieve a visitor with User ID", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/tags/{id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tags", - "{id}" + "visitors" + ], + "query": [ + { + "key": "user_id", + "value": "user_id", + "description": "The user_id of the Visitor you want to retrieve." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete the details of tags that are on the workspace by passing in the id.", - "header": [], - "body": {} + "method": "GET", + "description": "You can fetch the details of a single visitor.", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null }, "response": [] }, { - "name": "Remove tag from a ticket", + "name": "Convert a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/tickets/{ticket_id}/tags/{id}", + "raw": "https://api.intercom.io/visitors/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{ticket_id}", - "tags", - "{id}" + "visitors", + "convert" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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": "Delete a ticket", + "name": "Update a visitor", + "tags": [ + "Visitors" + ], "request": { - "method": "DELETE", "url": { - "raw": "/tickets/{id}", + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], "path": [ - "tickets", - "{id}" + "visitors" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } ] }, - "description": "You can delete a ticket using the Intercom provided ID.", - "header": [], - "body": {} + "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": "Unstable" + }, + { + "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": [] + } }, "response": [] } @@ -2265,28 +8511,7 @@ "event": [], "variable": [ { - "id": "b8467fa8-fcc7-4748-a124-6698d312ce10", - "key": "https://api.intercom.io", - "value": "https://api.intercom.io", - "type": "string", - "description": "The production API server" - }, - { - "id": "dcd07a7a-85a8-495e-aa39-1dc3052e6905", - "key": "https://api.eu.intercom.io", - "value": "https://api.eu.intercom.io", - "type": "string", - "description": "The european API server" - }, - { - "id": "63671ca2-e670-4b83-acb1-d744ccdb8194", - "key": "https://api.au.intercom.io", - "value": "https://api.au.intercom.io", - "type": "string", - "description": "The australian API server" - }, - { - "id": "23228843-13f3-409d-9a72-25bae41b9a9c", + "id": "0b660c74-42c3-4abf-a3f8-93b932218d3f", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/scripts/postman/collection.js b/scripts/postman/collection.js index 939c446..a301924 100644 --- a/scripts/postman/collection.js +++ b/scripts/postman/collection.js @@ -48,24 +48,16 @@ module.exports = class Collection { } getVariables() { - let variables = uniq( - Object.values(this.openapi.servers).map((host) => ({ + // Only include the bearer token variable + return [ + { id: uuid.v4(), - key: host.url, - value: host.url, + key: 'bearerToken', + value: '{{bearerToken}}', type: 'string', - description: host.description, - })), - ); - let tokenInfo = { - id: uuid.v4(), - key: 'bearerToken', - value: '{{bearerToken}}', - type: 'string', - description: 'bearertokenvalue', - }; - variables.push(tokenInfo); - return variables; + description: 'bearertokenvalue', + }, + ]; } defaultAuth() { @@ -119,19 +111,11 @@ module.exports = class Collection { Object.entries(this.openapi.paths).forEach(([path, methods]) => { Object.entries(methods).forEach(([method, endpoint]) => { if (method !== 'parameters') { - // Skip global parameters + const request = this.request(method, path, endpoint); this.insertEndpoint({ name: endpoint.summary || path, - request: { - method: method.toUpperCase(), - url: { - raw: path, - path: path.split('/').filter((p) => p), - }, - description: endpoint.description || '', - header: [], // Initialize headers array - body: {}, // Initialize body object - }, + tags: endpoint.tags || [], // Include the tags from the OpenAPI spec + request: request, response: [], // Initialize responses array }); } @@ -175,11 +159,17 @@ module.exports = class Collection { } url(path, endpoint) { - const server = new URL('https://api.intercom.io'); + // Always use the production URL + const baseUrl = 'https://api.intercom.io'; + + // Ensure path starts with a slash if it doesn't already + const formattedPath = path.startsWith('/') ? path : `/${path}`; + return { + raw: `${baseUrl}${formattedPath}`, protocol: 'https', - host: server.host || server.hostname, - path: this.path(server, path), + host: ['api.intercom.io'], + path: formattedPath.split('/').filter((p) => p), query: this.query(endpoint), variable: this.variable(endpoint), }; diff --git a/scripts/postman/example.js b/scripts/postman/example.js index 2439286..4625d30 100644 --- a/scripts/postman/example.js +++ b/scripts/postman/example.js @@ -29,7 +29,7 @@ module.exports = class Example { } else if (prop.type === 'string' && prop.enum) { return prop.enum[0]; } else { - console.warn('Could not parse an example for:', prop); + return prop.name || ''; } } }; From 60dabf7117d46a35708d821f63c072dc1ee59b36 Mon Sep 17 00:00:00 2001 From: Steve Henry Date: Fri, 25 Apr 2025 11:53:46 +0100 Subject: [PATCH 2/3] Remove comment --- scripts/postman/collection.js | 1 - 1 file changed, 1 deletion(-) diff --git a/scripts/postman/collection.js b/scripts/postman/collection.js index a301924..870363d 100644 --- a/scripts/postman/collection.js +++ b/scripts/postman/collection.js @@ -159,7 +159,6 @@ module.exports = class Collection { } url(path, endpoint) { - // Always use the production URL const baseUrl = 'https://api.intercom.io'; // Ensure path starts with a slash if it doesn't already From 0d61f34d30ccf5d9182e3d80fd61b4d9342b93da Mon Sep 17 00:00:00 2001 From: Steve Henry Date: Fri, 25 Apr 2025 11:55:47 +0100 Subject: [PATCH 3/3] Added readme with script instructions --- postman/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 postman/README.md diff --git a/postman/README.md b/postman/README.md new file mode 100644 index 0000000..05a4c2d --- /dev/null +++ b/postman/README.md @@ -0,0 +1,8 @@ +# Intercom API Postman Collections + +This directory contains the Postman collection for Intercom API for various versions + +## How to generate + +To generate the latest Postman collections based on the OpenAPI spec files, run this command in the base directory of this project: +node scripts/postman/generate-postman-in-repo.js