diff --git a/postman/2.10/README.md b/postman/2.10/README.md index 076aa68..abda089 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-25T10:49:24.555Z +Last updated: 2025-08-27T09:13:41.870Z diff --git a/postman/2.10/intercom-api.postman_collection.json b/postman/2.10/intercom-api.postman_collection.json index 6f51ea8..4403283 100644 --- a/postman/2.10/intercom-api.postman_collection.json +++ b/postman/2.10/intercom-api.postman_collection.json @@ -8,7 +8,7 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-04-25T10:49:24.551Z" + "updatedAt": "2025-08-27T09:13:41.867Z" }, "item": [ { @@ -7161,7 +7161,7 @@ "event": [], "variable": [ { - "id": "ddfcd9d0-c5e3-4eae-844a-badf27d5a84f", + "id": "38750aec-1917-4f4c-945c-2d4a64fa1c50", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/postman/2.11/README.md b/postman/2.11/README.md index 25e66c8..5f8a3dd 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-25T10:49:24.812Z +Last updated: 2025-08-27T09:13:42.038Z diff --git a/postman/2.11/intercom-api.postman_collection.json b/postman/2.11/intercom-api.postman_collection.json index 1baa5ee..96ee838 100644 --- a/postman/2.11/intercom-api.postman_collection.json +++ b/postman/2.11/intercom-api.postman_collection.json @@ -8,7 +8,7 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-04-25T10:49:24.810Z" + "updatedAt": "2025-08-27T09:13:42.036Z" }, "item": [ { @@ -7248,7 +7248,7 @@ "event": [], "variable": [ { - "id": "367fdd6b-d8af-49af-82be-725e50679c86", + "id": "109a9146-30eb-4db4-9c86-f5a964012fda", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/postman/2.12/README.md b/postman/2.12/README.md index 5f6584a..6f09d47 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-25T10:49:25.046Z +Last updated: 2025-08-27T09:13:42.191Z diff --git a/postman/2.12/intercom-api.postman_collection.json b/postman/2.12/intercom-api.postman_collection.json index 1e58199..41498dc 100644 --- a/postman/2.12/intercom-api.postman_collection.json +++ b/postman/2.12/intercom-api.postman_collection.json @@ -8,7 +8,7 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-04-25T10:49:25.043Z" + "updatedAt": "2025-08-27T09:13:42.189Z" }, "item": [ { @@ -7753,7 +7753,7 @@ "event": [], "variable": [ { - "id": "6fbd31d5-fc63-4ba8-84fa-5151b5ca7fbe", + "id": "8ba2d811-73b8-4785-a0a9-e256111d5e3f", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/postman/2.13/README.md b/postman/2.13/README.md index 78d93e6..e8055c8 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-25T10:49:25.273Z +Last updated: 2025-08-27T09:13:42.346Z diff --git a/postman/2.13/intercom-api.postman_collection.json b/postman/2.13/intercom-api.postman_collection.json index 7b151bd..56cb515 100644 --- a/postman/2.13/intercom-api.postman_collection.json +++ b/postman/2.13/intercom-api.postman_collection.json @@ -8,7 +8,7 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-04-25T10:49:25.271Z" + "updatedAt": "2025-08-27T09:13:42.343Z" }, "item": [ { @@ -5266,6 +5266,384 @@ } ] }, + { + "name": "Internal Articles", + "item": [ + { + "name": "List all articles", + "tags": [ + "Internal Articles" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/internal_articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "internal_articles" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all internal articles by making a GET request to `https://api.intercom.io/internal_articles`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve an internal article", + "tags": [ + "Internal Articles" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/internal_articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "internal_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 internal article by making a GET request to `https://api.intercom.io/internal_articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Search for internal articles", + "tags": [ + "Internal Articles" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/internal_articles/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "internal_articles", + "search" + ], + "query": [ + { + "key": "folder_id", + "value": "123", + "description": "The ID of the folder to search in." + } + ], + "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 internal articles by making a GET request to `https://api.intercom.io/internal_articles/search`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create an internal article", + "tags": [ + "Internal Articles" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/internal_articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "internal_articles" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can create a new internal article by making a POST request to `https://api.intercom.io/internal_articles`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"title\": \"Thanks for everything\",\n \"body\": \"

This is the body in html

\",\n \"author_id\": 1295,\n \"owner_id\": 1295\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Update an internal article", + "tags": [ + "Internal Articles" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/internal_articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "internal_articles", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the internal 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": "PUT", + "description": "You can update the details of a single internal article by making a PUT request to `https://api.intercom.io/internal_articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"title\": \"Thanks for everything\",\n \"body\": \"\",\n \"author_id\": 1295,\n \"owner_id\": 1295\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete an internal article", + "tags": [ + "Internal Articles" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/internal_articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "internal_articles", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the internal 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": "DELETE", + "description": "You can delete a single internal article by making a DELETE request to `https://api.intercom.io/internal_articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.13" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, { "name": "Messages", "item": [ @@ -8320,7 +8698,7 @@ "event": [], "variable": [ { - "id": "c7432dd1-7f9a-4e2b-b645-9d07d6aae903", + "id": "238e0ce0-eb64-42bf-9abe-dd99a9b88e5b", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/postman/2.14/README.md b/postman/2.14/README.md new file mode 100644 index 0000000..f7ab163 --- /dev/null +++ b/postman/2.14/README.md @@ -0,0 +1,15 @@ +# Intercom API 2.14 Postman Collection + +This directory contains the Postman collection for Intercom API version 2.14. + +## Files +- `intercom-api.postman_collection.json`: The main Postman collection +- `environment.json`: Environment variables for this version + +## Usage +1. Import the collection into Postman +2. Import the environment file +3. Set your access token in the environment variables +4. Start making API calls! + +Last updated: 2025-08-27T09:13:42.538Z diff --git a/postman/2.14/environment.json b/postman/2.14/environment.json new file mode 100644 index 0000000..252ec96 --- /dev/null +++ b/postman/2.14/environment.json @@ -0,0 +1,18 @@ +{ + "id": "intercom-api-2.14-environment", + "name": "Intercom API 2.14 Environment", + "values": [ + { + "key": "baseUrl", + "value": "https://api.intercom.io", + "type": "default", + "enabled": true + }, + { + "key": "token", + "value": "YOUR_ACCESS_TOKEN", + "type": "secret", + "enabled": true + } + ] +} \ No newline at end of file diff --git a/postman/2.14/intercom-api.postman_collection.json b/postman/2.14/intercom-api.postman_collection.json new file mode 100644 index 0000000..3205030 --- /dev/null +++ b/postman/2.14/intercom-api.postman_collection.json @@ -0,0 +1,9749 @@ +{ + "info": { + "name": "Intercom API - 2.14", + "description": "The intercom API reference.", + "version": "2.14", + "contact": { + "name": "Intercom Developer Hub", + "url": "https://developers.intercom.com" + }, + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "updatedAt": "2025-08-27T09:13:42.535Z" + }, + "item": [ + { + "name": "AI Content", + "item": [ + { + "name": "List content import sources", + "tags": [ + "AI Content" + ], + "request": { + "url": { + "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" + } + ] + }, + "method": "GET", + "description": "You can retrieve a list of all content import sources for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a content import source", + "tags": [ + "AI Content" + ], + "request": { + "url": { + "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" + } + ] + }, + "method": "GET", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List external pages", + "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": "GET", + "description": "You can retrieve a list of all external pages for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve 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": "GET", + "description": "You can retrieve an external page.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create a content import source", + "tags": [ + "AI Content" + ], + "request": { + "url": { + "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" + } + ] + }, + "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.14" + }, + { + "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": "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": "2.14" + }, + { + "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": { + "url": { + "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" + } + ] + }, + "method": "PUT", + "description": "You can update an existing content import source.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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": "Update 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": "PUT", + "description": "You can update an existing external page (if it was created via the API).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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": "Delete a content import source", + "tags": [ + "AI Content" + ], + "request": { + "url": { + "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" + } + ] + }, + "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.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "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": "2.14" + }, + { + "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": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List all activity logs", + "tags": [ + "Admins" + ], + "request": { + "url": { + "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": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "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": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve an admin", + "tags": [ + "Admins" + ], + "request": { + "url": { + "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": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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.14" + }, + { + "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": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve an article", + "tags": [ + "Articles" + ], + "request": { + "url": { + "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": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Search for articles", + "tags": [ + "Articles" + ], + "request": { + "url": { + "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": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create an article", + "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": "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.14" + }, + { + "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": "Update an article", + "tags": [ + "Articles" + ], + "request": { + "url": { + "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": "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.14" + }, + { + "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": "Delete an article", + "tags": [ + "Articles" + ], + "request": { + "url": { + "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": "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.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Away Status Reasons", + "item": [ + { + "name": "List all away status reasons", + "tags": [ + "Away Status Reasons" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/away_status_reasons", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "Returns a list of all away status reasons configured for the workspace, including deleted ones.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Companies", + "item": [ + { + "name": "Retrieve companies", + "tags": [ + "Companies" + ], + "request": { + "url": { + "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": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a company by ID", + "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": "GET", + "description": "You can fetch a single company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "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.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List attached segments for companies", + "tags": [ + "Companies" + ], + "request": { + "url": { + "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": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "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.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "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.14" + }, + { + "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.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Attach a Contact to a Company", + "tags": [ + "Companies", + "Contacts" + ], + "request": { + "url": { + "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" + } + ] + }, + "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.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"58a430d35458202d41b1e65b\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "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.14" + }, + { + "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.14" + }, + { + "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.14" + }, + { + "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/{id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of companies that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List attached segments for contact", + "tags": [ + "Contacts", + "Segments" + ], + "request": { + "url": { + "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": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List subscriptions for a contact", + "tags": [ + "Contacts", + "Subscription Types" + ], + "request": { + "url": { + "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": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List tags attached to a contact", + "tags": [ + "Contacts", + "Tags" + ], + "request": { + "url": { + "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": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Get a contact", + "tags": [ + "Contacts" + ], + "request": { + "url": { + "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": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List all contacts", + "tags": [ + "Contacts" + ], + "request": { + "url": { + "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": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Get a contact by External ID", + "tags": [ + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/find_by_external_id/{external_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Merge a lead and a user", + "tags": [ + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/merge", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "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": "Search contacts", + "tags": [ + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "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": "Create contact", + "tags": [ + "Contacts" + ], + "request": { + "url": { + "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": "POST", + "description": "You can create a new contact (ie. user or lead).", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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": "Archive contact", + "tags": [ + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{id}/archive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "POST", + "description": "You can archive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Unarchive contact", + "tags": [ + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{id}/unarchive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "POST", + "description": "You can unarchive a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Block contact", + "tags": [ + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{id}/block", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Update a contact", + "tags": [ + "Contacts", + "Custom Object Instances" + ], + "request": { + "url": { + "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": "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.14" + }, + { + "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": "Delete a contact", + "tags": [ + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "You can delete a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Conversations", + "item": [ + { + "name": "List all conversations", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations" + ], + "query": [ + { + "key": "per_page", + "value": "per_page", + "description": "How many results per page" + }, + { + "key": "starting_after", + "value": "starting_after", + "description": "String used to get the next page of conversations." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all conversations.\n\nYou can optionally request the result page size and the cursor to start after to fetch the result.\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + }, + { + "key": "include_translations", + "value": "true", + "description": "If set to true, conversation parts will be translated to the detected language of the conversation." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "\nYou can fetch the details of a single conversation.\n\nThis will return a single Conversation model with all its conversation parts.\n\n{% admonition type=\"warning\" name=\"Hard limit of 500 parts\" %}\nThe maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts.\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.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Creates a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can create a conversation that has been initiated by a contact (ie. user or lead).\nThe conversation can be an in-app message only.\n\n{% admonition type=\"info\" name=\"Sending for visitors\" %}\nYou can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`.\nThis visitor will be automatically converted to a contact with a lead role once the conversation is created.\n{% /admonition %}\n\nThis will return the Message model that has been created.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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": "Search conversations", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": {\n \"field\": \"created_at\",\n \"operator\": \"AND\",\n \"value\": \"73732934\"\n },\n \"pagination\": {\n \"per_page\": 2,\n \"starting_after\": \"your-cursor-from-response\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Reply to a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "reply" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123 or \"last\"", + "disabled": false, + "description": "The Intercom provisioned identifier for the conversation or the string \"last\" to reply to the last part of the conversation" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"message_type\": \"comment\",\n \"type\": \"admin\",\n \"body\": \"Hello there!\",\n \"created_at\": 1590000000,\n \"attachment_urls\": \"\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"admin_id\": \"3156780\",\n \"attachment_files\": [\n {\n \"content_type\": \"application/json\",\n \"data\": \"ewogICJ0ZXN0IjogMQp9\",\n \"name\": \"test.json\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Manage a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/parts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "parts" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "For managing conversations you can:\n- Close a conversation\n- Snooze a conversation to reopen on a future date\n- Open a conversation which is `snoozed` or `closed`\n- Assign a conversation to an admin and/or team.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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": "Attach a contact to a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/customers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "customers" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.\n\n{% admonition type=\"warning\" name=\"Contacts without an email\" %}\nIf you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`.\n{% /admonition %}\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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": "Redact a conversation part", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/redact", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "redact" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can redact a conversation part or the source message of a conversation (as seen in the source object).\n\n{% admonition type=\"info\" name=\"Redacting parts and messages\" %}\nIf you are redacting a conversation part, it must have a `body`. If you are redacting a source message, it must have been created by a contact. We will return a `conversation_part_not_redactable` error if these criteria are not met.\n{% /admonition %}\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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": "Convert a conversation to a ticket", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "convert" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can convert a conversation to a ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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": "Update a conversation", + "tags": [ + "Conversations", + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "\nYou can update an existing conversation.\n\n{% admonition type=\"info\" name=\"Replying and other actions\" %}\nIf you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints.\n{% /admonition %}\n\n{% admonition type=\"info\" %}\n This endpoint handles both **conversation updates** and **custom object associations**.\n\n See _`update a conversation with an association to a custom object instance`_ in the request/response examples to see the custom object association format.\n{% /admonition %}\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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 \"company_id\": \"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "You can delete a single conversation.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Detach a contact from a group conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{conversation_id}/customers/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{conversation_id}", + "customers", + "{contact_id}" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + }, + { + "key": "contact_id", + "value": "123", + "disabled": false, + "description": "The identifier for the contact as given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "You can 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.14" + }, + { + "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 Channel Events", + "item": [ + { + "name": "Notify Intercom of a new conversation created in a custom channel", + "tags": [ + "Custom Channel Events" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_channel_events/notify_new_conversation", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_channel_events", + "notify_new_conversation" + ], + "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": "Notifies Intercom that a new conversation was created in your custom channel/platform. This triggers conversation creation and workflow automations within Intercom for your custom channel integration.\n> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.\n", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"event_id\": \"\",\n \"external_conversation_id\": \"\",\n \"contact\": {\n \"type\": \"user\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Notify Intercom of a new message in a custom channel conversation", + "tags": [ + "Custom Channel Events" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_channel_events/notify_new_message", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_channel_events", + "notify_new_message" + ], + "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": "Notifies Intercom that a new message was sent in a conversation on your custom channel/platform. This allows Intercom to process the message and trigger any relevant workflow automations.\n> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.\n", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"event_id\": \"\",\n \"external_conversation_id\": \"\",\n \"contact\": {\n \"type\": \"user\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"body\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Notify Intercom of a quick reply response in a custom channel conversation", + "tags": [ + "Custom Channel Events" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_channel_events/notify_quick_reply_selected", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_channel_events", + "notify_quick_reply_selected" + ], + "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": "Notifies Intercom that a user selected a quick reply option in your custom channel/platform. This allows Intercom to process the response and trigger any relevant workflow automations.\n> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.\n", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"event_id\": \"\",\n \"external_conversation_id\": \"\",\n \"contact\": {\n \"type\": \"user\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"quick_reply_option_id\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Notify Intercom of an attribute collector response in a custom channel conversation", + "tags": [ + "Custom Channel Events" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_channel_events/notify_attribute_collected", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_channel_events", + "notify_attribute_collected" + ], + "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": "Notifies Intercom that a user provided a response to an attribute collector in your custom channel/platform. This allows Intercom to process the attribute and trigger any relevant workflow automations.\n> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.\n", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"event_id\": \"\",\n \"external_conversation_id\": \"\",\n \"contact\": {\n \"type\": \"user\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attribute\": {\n \"id\": \"\",\n \"value\": \"\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Custom Object Instances", + "item": [ + { + "name": "Get Custom Object Instance by External ID", + "tags": [ + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}" + ], + "query": [ + { + "key": "external_id", + "value": "external_id" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Fetch a Custom Object Instance by external_id.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Get Custom Object Instance by ID", + "tags": [ + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The id or external_id of the custom object instance" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Fetch a Custom Object Instance by id.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create or Update a Custom Object Instance", + "tags": [ + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Create or update a custom object instance", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"external_id\": \"\",\n \"external_created_at\": 1571672154,\n \"external_updated_at\": 1571672154,\n \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete a Custom Object Instance by External ID", + "tags": [ + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}" + ], + "query": [ + { + "key": "external_id", + "value": "external_id" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "Delete a single Custom Object instance by external_id.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Delete a Custom Object Instance by ID", + "tags": [ + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The Intercom defined id of the custom object instance" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "Delete a single Custom Object instance using the Intercom defined id.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Data Attributes", + "item": [ + { + "name": "List all data attributes", + "tags": [ + "Data Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_attributes" + ], + "query": [ + { + "key": "model", + "value": "company", + "description": "Specify the data attribute model to return." + }, + { + "key": "include_archived", + "value": "include_archived", + "description": "Include archived attributes in the list. By default we return only non archived data attributes." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create a data attribute", + "tags": [ + "Data Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_attributes" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can create a data attributes for a `contact` or a `company`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data_type\": \"\",\n \"options\": [\n {\n \"value\": \"1-10\"\n },\n {\n \"value\": \"11-50\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Update a data attribute", + "tags": [ + "Data Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/data_attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_attributes", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "1", + "disabled": false, + "description": "The data attribute id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "\nYou can update a data attribute.\n\n> 🚧 Updating the data type is not possible\n>\n> It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"options\": [\n {\n \"value\": \"1-10\"\n },\n {\n \"value\": \"11-50\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Data Events", + "item": [ + { + "name": "List all data events", + "tags": [ + "Data Events" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "events" + ], + "query": [ + { + "key": "filter", + "value": "filter" + }, + { + "key": "type", + "value": "type", + "description": "The value must be user" + }, + { + "key": "summary", + "value": "summary", + "description": "summary flag" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "\n> 🚧\n>\n> Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days\n\nThe events belonging to a customer can be listed by sending a GET request to `https://api.intercom.io/events` with a user or lead identifier along with a `type` parameter. The identifier parameter can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter value must be `user`.\n\n- `https://api.intercom.io/events?type=user&user_id={user_id}`\n- `https://api.intercom.io/events?type=user&email={email}`\n- `https://api.intercom.io/events?type=user&intercom_user_id={id}` (this call can be used to list leads)\n\nThe `email` parameter value should be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending.\n\nYou can optionally define the result page size as well with the `per_page` parameter.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Submit a data event", + "tags": [ + "Data Events" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/events", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "events" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "\nYou will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`.\n\nWhen using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.\n\nWith the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`).\n\n**NB: For the JSON object types, please note that we do not currently support nested JSON structure.**\n\n| Type | Description | Example |\n| :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- |\n| String | The value is a JSON String | `\"source\":\"desktop\"` |\n| Number | The value is a JSON Number | `\"load\": 3.67` |\n| Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `\"contact_date\": 1392036272` |\n| Link | The value is a HTTP or HTTPS URI. | `\"article\": \"https://example.org/ab1de.html\"` |\n| Rich Link | The value is a JSON object that contains `url` and `value` keys. | `\"article\": {\"url\": \"https://example.org/ab1de.html\", \"value\":\"the dude abides\"}` |\n| Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `\"price\": {\"amount\": 34999, \"currency\": \"eur\"}` |\n\n**Lead Events**\n\nWhen submitting events for Leads, you will need to specify the Lead's `id`.\n\n**Metadata behaviour**\n\n- We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.\n- It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.\n- There might be up to 24 hrs delay when you send a new metadata for an existing event.\n\n**Event de-duplication**\n\nThe API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field.\n\nDuplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.\n\n### HTTP API Responses\n\n- Successful responses to submitted events return `202 Accepted` with an empty body.\n- Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code.\n- Events sent about users that cannot be found will return a `404 Not Found`.\n- Event lists containing duplicate events will have those duplicates ignored.\n- Server errors will return a `500` response code and may contain an error message in the body.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"event_name\": \"invited-friend\",\n \"created_at\": 1671028894,\n \"user_id\": \"314159\",\n \"id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"email\": \"frodo.baggins@example.com\",\n \"metadata\": {\n \"invite_code\": \"ADDAFRIEND\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Create event summaries", + "tags": [ + "Data Events" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/events/summaries", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "events", + "summaries" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"user_id\": \"314159\",\n \"event_summaries\": {\n \"event_name\": \"invited-friend\",\n \"count\": 1,\n \"first\": 1671028894,\n \"last\": 1671028894\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Data Export", + "item": [ + { + "name": "Show content data export", + "tags": [ + "Data Export" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/export/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "export", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can view the status of your job by sending a `GET` request to the URL\n`https://api.intercom.io/export/content/data/{job_identifier}` - the `{job_identifier}` is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model.\n\n> 🚧 Jobs expire after two days\n> All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Download content data export", + "tags": [ + "Data Export" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/download/content/data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "download", + "content", + "data", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234.\n\nYour exported message data will be streamed continuously back down to you in a gzipped CSV format.\n\n> 📘 Octet header required\n>\n> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create content data export", + "tags": [ + "Data Export" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/export/content/data", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "export", + "content", + "data" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "To create your export job, you need to send a `POST` request to the export endpoint `https://api.intercom.io/export/content/data`.\n\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.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"created_at_after\": 1527811200,\n \"created_at_before\": 1527811200\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Cancel content data export", + "tags": [ + "Data Export" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/export/cancel/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "export", + "cancel", + "{job_identifier}" + ], + "query": [], + "variable": [ + { + "key": "job_identifier", + "value": "job_identifier", + "disabled": false, + "description": "job_identifier" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can cancel your job", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Help Center", + "item": [ + { + "name": "List all collections", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "collections" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`.\n\nCollections will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a collection", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a Help Center", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/help_centers/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "help_centers", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List all Help Centers", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/help_centers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "help_centers" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create a collection", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/collections", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "collections" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"collection 51\",\n \"description\": \"English description\",\n \"translated_content\": {\n \"type\": \"group_translated_content\",\n \"ar\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"bg\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"bs\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ca\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"cs\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"da\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"de\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"el\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"en\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"es\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"et\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"fi\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"fr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"he\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"hr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"hu\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"id\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"it\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ja\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ko\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"lt\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"lv\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"mn\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"nb\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"nl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pt\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ro\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ru\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sv\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"tr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"vi\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pt-BR\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"zh-CN\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"zh-TW\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n }\n },\n \"parent_id\": \"6871118\",\n \"help_center_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Update a collection", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"collection 51\",\n \"description\": \"English description\",\n \"translated_content\": {\n \"type\": \"group_translated_content\",\n \"ar\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"bg\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"bs\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ca\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"cs\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"da\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"de\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"el\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"en\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"es\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"et\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"fi\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"fr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"he\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"hr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"hu\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"id\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"it\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ja\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ko\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"lt\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"lv\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"mn\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"nb\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"nl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pt\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ro\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"ru\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sl\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"sv\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"tr\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"vi\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"pt-BR\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"zh-CN\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n },\n \"zh-TW\": {\n \"type\": \"group_content\",\n \"name\": \"Collection name\",\n \"description\": \" Collection description\"\n }\n },\n \"parent_id\": \"6871118\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete a collection", + "tags": [ + "Help Center" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/help_center/collections/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "collections", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "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.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Internal Articles", + "item": [ + { + "name": "List all articles", + "tags": [ + "Internal Articles" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/internal_articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "internal_articles" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all internal articles by making a GET request to `https://api.intercom.io/internal_articles`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve an internal article", + "tags": [ + "Internal Articles" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/internal_articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "internal_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 internal article by making a GET request to `https://api.intercom.io/internal_articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Search for internal articles", + "tags": [ + "Internal Articles" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/internal_articles/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "internal_articles", + "search" + ], + "query": [ + { + "key": "folder_id", + "value": "123", + "description": "The ID of the folder to search in." + } + ], + "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 internal articles by making a GET request to `https://api.intercom.io/internal_articles/search`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create an internal article", + "tags": [ + "Internal Articles" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/internal_articles", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "internal_articles" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can create a new internal article by making a POST request to `https://api.intercom.io/internal_articles`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"title\": \"Thanks for everything\",\n \"body\": \"

This is the body in html

\",\n \"author_id\": 1295,\n \"owner_id\": 1295\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Update an internal article", + "tags": [ + "Internal Articles" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/internal_articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "internal_articles", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the internal 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": "PUT", + "description": "You can update the details of a single internal article by making a PUT request to `https://api.intercom.io/internal_articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"title\": \"Thanks for everything\",\n \"body\": \"\",\n \"author_id\": 1295,\n \"owner_id\": 1295\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete an internal article", + "tags": [ + "Internal Articles" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/internal_articles/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "internal_articles", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the internal 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": "DELETE", + "description": "You can delete a single internal article by making a DELETE request to `https://api.intercom.io/internal_articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Jobs", + "item": [ + { + "name": "Retrieve job status", + "tags": [ + "Jobs" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/jobs/status/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "Retrieve the status of job execution.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Messages", + "item": [ + { + "name": "Create a message", + "tags": [ + "Messages" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/messages", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "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 {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n {\n \"type\": \"lead\",\n \"id\": \"536e564f316c83104c000021\"\n }\n ],\n \"cc\": [\n {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000023\"\n }\n ],\n \"bcc\": [\n {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000022\"\n }\n ],\n \"created_at\": 1590000000,\n \"create_conversation_without_contact_reply\": true\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "News", + "item": [ + { + "name": "List all news items", + "tags": [ + "News" + ], + "request": { + "url": { + "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": "GET", + "description": "You can fetch a list of all news items", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a news item", + "tags": [ + "News" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "You can fetch the details of a single news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List all live newsfeed items", + "tags": [ + "News" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/news/newsfeeds/{id}/items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List all newsfeeds", + "tags": [ + "News" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/news/newsfeeds", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "news", + "newsfeeds" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all newsfeeds", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a newsfeed", + "tags": [ + "News" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/news/newsfeeds/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "You can fetch the details of a single newsfeed", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create a news item", + "tags": [ + "News" + ], + "request": { + "url": { + "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": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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": "Update a news item", + "tags": [ + "News" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "PUT", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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": "Delete a news item", + "tags": [ + "News" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/news/news_items/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "DELETE", + "description": "You can delete a single news item.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Notes", + "item": [ + { + "name": "List all notes", + "tags": [ + "Notes", + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{id}", + "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" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of notes that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a note", + "tags": [ + "Notes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/notes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "You can fetch the details of a single note.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create a note", + "tags": [ + "Notes", + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "POST", + "description": "You can add a note to a single contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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": "List all segments", + "tags": [ + "Segments" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all segments.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a segment", + "tags": [ + "Segments" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/segments/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "You can fetch the details of a single segment.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Subscription Types", + "item": [ + { + "name": "List subscription types", + "tags": [ + "Subscription Types" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/subscription_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "You can list all subscription types. A list of subscription type objects will be returned.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Add subscription to a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], + "request": { + "url": { + "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": "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.14" + }, + { + "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": "Remove subscription from a contact", + "tags": [ + "Subscription Types", + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Switch", + "item": [ + { + "name": "Create a phone Switch", + "tags": [ + "Switch" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/phone_call_redirects", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "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": "List all tags", + "tags": [ + "Tags" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all tags for a given workspace.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Find a specific tag", + "tags": [ + "Tags" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Add tag to a contact", + "tags": [ + "Tags", + "Contacts" + ], + "request": { + "url": { + "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": "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.14" + }, + { + "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 conversation", + "tags": [ + "Tags", + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "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 or update a tag, Tag or untag companies, Tag contacts", + "tags": [ + "Tags" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "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": "Add tag to a ticket", + "tags": [ + "Tags", + "Tickets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tickets/{ticket_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "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": "Remove tag from a contact", + "tags": [ + "Tags", + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{contact_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Remove tag from a conversation", + "tags": [ + "Tags", + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete tag", + "tags": [ + "Tags" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Remove tag from a ticket", + "tags": [ + "Tags", + "Tickets" + ], + "request": { + "url": { + "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" + } + ] + }, + "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.14" + }, + { + "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": "List all teams", + "tags": [ + "Teams" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/teams", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "This will return a list of team objects for the App.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a team", + "tags": [ + "Teams" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/teams/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "teams", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given team." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "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.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Ticket States", + "item": [ + { + "name": "List all ticket states", + "tags": [ + "Ticket States" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/ticket_states", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "You can get a list of all ticket states for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Ticket Type Attributes", + "item": [ + { + "name": "Create a new attribute for a ticket type", + "tags": [ + "Ticket Type Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "POST", + "description": "You can create a new attribute for a ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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": { + "url": { + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "PUT", + "description": "You can update an existing attribute for a ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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": "List all ticket types", + "tags": [ + "Ticket Types" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/ticket_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "You can get a list of all ticket types for a workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a ticket type", + "tags": [ + "Ticket Types" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/ticket_types/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "You can fetch the details of a single ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create a ticket type", + "tags": [ + "Ticket Types" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/ticket_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "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": "Update a ticket type", + "tags": [ + "Ticket Types" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/ticket_types/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "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": "Retrieve a ticket", + "tags": [ + "Tickets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tickets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "You can fetch the details of a single ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Reply to a ticket", + "tags": [ + "Tickets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tickets/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"message_type\": \"comment\",\n \"type\": \"admin\",\n \"body\": \"Hello there!\",\n \"created_at\": 1590000000,\n \"attachment_urls\": \"\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"admin_id\": \"3156780\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Create a ticket", + "tags": [ + "Tickets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tickets", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "tickets" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can create a new ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ticket_type_id\": \"1234\",\n \"contacts\": [\n {\n \"id\": \"1234\"\n }\n ],\n \"conversation_to_link_id\": \"1234\",\n \"company_id\": \"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632\",\n \"created_at\": 1590000000,\n \"ticket_attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n },\n \"assignment\": {\n \"admin_assignee_id\": \"123\",\n \"team_assignee_id\": \"8\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Enqueue create ticket", + "tags": [ + "Tickets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tickets/enqueue", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "tickets", + "enqueue" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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": "Search tickets", + "tags": [ + "Tickets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tickets/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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{% admonition type=\"info\" name=\"Searching by Category\" %}\nWhen searching for tickets by the **`category`** field, specific terms must be used instead of the category names:\n* For **Customer** category tickets, use the term `request`.\n* For **Back-office** category tickets, use the term `task`.\n* For **Tracker** category tickets, use the term `tracker`.\n{% /admonition %}\n\n### Accepted Operators\n\n{% admonition type=\"info\" name=\"Searching based on `created_at`\" %}\n You may use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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": "Update a ticket", + "tags": [ + "Tickets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tickets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "PUT", + "description": "You can update a ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "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 ticket", + "tags": [ + "Tickets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tickets/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "DELETE", + "description": "You can delete a ticket using the Intercom provided ID.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Visitors", + "item": [ + { + "name": "Retrieve a visitor with User ID", + "tags": [ + "Visitors" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "visitors" + ], + "query": [ + { + "key": "user_id", + "value": "user_id", + "description": "The user_id of the Visitor you want to retrieve." + } + ], + "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 the details of a single visitor.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Convert a visitor", + "tags": [ + "Visitors" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/visitors/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "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": "Update a visitor", + "tags": [ + "Visitors" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/visitors", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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.14" + }, + { + "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": [] + } + ] + }, + { + "name": "Export", + "item": [ + { + "name": "Get export job status", + "tags": [ + "Export" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/export/reporting_data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "export", + "reporting_data", + "{job_identifier}" + ], + "query": [ + { + "key": "app_id", + "value": "app_id", + "description": "The Intercom defined code of the workspace the company is associated to." + }, + { + "key": "client_id", + "value": "client_id" + }, + { + "key": "job_identifier", + "value": "job_identifier", + "description": "Unique identifier of the job." + } + ], + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List available datasets and attributes", + "tags": [ + "Export" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/export/reporting_data/get_datasets", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "export", + "reporting_data", + "get_datasets" + ], + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Download completed export job data", + "tags": [ + "Export" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/download/reporting_data/{job_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "download", + "reporting_data", + "{job_identifier}" + ], + "query": [ + { + "key": "app_id", + "value": "app_id" + }, + { + "key": "job_identifier", + "value": "job_identifier" + } + ], + "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", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Enqueue a new reporting data export job", + "tags": [ + "Export" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/export/reporting_data/enqueue", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "export", + "reporting_data", + "enqueue" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"dataset_id\": \"conversation\",\n \"attribute_ids\": [\n \"conversation_id\",\n \"conversation_started_at\"\n ],\n \"start_time\": 1717490000,\n \"end_time\": 1717510000\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Calls", + "item": [ + { + "name": "List all calls", + "tags": [ + "Calls" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/calls", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "calls" + ], + "query": [ + { + "key": "page", + "value": "1", + "description": "The page of results to fetch. Defaults to first page" + }, + { + "key": "per_page", + "value": "25", + "description": "How many results to display per page. Defaults to 25. Max 25." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Retrieve a paginated list of calls.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Get a call", + "tags": [ + "Calls" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/calls/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "calls", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The id of the call to retrieve" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Retrieve a single call by id.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Get call recording by call id", + "tags": [ + "Calls" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/calls/{id}/recording", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "calls", + "{id}", + "recording" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The id of the call" + } + ] + }, + "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": "Redirects to a signed URL for the call's recording if it exists.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Get call transcript by call id", + "tags": [ + "Calls" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/calls/{id}/transcript", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "calls", + "{id}", + "transcript" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The id of the call" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Returns the transcript for the specified call as a downloadable text file.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List calls with transcripts", + "tags": [ + "Calls" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/calls/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "calls", + "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" + } + ] + }, + "method": "POST", + "description": "Retrieve calls by a list of conversation ids and include transcripts when available.\nA maximum of 20 `conversation_ids` can be provided. If none are provided or more than 20 are provided, a 400 error is returned.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"conversation_ids\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + } + ], + "event": [], + "variable": [ + { + "id": "8993cc23-9e5e-434f-b0e5-f274e5cef4d4", + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string", + "description": "bearertokenvalue" + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + } +} \ No newline at end of file diff --git a/postman/2.7/README.md b/postman/2.7/README.md index ec69d7e..a23d6b5 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-25T10:49:25.444Z +Last updated: 2025-08-27T09:13:42.648Z diff --git a/postman/2.7/intercom-api.postman_collection.json b/postman/2.7/intercom-api.postman_collection.json index 10a2937..200c15f 100644 --- a/postman/2.7/intercom-api.postman_collection.json +++ b/postman/2.7/intercom-api.postman_collection.json @@ -8,7 +8,7 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-04-25T10:49:25.442Z" + "updatedAt": "2025-08-27T09:13:42.646Z" }, "item": [ { @@ -6430,7 +6430,7 @@ "event": [], "variable": [ { - "id": "c4ba1111-57a6-4ce2-a926-7c0dea6c69a9", + "id": "1741355c-0400-4917-8f42-5ceb2bff758a", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/postman/2.8/README.md b/postman/2.8/README.md index a733543..c112aba 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-25T10:49:25.623Z +Last updated: 2025-08-27T09:13:42.763Z diff --git a/postman/2.8/intercom-api.postman_collection.json b/postman/2.8/intercom-api.postman_collection.json index 4d845a7..e0c89d2 100644 --- a/postman/2.8/intercom-api.postman_collection.json +++ b/postman/2.8/intercom-api.postman_collection.json @@ -8,7 +8,7 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-04-25T10:49:25.621Z" + "updatedAt": "2025-08-27T09:13:42.761Z" }, "item": [ { @@ -6430,7 +6430,7 @@ "event": [], "variable": [ { - "id": "b06e7ef5-721c-466b-b605-687447e475b6", + "id": "dc34d678-d394-4c40-be69-84cd09b5c7d1", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/postman/2.9/README.md b/postman/2.9/README.md index d55fa4e..fc2cec4 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-25T10:49:25.825Z +Last updated: 2025-08-27T09:13:42.902Z diff --git a/postman/2.9/intercom-api.postman_collection.json b/postman/2.9/intercom-api.postman_collection.json index cf6e1ae..e61ed37 100644 --- a/postman/2.9/intercom-api.postman_collection.json +++ b/postman/2.9/intercom-api.postman_collection.json @@ -8,7 +8,7 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-04-25T10:49:25.822Z" + "updatedAt": "2025-08-27T09:13:42.899Z" }, "item": [ { @@ -7113,7 +7113,7 @@ "event": [], "variable": [ { - "id": "29388de1-da62-4158-966c-1fa8df19b721", + "id": "3f7b05f8-29ba-4f03-9827-c7dba593369f", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/postman/Unstable/README.md b/postman/Unstable/README.md index fe41e05..a1bfa9c 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-07-31T13:47:07.414Z +Last updated: 2025-08-27T09:13:41.711Z diff --git a/postman/Unstable/intercom-api.postman_collection.json b/postman/Unstable/intercom-api.postman_collection.json index 293603b..0313cc5 100644 --- a/postman/Unstable/intercom-api.postman_collection.json +++ b/postman/Unstable/intercom-api.postman_collection.json @@ -8,7 +8,7 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-07-31T13:47:07.412Z" + "updatedAt": "2025-08-27T09:13:41.708Z" }, "item": [ { @@ -1372,6 +1372,127 @@ } ] }, + { + "name": "Brands", + "item": [ + { + "name": "List all brands", + "tags": [ + "Brands" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/brands", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "brands" + ], + "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": "Retrieves all brands for the workspace, including the default brand.\nThe default brand id always matches the workspace \n", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a brand", + "tags": [ + "Brands" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/brands/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "brands", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of the brand" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Fetches a specific brand by its unique identifier", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, { "name": "Companies", "item": [ @@ -3157,6 +3278,11 @@ "key": "display_as", "value": "plaintext", "description": "Set to plaintext to retrieve conversation messages in plain text." + }, + { + "key": "include_translations", + "value": "true", + "description": "If set to true, conversation parts will be translated to the detected language of the conversation." } ], "variable": [ @@ -4604,7 +4730,7 @@ ], "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}", + "raw": "{\n \"data_type\": \"\",\n \"options\": [\n {\n \"value\": \"1-10\"\n },\n {\n \"value\": \"11-50\"\n }\n ]\n}", "urlencoded": [], "formdata": [] } @@ -4675,7 +4801,7 @@ ], "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}", + "raw": "{\n \"options\": [\n {\n \"value\": \"1-10\"\n },\n {\n \"value\": \"11-50\"\n }\n ]\n}", "urlencoded": [], "formdata": [] } @@ -5146,6 +5272,127 @@ } ] }, + { + "name": "Emails", + "item": [ + { + "name": "List all email settings", + "tags": [ + "Emails" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/emails", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "emails" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Lists all sender email address settings for the workspace", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve an email setting", + "tags": [ + "Emails" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/emails/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "emails", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier of the email setting" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Fetches a specific email setting by its unique identifier", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, { "name": "Help Center", "item": [ @@ -5587,34 +5834,25 @@ ] }, { - "name": "Jobs", + "name": "Internal Articles", "item": [ { - "name": "Retrieve job status", + "name": "List all articles", "tags": [ - "Jobs" + "Internal Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/jobs/status/{id}", + "raw": "https://api.intercom.io/internal_articles", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "jobs", - "status", - "{id}" + "internal_articles" ], "query": [], - "variable": [ - { - "key": "id", - "value": "id", - "disabled": false, - "description": "The unique identifier for the job which is given by Intercom" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -5637,7 +5875,7 @@ ] }, "method": "GET", - "description": "Retrieve the status of job execution.", + "description": "You can fetch a list of all internal articles by making a GET request to `https://api.intercom.io/internal_articles`.", "header": [ { "key": "Intercom-Version", @@ -5651,45 +5889,32 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Macros", - "item": [ + }, { - "name": "List all macros", + "name": "Retrieve an internal article", "tags": [ - "Macros" + "Internal Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/macros", + "raw": "https://api.intercom.io/internal_articles/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "macros" + "internal_articles", + "{id}" ], - "query": [ + "query": [], + "variable": [ { - "key": "per_page", - "value": "50", - "description": "The number of results per page" - }, - { - "key": "starting_after", - "value": "WzE3MTk0OTM3NTcuMCwgIjEyMyJd", - "description": "Base64-encoded cursor containing [updated_at, id] for pagination" - }, - { - "key": "updated_since", - "value": "1719474966", - "description": "Unix timestamp to filter macros updated after this time" + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -5712,7 +5937,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of all macros (saved replies) in your workspace for use in automating responses.\n\nThe macros are returned in descending order by updated_at. \n\n**Pagination**\n\nThis endpoint uses cursor-based pagination via the `starting_after` parameter. The cursor is a Base64-encoded JSON array containing `[updated_at, id]` of the last item from the previous page.\n\n**Placeholder Transformation**\n\nThe API transforms Intercom placeholders to a more standard XML-like format:\n- From: `{{user.name | fallback: 'there'}}`\n- To: ``\n", + "description": "You can fetch the details of a single internal article by making a GET request to `https://api.intercom.io/internal_articles/`.", "header": [ { "key": "Intercom-Version", @@ -5728,30 +5953,29 @@ "response": [] }, { - "name": "Retrieve a macro", + "name": "Search for internal articles", "tags": [ - "Macros" + "Internal Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/macros/{id}", + "raw": "https://api.intercom.io/internal_articles/search", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "macros", - "{id}" + "internal_articles", + "search" ], - "query": [], - "variable": [ + "query": [ { - "key": "id", + "key": "folder_id", "value": "123", - "disabled": false, - "description": "The unique identifier of the macro" + "description": "The ID of the folder to search in." } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -5774,7 +5998,7 @@ ] }, "method": "GET", - "description": "You can fetch a single macro (saved reply) by its ID. The macro will only be returned if it is visible to the authenticated user based on its visibility settings.\n\n**Visibility Rules**\n\nA macro is returned based on its `visible_to` setting:\n- `everyone`: Always visible to all team members\n- `specific_teams`: Only visible if the authenticated user belongs to one of the teams specified in `visible_to_team_ids`\n\nIf a macro exists but is not visible to the authenticated user, a 404 error is returned.\n\n**Placeholder Transformation**\n\nThe API transforms Intercom placeholders to a more standard XML-like format in the `body` field:\n- From: `{{user.name | fallback: 'there'}}`\n- To: ``\n\nDefault values in placeholders are HTML-escaped for security.\n", + "description": "You can search for internal articles by making a GET request to `https://api.intercom.io/internal_articles/search`.", "header": [ { "key": "Intercom-Version", @@ -5788,46 +6012,23 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Messages", - "item": [ + }, { - "name": "Get statuses of all messages sent based on the specified ruleset_id", + "name": "Create an internal article", "tags": [ - "Messages", - "WhatsApp" + "Internal Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/messages/status", + "raw": "https://api.intercom.io/internal_articles", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "messages", - "status" - ], - "query": [ - { - "key": "ruleset_id", - "value": "ruleset_id", - "description": "The unique identifier for the set of messages to check status for" - }, - { - "key": "per_page", - "value": "per_page", - "description": "Number of results per page (default 50, max 100)" - }, - { - "key": "starting_after", - "value": "starting_after", - "description": "Cursor for pagination, used to fetch the next page of results" - } + "internal_articles" ], + "query": [], "variable": [] }, "auth": { @@ -5850,39 +6051,56 @@ } ] }, - "method": "GET", - "description": "Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages.\n\n\nThis endpoint returns paginated status events for WhatsApp messages sent via the Outbound module, providing\ninformation about delivery state and related message details.\n", + "method": "POST", + "description": "You can create a new internal article by making a POST request to `https://api.intercom.io/internal_articles`.", "header": [ { "key": "Intercom-Version", "value": "Unstable" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"title\": \"Thanks for everything\",\n \"body\": \"

This is the body in html

\",\n \"author_id\": 1295,\n \"owner_id\": 1295\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Create a message", + "name": "Update an internal article", "tags": [ - "Messages" + "Internal Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/messages", + "raw": "https://api.intercom.io/internal_articles/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "messages" + "internal_articles", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the internal article which is given by Intercom." + } + ] }, "auth": { "type": "bearer", @@ -5904,8 +6122,8 @@ } ] }, - "method": "POST", - "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message, an email, sms or whatsapp.\n\n> 🚧 Sending for visitors\n>\n> There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.\n\nThis will return the Message model that has been created.\n\n> 🚧 Retrieving Associated Conversations\n>\n> As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.\n", + "method": "PUT", + "description": "You can update the details of a single internal article by making a PUT request to `https://api.intercom.io/internal_articles/`.", "header": [ { "key": "Intercom-Version", @@ -5922,36 +6140,38 @@ ], "body": { "mode": "raw", - "raw": "{\n \"message_type\": \"in_app\",\n \"subject\": \"Thanks for everything\",\n \"body\": \"Hello there\",\n \"template\": \"plain\",\n \"from\": {\n \"type\": \"admin\",\n \"id\": 394051\n },\n \"to\": [\n {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n {\n \"type\": \"lead\",\n \"id\": \"536e564f316c83104c000021\"\n }\n ],\n \"cc\": [\n {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000023\"\n }\n ],\n \"bcc\": [\n {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000022\"\n }\n ],\n \"created_at\": 1590000000,\n \"create_conversation_without_contact_reply\": true\n}", + "raw": "{\n \"title\": \"Thanks for everything\",\n \"body\": \"\",\n \"author_id\": 1295,\n \"owner_id\": 1295\n}", "urlencoded": [], "formdata": [] } }, "response": [] - } - ] - }, - { - "name": "News", - "item": [ + }, { - "name": "List all news items", + "name": "Delete an internal article", "tags": [ - "News" + "Internal Articles" ], "request": { "url": { - "raw": "https://api.intercom.io/news/news_items", + "raw": "https://api.intercom.io/internal_articles/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "news", - "news_items" + "internal_articles", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the internal article which is given by Intercom." + } + ] }, "auth": { "type": "bearer", @@ -5973,8 +6193,8 @@ } ] }, - "method": "GET", - "description": "You can fetch a list of all news items", + "method": "DELETE", + "description": "You can delete a single internal article by making a DELETE request to `https://api.intercom.io/internal_articles/`.", "header": [ { "key": "Intercom-Version", @@ -5988,31 +6208,36 @@ "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Jobs", + "item": [ { - "name": "Retrieve a news item", + "name": "Retrieve job status", "tags": [ - "News" + "Jobs" ], "request": { "url": { - "raw": "https://api.intercom.io/news/news_items/{id}", + "raw": "https://api.intercom.io/jobs/status/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "news", - "news_items", + "jobs", + "status", "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "123", + "value": "id", "disabled": false, - "description": "The unique identifier for the news item which is given by Intercom." + "description": "The unique identifier for the job which is given by Intercom" } ] }, @@ -6037,7 +6262,7 @@ ] }, "method": "GET", - "description": "You can fetch the details of a single news item.", + "description": "Retrieve the status of job execution.", "header": [ { "key": "Intercom-Version", @@ -6051,34 +6276,45 @@ "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Macros", + "item": [ { - "name": "List all live newsfeed items", + "name": "List all macros", "tags": [ - "News" + "Macros" ], "request": { "url": { - "raw": "https://api.intercom.io/news/newsfeeds/{id}/items", + "raw": "https://api.intercom.io/macros", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "news", - "newsfeeds", - "{id}", - "items" + "macros" ], - "query": [], - "variable": [ + "query": [ { - "key": "id", - "value": "123", - "disabled": false, - "description": "The unique identifier for the news feed item which is given by Intercom." + "key": "per_page", + "value": "50", + "description": "The number of results per page" + }, + { + "key": "starting_after", + "value": "WzE3MTk0OTM3NTcuMCwgIjEyMyJd", + "description": "Base64-encoded cursor containing [updated_at, id] for pagination" + }, + { + "key": "updated_since", + "value": "1719474966", + "description": "Unix timestamp to filter macros updated after this time" } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -6101,7 +6337,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of all news items that are live on a given newsfeed", + "description": "You can fetch a list of all macros (saved replies) in your workspace for use in automating responses.\n\nThe macros are returned in descending order by updated_at.\n\n**Pagination**\n\nThis endpoint uses cursor-based pagination via the `starting_after` parameter. The cursor is a Base64-encoded JSON array containing `[updated_at, id]` of the last item from the previous page.\n\n**Placeholder Transformation**\n\nThe API transforms Intercom placeholders to a more standard XML-like format:\n- From: `{{user.name | fallback: 'there'}}`\n- To: ``\n", "header": [ { "key": "Intercom-Version", @@ -6117,23 +6353,30 @@ "response": [] }, { - "name": "List all newsfeeds", + "name": "Retrieve a macro", "tags": [ - "News" + "Macros" ], "request": { "url": { - "raw": "https://api.intercom.io/news/newsfeeds", + "raw": "https://api.intercom.io/macros/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "news", - "newsfeeds" + "macros", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of the macro" + } + ] }, "auth": { "type": "bearer", @@ -6156,7 +6399,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of all newsfeeds", + "description": "You can fetch a single macro (saved reply) by its ID. The macro will only be returned if it is visible to the authenticated user based on its visibility settings.\n\n**Visibility Rules**\n\nA macro is returned based on its `visible_to` setting:\n- `everyone`: Always visible to all team members\n- `specific_teams`: Only visible if the authenticated user belongs to one of the teams specified in `visible_to_team_ids`\n\nIf a macro exists but is not visible to the authenticated user, a 404 error is returned.\n\n**Placeholder Transformation**\n\nThe API transforms Intercom placeholders to a more standard XML-like format in the `body` field:\n- From: `{{user.name | fallback: 'there'}}`\n- To: ``\n\nDefault values in placeholders are HTML-escaped for security.\n", "header": [ { "key": "Intercom-Version", @@ -6170,33 +6413,47 @@ "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Messages", + "item": [ { - "name": "Retrieve a newsfeed", + "name": "Get statuses of all messages sent based on the specified ruleset_id", "tags": [ - "News" + "Messages", + "WhatsApp" ], "request": { "url": { - "raw": "https://api.intercom.io/news/newsfeeds/{id}", + "raw": "https://api.intercom.io/messages/status", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "news", - "newsfeeds", - "{id}" + "messages", + "status" ], - "query": [], - "variable": [ + "query": [ { - "key": "id", - "value": "123", - "disabled": false, - "description": "The unique identifier for the news feed item which is given by Intercom." + "key": "ruleset_id", + "value": "ruleset_id", + "description": "The unique identifier for the set of messages to check status for" + }, + { + "key": "per_page", + "value": "per_page", + "description": "Number of results per page (default 50, max 100)" + }, + { + "key": "starting_after", + "value": "starting_after", + "description": "Cursor for pagination, used to fetch the next page of results" } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -6219,7 +6476,7 @@ ] }, "method": "GET", - "description": "You can fetch the details of a single newsfeed", + "description": "Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages.\n\n\nThis endpoint returns paginated status events for WhatsApp messages sent via the Outbound module, providing\ninformation about delivery state and related message details.\n", "header": [ { "key": "Intercom-Version", @@ -6235,20 +6492,19 @@ "response": [] }, { - "name": "Create a news item", + "name": "Create a message", "tags": [ - "News" + "Messages" ], "request": { "url": { - "raw": "https://api.intercom.io/news/news_items", + "raw": "https://api.intercom.io/messages", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "news", - "news_items" + "messages" ], "query": [], "variable": [] @@ -6274,7 +6530,7 @@ ] }, "method": "POST", - "description": "You can create a news item", + "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message, an email, sms or whatsapp.\n\n> 🚧 Sending for visitors\n>\n> There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.\n\nThis will return the Message model that has been created.\n\n> 🚧 Retrieving Associated Conversations\n>\n> As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.\n", "header": [ { "key": "Intercom-Version", @@ -6291,39 +6547,36 @@ ], "body": { "mode": "raw", - "raw": "{\n \"title\": \"Halloween is here!\",\n \"body\": \"

New costumes in store for this spooky season

\",\n \"sender_id\": 123,\n \"state\": \"live\",\n \"deliver_silently\": true,\n \"labels\": [\n \"Product\",\n \"Update\",\n \"New\"\n ],\n \"reactions\": [\n \"😆\",\n \"😅\"\n ],\n \"newsfeed_assignments\": [\n {\n \"newsfeed_id\": 198313,\n \"published_at\": 1674917488\n }\n ]\n}", + "raw": "{\n \"message_type\": \"in_app\",\n \"subject\": \"Thanks for everything\",\n \"body\": \"Hello there\",\n \"template\": \"plain\",\n \"from\": {\n \"type\": \"admin\",\n \"id\": 394051\n },\n \"to\": [\n {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n {\n \"type\": \"lead\",\n \"id\": \"536e564f316c83104c000021\"\n }\n ],\n \"cc\": [\n {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000023\"\n }\n ],\n \"bcc\": [\n {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000022\"\n }\n ],\n \"created_at\": 1590000000,\n \"create_conversation_without_contact_reply\": true\n}", "urlencoded": [], "formdata": [] } }, "response": [] - }, + } + ] + }, + { + "name": "News", + "item": [ { - "name": "Update a news item", + "name": "List all news items", "tags": [ "News" ], "request": { "url": { - "raw": "https://api.intercom.io/news/news_items/{id}", + "raw": "https://api.intercom.io/news/news_items", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "news", - "news_items", - "{id}" + "news_items" ], "query": [], - "variable": [ - { - "key": "id", - "value": "123", - "disabled": false, - "description": "The unique identifier for the news item which is given by Intercom." - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -6345,32 +6598,24 @@ } ] }, - "method": "PUT", + "method": "GET", + "description": "You can fetch a list of all news items", "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": [] - } + "body": null }, "response": [] }, { - "name": "Delete a news item", + "name": "Retrieve a news item", "tags": [ "News" ], @@ -6416,8 +6661,8 @@ } ] }, - "method": "DELETE", - "description": "You can delete a single news item.", + "method": "GET", + "description": "You can fetch the details of a single news item.", "header": [ { "key": "Intercom-Version", @@ -6431,37 +6676,32 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Notes", - "item": [ + }, { - "name": "List all notes", + "name": "List all live newsfeed items", "tags": [ - "Notes", - "Contacts" + "News" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/notes", + "raw": "https://api.intercom.io/news/newsfeeds/{id}/items", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", + "news", + "newsfeeds", "{id}", - "notes" + "items" ], "query": [], "variable": [ { "key": "id", - "value": "id", + "value": "123", "disabled": false, - "description": "The unique identifier of a contact." + "description": "The unique identifier for the news feed item which is given by Intercom." } ] }, @@ -6486,7 +6726,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of notes that are associated to a contact.", + "description": "You can fetch a list of all news items that are live on a given newsfeed", "header": [ { "key": "Intercom-Version", @@ -6502,30 +6742,23 @@ "response": [] }, { - "name": "Retrieve a note", + "name": "List all newsfeeds", "tags": [ - "Notes" + "News" ], "request": { "url": { - "raw": "https://api.intercom.io/notes/{id}", + "raw": "https://api.intercom.io/news/newsfeeds", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "notes", - "{id}" + "news", + "newsfeeds" ], "query": [], - "variable": [ - { - "key": "id", - "value": "1", - "disabled": false, - "description": "The unique identifier of a given note" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -6548,7 +6781,7 @@ ] }, "method": "GET", - "description": "You can fetch the details of a single note.", + "description": "You can fetch a list of all newsfeeds", "header": [ { "key": "Intercom-Version", @@ -6564,22 +6797,21 @@ "response": [] }, { - "name": "Create a note", + "name": "Retrieve a newsfeed", "tags": [ - "Notes", - "Contacts" + "News" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/notes", + "raw": "https://api.intercom.io/news/newsfeeds/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{id}", - "notes" + "news", + "newsfeeds", + "{id}" ], "query": [], "variable": [ @@ -6587,7 +6819,7 @@ "key": "id", "value": "123", "disabled": false, - "description": "The unique identifier of a given contact." + "description": "The unique identifier for the news feed item which is given by Intercom." } ] }, @@ -6611,58 +6843,39 @@ } ] }, - "method": "POST", - "description": "You can add a note to a single contact.", + "method": "GET", + "description": "You can fetch the details of a single newsfeed", "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": [] - } + "body": null }, "response": [] - } - ] - }, - { - "name": "Segments", - "item": [ + }, { - "name": "List all segments", + "name": "Create a news item", "tags": [ - "Segments" + "News" ], "request": { "url": { - "raw": "https://api.intercom.io/segments", + "raw": "https://api.intercom.io/news/news_items", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "segments" - ], - "query": [ - { - "key": "include_count", - "value": "true", - "description": "It includes the count of contacts that belong to each segment." - } + "news", + "news_items" ], + "query": [], "variable": [] }, "auth": { @@ -6685,36 +6898,46 @@ } ] }, - "method": "GET", - "description": "You can fetch a list of all segments.", + "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": null + "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": "Retrieve a segment", + "name": "Update a news item", "tags": [ - "Segments" + "News" ], "request": { "url": { - "raw": "https://api.intercom.io/segments/{id}", + "raw": "https://api.intercom.io/news/news_items/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "segments", + "news", + "news_items", "{id}" ], "query": [], @@ -6723,7 +6946,7 @@ "key": "id", "value": "123", "disabled": false, - "description": "The unique identified of a given segment." + "description": "The unique identifier for the news item which is given by Intercom." } ] }, @@ -6747,44 +6970,56 @@ } ] }, - "method": "GET", - "description": "You can fetch the details of a single segment.", + "method": "PUT", "header": [ { "key": "Intercom-Version", "value": "Unstable" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "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": "Subscription Types", - "item": [ + }, { - "name": "List subscription types", + "name": "Delete a news item", "tags": [ - "Subscription Types" + "News" ], "request": { "url": { - "raw": "https://api.intercom.io/subscription_types", + "raw": "https://api.intercom.io/news/news_items/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "subscription_types" + "news", + "news_items", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } + ] }, "auth": { "type": "bearer", @@ -6806,8 +7041,8 @@ } ] }, - "method": "GET", - "description": "You can list all subscription types. A list of subscription type objects will be returned.", + "method": "DELETE", + "description": "You can delete a single news item.", "header": [ { "key": "Intercom-Version", @@ -6821,32 +7056,37 @@ "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Notes", + "item": [ { - "name": "Add subscription to a contact", + "name": "List all notes", "tags": [ - "Subscription Types", + "Notes", "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/contacts/{id}/notes", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "contacts", - "{contact_id}", - "subscriptions" + "{id}", + "notes" ], "query": [], "variable": [ { - "key": "contact_id", - "value": "63a07ddf05a32042dffac965", + "key": "id", + "value": "id", "disabled": false, - "description": "The unique identifier for the contact which is given by Intercom" + "description": "The unique identifier of a contact." } ] }, @@ -6870,63 +7110,45 @@ } ] }, - "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", + "method": "GET", + "description": "You can fetch a list of notes that are associated to a contact.", "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": [] - } + "body": null }, "response": [] }, { - "name": "Remove subscription from a contact", + "name": "Retrieve a note", "tags": [ - "Subscription Types", - "Contacts" + "Notes" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions/{id}", + "raw": "https://api.intercom.io/notes/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{contact_id}", - "subscriptions", + "notes", "{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", + "value": "1", "disabled": false, - "description": "The unique identifier for the subscription type which is given by Intercom" + "description": "The unique identifier of a given note" } ] }, @@ -6950,8 +7172,8 @@ } ] }, - "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.", + "method": "GET", + "description": "You can fetch the details of a single note.", "header": [ { "key": "Intercom-Version", @@ -6965,29 +7187,34 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Switch", - "item": [ + }, { - "name": "Create a phone Switch", + "name": "Create a note", "tags": [ - "Switch" + "Notes", + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/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": [] + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given contact." + } + ] }, "auth": { "type": "bearer", @@ -7010,7 +7237,7 @@ ] }, "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", + "description": "You can add a note to a single contact.", "header": [ { "key": "Intercom-Version", @@ -7027,7 +7254,7 @@ ], "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}", + "raw": "{\n \"body\": \"New note\",\n \"contact_id\": \"123\",\n \"admin_id\": \"123\"\n}", "urlencoded": [], "formdata": [] } @@ -7037,24 +7264,30 @@ ] }, { - "name": "Tags", + "name": "Segments", "item": [ { - "name": "List all tags", + "name": "List all segments", "tags": [ - "Tags" + "Segments" ], "request": { "url": { - "raw": "https://api.intercom.io/tags", + "raw": "https://api.intercom.io/segments", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "tags" + "segments" + ], + "query": [ + { + "key": "include_count", + "value": "true", + "description": "It includes the count of contacts that belong to each segment." + } ], - "query": [], "variable": [] }, "auth": { @@ -7078,7 +7311,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of all tags for a given workspace.\n\n", + "description": "You can fetch a list of all segments.", "header": [ { "key": "Intercom-Version", @@ -7094,19 +7327,19 @@ "response": [] }, { - "name": "Find a specific tag", + "name": "Retrieve a segment", "tags": [ - "Tags" + "Segments" ], "request": { "url": { - "raw": "https://api.intercom.io/tags/{id}", + "raw": "https://api.intercom.io/segments/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "tags", + "segments", "{id}" ], "query": [], @@ -7115,7 +7348,7 @@ "key": "id", "value": "123", "disabled": false, - "description": "The unique identifier of a given tag" + "description": "The unique identified of a given segment." } ] }, @@ -7140,7 +7373,7 @@ ] }, "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", + "description": "You can fetch the details of a single segment.", "header": [ { "key": "Intercom-Version", @@ -7154,34 +7387,29 @@ "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Subscription Types", + "item": [ { - "name": "Add tag to a contact", + "name": "List subscription types", "tags": [ - "Tags", - "Contacts" + "Subscription Types" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/subscription_types", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{contact_id}", - "tags" + "subscription_types" ], "query": [], - "variable": [ - { - "key": "contact_id", - "value": "63a07ddf05a32042dffac965", - "disabled": false, - "description": "The unique identifier for the contact which is given by Intercom" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -7203,56 +7431,47 @@ } ] }, - "method": "POST", - "description": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", + "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": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"7522907\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Add tag to a conversation", + "name": "Add subscription to a contact", "tags": [ - "Tags", - "Conversations" + "Subscription Types", + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{conversation_id}/tags", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{conversation_id}", - "tags" + "contacts", + "{contact_id}", + "subscriptions" ], "query": [], "variable": [ { - "key": "conversation_id", - "value": "64619700005694", + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "conversation_id" + "description": "The unique identifier for the contact which is given by Intercom" } ] }, @@ -7277,7 +7496,7 @@ ] }, "method": "POST", - "description": "You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", + "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", @@ -7294,7 +7513,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"780\"\n}", + "raw": "{\n \"id\": \"37846\",\n \"consent_type\": \"opt_in\"\n}", "urlencoded": [], "formdata": [] } @@ -7302,22 +7521,39 @@ "response": [] }, { - "name": "Create or update a tag, Tag or untag companies, Tag contacts", + "name": "Remove subscription from a contact", "tags": [ - "Tags" + "Subscription Types", + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/tags", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "tags" + "contacts", + "{contact_id}", + "subscriptions", + "{id}" ], "query": [], - "variable": [] + "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", @@ -7339,58 +7575,44 @@ } ] }, - "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", + "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": "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": [] - } + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Switch", + "item": [ { - "name": "Add tag to a ticket", + "name": "Create a phone Switch", "tags": [ - "Tags", - "Tickets" + "Switch" ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/{ticket_id}/tags", + "raw": "https://api.intercom.io/phone_call_redirects", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "tickets", - "{ticket_id}", - "tags" + "phone_call_redirects" ], "query": [], - "variable": [ - { - "key": "ticket_id", - "value": "64619700005694", - "disabled": false, - "description": "ticket_id" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -7413,7 +7635,7 @@ ] }, "method": "POST", - "description": "You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", + "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", @@ -7430,39 +7652,655 @@ ], "body": { "mode": "raw", - "raw": "{\n \"id\": \"7522907\",\n \"admin_id\": \"780\"\n}", + "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": "Remove tag from a contact", + "name": "List all tags", "tags": [ - "Tags", - "Contacts" + "Tags" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{contact_id}/tags/{id}", + "raw": "https://api.intercom.io/tags", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{contact_id}", - "tags", - "{id}" + "tags" ], "query": [], - "variable": [ + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ { - "key": "contact_id", - "value": "63a07ddf05a32042dffac965", - "disabled": false, + "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 for a given workspace.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Unstable" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Find a specific tag", + "tags": [ + "Tags" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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": "Add tag to a contact", + "tags": [ + "Tags", + "Contacts" + ], + "request": { + "url": { + "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": "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": "Add tag to a conversation", + "tags": [ + "Tags", + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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": "Create or update a tag, Tag or untag companies, Tag contacts", + "tags": [ + "Tags" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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": "Add tag to a ticket", + "tags": [ + "Tags", + "Tickets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tickets/{ticket_id}/tags", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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": "Remove tag from a contact", + "tags": [ + "Tags", + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{contact_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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": "Remove tag from a conversation", + "tags": [ + "Tags", + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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": "Delete tag", + "tags": [ + "Tags" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tags/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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": "Remove tag from a ticket", + "tags": [ + "Tags", + "Tickets" + ], + "request": { + "url": { + "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", @@ -7492,8 +8330,76 @@ } ] }, - "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.", + "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": "List all teams", + "tags": [ + "Teams" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/teams", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "method": "GET", + "description": "This will return a list of team objects for the App.", "header": [ { "key": "Intercom-Version", @@ -7509,37 +8415,28 @@ "response": [] }, { - "name": "Remove tag from a conversation", + "name": "Retrieve a team", "tags": [ - "Tags", - "Conversations" + "Teams" ], "request": { "url": { - "raw": "https://api.intercom.io/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": "conversation_id", - "value": "64619700005694", - "disabled": false, - "description": "conversation_id" - }, { "key": "id", - "value": "7522907", + "value": "123", "disabled": false, - "description": "id" + "description": "The unique identifier of a given team." } ] }, @@ -7563,54 +8460,110 @@ } ] }, - "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.", + "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": "Content-Type", + "key": "Accept", "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Ticket States", + "item": [ + { + "name": "List all ticket states", + "tags": [ + "Ticket States" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/ticket_states", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "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" + } + ] + }, + "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": { - "mode": "raw", - "raw": "{\n \"admin_id\": \"123\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Ticket Type Attributes", + "item": [ { - "name": "Delete tag", + "name": "Create a new attribute for a ticket type", "tags": [ - "Tags" + "Ticket Type Attributes" ], "request": { "url": { - "raw": "https://api.intercom.io/tags/{id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "tags", - "{id}" + "ticket_types", + "{ticket_type_id}", + "attributes" ], "query": [], "variable": [ { - "key": "id", - "value": "123", + "key": "ticket_type_id", + "value": "ticket_type_id", "disabled": false, - "description": "The unique identifier of a given tag" + "description": "The unique identifier for the ticket type which is given by Intercom." } ] }, @@ -7634,54 +8587,62 @@ } ] }, - "method": "DELETE", - "description": "You can delete the details of tags that are on the workspace by passing in the id.", + "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": null + "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": "Remove tag from a ticket", + "name": "Update an existing attribute for a ticket type", "tags": [ - "Tags", - "Tickets" + "Ticket Type Attributes" ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/{ticket_id}/tags/{id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "tickets", - "{ticket_id}", - "tags", + "ticket_types", + "{ticket_type_id}", + "attributes", "{id}" ], "query": [], "variable": [ { - "key": "ticket_id", - "value": "64619700005694", + "key": "ticket_type_id", + "value": "ticket_type_id", "disabled": false, - "description": "ticket_id" + "description": "The unique identifier for the ticket type which is given by Intercom." }, { "key": "id", - "value": "7522907", + "value": "id", "disabled": false, - "description": "The unique identifier for the tag which is given by Intercom" + "description": "The unique identifier for the ticket type attribute which is given by Intercom." } ] }, @@ -7705,8 +8666,8 @@ } ] }, - "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.", + "method": "PUT", + "description": "You can update an existing attribute for a ticket type.", "header": [ { "key": "Intercom-Version", @@ -7723,7 +8684,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"admin_id\": \"123\"\n}", + "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": [] } @@ -7733,22 +8694,22 @@ ] }, { - "name": "Teams", + "name": "Ticket Types", "item": [ { - "name": "List all teams", + "name": "List all ticket types", "tags": [ - "Teams" + "Ticket Types" ], "request": { "url": { - "raw": "https://api.intercom.io/teams", + "raw": "https://api.intercom.io/ticket_types", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "teams" + "ticket_types" ], "query": [], "variable": [] @@ -7774,7 +8735,7 @@ ] }, "method": "GET", - "description": "This will return a list of team objects for the App.", + "description": "You can get a list of all ticket types for a workspace.", "header": [ { "key": "Intercom-Version", @@ -7790,28 +8751,28 @@ "response": [] }, { - "name": "Retrieve a team", + "name": "Retrieve a ticket type", "tags": [ - "Teams" + "Ticket Types" ], "request": { "url": { - "raw": "https://api.intercom.io/teams/{id}", + "raw": "https://api.intercom.io/ticket_types/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "teams", + "ticket_types", "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "123", + "value": "id", "disabled": false, - "description": "The unique identifier of a given team." + "description": "The unique identifier for the ticket type which is given by Intercom." } ] }, @@ -7836,7 +8797,7 @@ ] }, "method": "GET", - "description": "You can fetch the details of a single team, containing an array of admins that belong to this team.", + "description": "You can fetch the details of a single ticket type.", "header": [ { "key": "Intercom-Version", @@ -7850,26 +8811,21 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Ticket States", - "item": [ + }, { - "name": "List all ticket states", + "name": "Create a ticket type", "tags": [ - "Ticket States" + "Ticket Types" ], "request": { "url": { - "raw": "https://api.intercom.io/ticket_states", + "raw": "https://api.intercom.io/ticket_types", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "ticket_states" + "ticket_types" ], "query": [], "variable": [] @@ -7894,49 +8850,52 @@ } ] }, - "method": "GET", - "description": "You can get a list of all ticket states for a workspace.", + "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": null + "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": "Ticket Type Attributes", - "item": [ + }, { - "name": "Create a new attribute for a ticket type", + "name": "Update a ticket type", "tags": [ - "Ticket Type Attributes" + "Ticket Types" ], "request": { "url": { - "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes", + "raw": "https://api.intercom.io/ticket_types/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "ticket_types", - "{ticket_type_id}", - "attributes" + "{id}" ], "query": [], "variable": [ { - "key": "ticket_type_id", - "value": "ticket_type_id", + "key": "id", + "value": "id", "disabled": false, "description": "The unique identifier for the ticket type which is given by Intercom." } @@ -7962,8 +8921,8 @@ } ] }, - "method": "POST", - "description": "You can create a new attribute for a ticket type.", + "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", @@ -7980,44 +8939,41 @@ ], "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}", + "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": "Update an existing attribute for a ticket type", + "name": "Retrieve a ticket", "tags": [ - "Ticket Type Attributes" + "Tickets" ], "request": { "url": { - "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes/{id}", + "raw": "https://api.intercom.io/tickets/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "ticket_types", - "{ticket_type_id}", - "attributes", + "tickets", "{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": "The unique identifier for the ticket which is given by Intercom." } ] }, @@ -8041,53 +8997,47 @@ } ] }, - "method": "PUT", - "description": "You can update an existing attribute for a ticket type.", + "method": "GET", + "description": "You can fetch the details of a single ticket.", "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": [] - } + "body": null }, "response": [] - } - ] - }, - { - "name": "Ticket Types", - "item": [ + }, { - "name": "List all ticket types", + "name": "Reply to a ticket", "tags": [ - "Ticket Types" + "Tickets" ], "request": { "url": { - "raw": "https://api.intercom.io/ticket_types", + "raw": "https://api.intercom.io/tickets/{id}/reply", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "ticket_types" + "tickets", + "{id}", + "reply" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false + } + ] }, "auth": { "type": "bearer", @@ -8109,47 +9059,48 @@ } ] }, - "method": "GET", - "description": "You can get a list of all ticket types for a workspace.", + "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": null + "body": { + "mode": "raw", + "raw": "{\n \"message_type\": \"comment\",\n \"type\": \"admin\",\n \"body\": \"Hello there!\",\n \"created_at\": 1590000000,\n \"attachment_urls\": \"\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"admin_id\": \"3156780\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Retrieve a ticket type", + "name": "Create a ticket", "tags": [ - "Ticket Types" + "Tickets" ], "request": { "url": { - "raw": "https://api.intercom.io/ticket_types/{id}", + "raw": "https://api.intercom.io/tickets", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "ticket_types", - "{id}" + "tickets" ], "query": [], - "variable": [ - { - "key": "id", - "value": "id", - "disabled": false, - "description": "The unique identifier for the ticket type which is given by Intercom." - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -8171,36 +9122,46 @@ } ] }, - "method": "GET", - "description": "You can fetch the details of a single ticket type.", + "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": null + "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": "Create a ticket type", + "name": "Enqueue create ticket", "tags": [ - "Ticket Types" + "Tickets" ], "request": { "url": { - "raw": "https://api.intercom.io/ticket_types", + "raw": "https://api.intercom.io/tickets/enqueue", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "ticket_types" + "tickets", + "enqueue" ], "query": [], "variable": [] @@ -8226,7 +9187,7 @@ ] }, "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", + "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", @@ -8243,7 +9204,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"name\": \"Bug\",\n \"description\": \"Used for tracking bugs\",\n \"category\": \"Customer\",\n \"icon\": \"🐞\",\n \"is_internal\": false\n}", + "raw": "{\n \"ticket_type_id\": \"1234\",\n \"contacts\": [\n {\n \"id\": \"1234\"\n }\n ],\n \"conversation_to_link_id\": \"1234\",\n \"company_id\": \"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632\",\n \"created_at\": 1590000000,\n \"ticket_attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n },\n \"assignment\": {\n \"admin_assignee_id\": \"123\",\n \"team_assignee_id\": \"8\"\n }\n}", "urlencoded": [], "formdata": [] } @@ -8251,30 +9212,23 @@ "response": [] }, { - "name": "Update a ticket type", + "name": "Search tickets", "tags": [ - "Ticket Types" + "Tickets" ], "request": { "url": { - "raw": "https://api.intercom.io/ticket_types/{id}", + "raw": "https://api.intercom.io/tickets/search", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "ticket_types", - "{id}" + "tickets", + "search" ], "query": [], - "variable": [ - { - "key": "id", - "value": "id", - "disabled": false, - "description": "The unique identifier for the ticket type which is given by Intercom." - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -8296,8 +9250,8 @@ } ] }, - "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", + "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{% admonition type=\"info\" name=\"Searching by Category\" %}\nWhen searching for tickets by the **`category`** field, specific terms must be used instead of the category names:\n* For **Customer** category tickets, use the term `request`.\n* For **Back-office** category tickets, use the term `task`.\n* For **Tracker** category tickets, use the term `tracker`.\n{% /admonition %}\n\n### Accepted Operators\n\n{% admonition type=\"info\" name=\"Searching based on `created_at`\" %}\n You may use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", "header": [ { "key": "Intercom-Version", @@ -8314,20 +9268,15 @@ ], "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}", + "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": "Tickets", - "item": [ + }, { - "name": "Retrieve a ticket", + "name": "Update a ticket", "tags": [ "Tickets" ], @@ -8348,7 +9297,7 @@ "key": "id", "value": "id", "disabled": false, - "description": "The unique identifier for the ticket which is given by Intercom." + "description": "The unique identifier for the ticket which is given by Intercom" } ] }, @@ -8372,45 +9321,54 @@ } ] }, - "method": "GET", - "description": "You can fetch the details of a single ticket.", + "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": null + "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": "Reply to a ticket", + "name": "Delete a ticket", "tags": [ "Tickets" ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/{id}/reply", + "raw": "https://api.intercom.io/tickets/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "tickets", - "{id}", - "reply" + "{id}" ], "query": [], "variable": [ { "key": "id", "value": "id", - "disabled": false + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom." } ] }, @@ -8434,47 +9392,49 @@ } ] }, - "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.", + "method": "DELETE", + "description": "You can delete a ticket using the Intercom provided ID.", "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 \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"admin_id\": \"3156780\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Visitors", + "item": [ { - "name": "Create a ticket", + "name": "Retrieve a visitor with User ID", "tags": [ - "Tickets" + "Visitors" ], "request": { "url": { - "raw": "https://api.intercom.io/tickets", + "raw": "https://api.intercom.io/visitors", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "tickets" + "visitors" + ], + "query": [ + { + "key": "user_id", + "value": "user_id", + "description": "The user_id of the Visitor you want to retrieve." + } ], - "query": [], "variable": [] }, "auth": { @@ -8497,46 +9457,37 @@ } ] }, - "method": "POST", - "description": "You can create a new ticket.", + "method": "GET", + "description": "You can fetch the details of a single visitor.", "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": [] - } + "body": null }, "response": [] }, { - "name": "Enqueue create ticket", + "name": "Convert a visitor", "tags": [ - "Tickets" + "Visitors" ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/enqueue", + "raw": "https://api.intercom.io/visitors/convert", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "tickets", - "enqueue" + "visitors", + "convert" ], "query": [], "variable": [] @@ -8562,7 +9513,7 @@ ] }, "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.", + "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", @@ -8579,7 +9530,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"ticket_type_id\": \"1234\",\n \"contacts\": [\n {\n \"id\": \"1234\"\n }\n ],\n \"conversation_to_link_id\": \"1234\",\n \"company_id\": \"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632\",\n \"created_at\": 1590000000,\n \"ticket_attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n },\n \"assignment\": {\n \"admin_assignee_id\": \"123\",\n \"team_assignee_id\": \"8\"\n }\n}", + "raw": "{\n \"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": [] } @@ -8587,20 +9538,19 @@ "response": [] }, { - "name": "Search tickets", + "name": "Update a visitor", "tags": [ - "Tickets" + "Visitors" ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/search", + "raw": "https://api.intercom.io/visitors", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "tickets", - "search" + "visitors" ], "query": [], "variable": [] @@ -8625,8 +9575,8 @@ } ] }, - "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{% admonition type=\"info\" name=\"Searching by Category\" %}\nWhen searching for tickets by the **`category`** field, specific terms must be used instead of the category names:\n* For **Customer** category tickets, use the term `request`.\n* For **Back-office** category tickets, use the term `task`.\n* For **Tracker** category tickets, use the term `tracker`.\n{% /admonition %}\n\n### Accepted Operators\n\n{% admonition type=\"info\" name=\"Searching based on `created_at`\" %}\n You may use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "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", @@ -8643,38 +9593,52 @@ ], "body": { "mode": "raw", - "raw": "{\n \"query\": {\n \"field\": \"created_at\",\n \"operator\": \"AND\",\n \"value\": \"73732934\"\n },\n \"pagination\": {\n \"per_page\": 2,\n \"starting_after\": \"your-cursor-from-response\"\n }\n}", + "raw": "{\n \"id\": \"8a88a590-e\",\n \"user_id\": \"123\",\n \"name\": \"Christian Bale\",\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 9\n }\n}", "urlencoded": [], "formdata": [] } }, "response": [] - }, + } + ] + }, + { + "name": "Export", + "item": [ { - "name": "Update a ticket", + "name": "Get export job status", "tags": [ - "Tickets" + "Export" ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/{id}", + "raw": "https://api.intercom.io/export/reporting_data/{job_identifier}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "tickets", - "{id}" + "export", + "reporting_data", + "{job_identifier}" ], - "query": [], - "variable": [ + "query": [ { - "key": "id", - "value": "id", - "disabled": false, - "description": "The unique identifier for the ticket which is given by Intercom" + "key": "app_id", + "value": "app_id", + "description": "The Intercom defined code of the workspace the company is associated to." + }, + { + "key": "client_id", + "value": "client_id" + }, + { + "key": "job_identifier", + "value": "job_identifier", + "description": "Unique identifier of the job." } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -8696,56 +9660,40 @@ } ] }, - "method": "PUT", - "description": "You can update a ticket.", + "method": "GET", "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": [] - } + "body": null }, "response": [] }, { - "name": "Delete a ticket", + "name": "List available datasets and attributes", "tags": [ - "Tickets" + "Export" ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/{id}", + "raw": "https://api.intercom.io/export/reporting_data/get_datasets", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "tickets", - "{id}" + "export", + "reporting_data", + "get_datasets" ], "query": [], - "variable": [ - { - "key": "id", - "value": "id", - "disabled": false, - "description": "The unique identifier for the ticket which is given by Intercom." - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -8767,8 +9715,7 @@ } ] }, - "method": "DELETE", - "description": "You can delete a ticket using the Intercom provided ID.", + "method": "GET", "header": [ { "key": "Intercom-Version", @@ -8782,32 +9729,32 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Visitors", - "item": [ + }, { - "name": "Retrieve a visitor with User ID", + "name": "Download completed export job data", "tags": [ - "Visitors" + "Export" ], "request": { "url": { - "raw": "https://api.intercom.io/visitors", + "raw": "https://api.intercom.io/download/reporting_data/{job_identifier}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "visitors" + "download", + "reporting_data", + "{job_identifier}" ], "query": [ { - "key": "user_id", - "value": "user_id", - "description": "The user_id of the Visitor you want to retrieve." + "key": "app_id", + "value": "app_id" + }, + { + "key": "job_identifier", + "value": "job_identifier" } ], "variable": [] @@ -8833,7 +9780,6 @@ ] }, "method": "GET", - "description": "You can fetch the details of a single visitor.", "header": [ { "key": "Intercom-Version", @@ -8849,20 +9795,21 @@ "response": [] }, { - "name": "Convert a visitor", + "name": "Enqueue a new reporting data export job", "tags": [ - "Visitors" + "Export" ], "request": { "url": { - "raw": "https://api.intercom.io/visitors/convert", + "raw": "https://api.intercom.io/export/reporting_data/enqueue", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "visitors", - "convert" + "export", + "reporting_data", + "enqueue" ], "query": [], "variable": [] @@ -8888,7 +9835,6 @@ ] }, "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", @@ -8905,29 +9851,45 @@ ], "body": { "mode": "raw", - "raw": "{\n \"type\": \"user\",\n \"user\": {\n \"id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"user_id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"email\": \"winstonsmith@truth.org\"\n },\n \"visitor\": {\n \"id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"user_id\": \"8a88a590-e1c3-41e2-a502-e0649dbf721c\",\n \"email\": \"winstonsmith@truth.org\"\n }\n}", + "raw": "{\n \"dataset_id\": \"conversation\",\n \"attribute_ids\": [\n \"conversation_id\",\n \"conversation_started_at\"\n ],\n \"start_time\": 1717490000,\n \"end_time\": 1717510000\n}", "urlencoded": [], "formdata": [] } }, "response": [] - }, + } + ] + }, + { + "name": "Calls", + "item": [ { - "name": "Update a visitor", + "name": "List all calls", "tags": [ - "Visitors" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/visitors", + "raw": "https://api.intercom.io/calls", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "visitors" + "calls" + ], + "query": [ + { + "key": "page", + "value": "1", + "description": "The page of results to fetch. Defaults to first page" + }, + { + "key": "per_page", + "value": "25", + "description": "How many results to display per page. Defaults to 25. Max 25." + } ], - "query": [], "variable": [] }, "auth": { @@ -8950,70 +9912,47 @@ } ] }, - "method": "PUT", - "description": "Sending a PUT request to `/visitors` will result in an update of an existing Visitor.\n\n**Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body.\n\n**Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body.\n", + "method": "GET", + "description": "Retrieve a paginated list of calls.\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": [] - } + "body": null }, "response": [] - } - ] - }, - { - "name": "Export", - "item": [ + }, { - "name": "Get export job status", + "name": "Get a call", "tags": [ - "Export" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/export/reporting_data/{job_identifier}", + "raw": "https://api.intercom.io/calls/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "export", - "reporting_data", - "{job_identifier}" + "calls", + "{id}" ], - "query": [ - { - "key": "app_id", - "value": "app_id", - "description": "The Intercom defined code of the workspace the company is associated to." - }, - { - "key": "client_id", - "value": "client_id" - }, + "query": [], + "variable": [ { - "key": "job_identifier", - "value": "job_identifier", - "description": "Unique identifier of the job." + "key": "id", + "value": "id", + "disabled": false, + "description": "The id of the call to retrieve" } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -9036,6 +9975,7 @@ ] }, "method": "GET", + "description": "Retrieve a single call by id.", "header": [ { "key": "Intercom-Version", @@ -9051,24 +9991,31 @@ "response": [] }, { - "name": "List available datasets and attributes", + "name": "Get call recording by call id", "tags": [ - "Export" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/export/reporting_data/get_datasets", + "raw": "https://api.intercom.io/calls/{id}/recording", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "export", - "reporting_data", - "get_datasets" + "calls", + "{id}", + "recording" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The id of the call" + } + ] }, "auth": { "type": "bearer", @@ -9091,6 +10038,7 @@ ] }, "method": "GET", + "description": "Redirects to a signed URL for the call's recording if it exists.", "header": [ { "key": "Intercom-Version", @@ -9106,33 +10054,31 @@ "response": [] }, { - "name": "Download completed export job data", + "name": "Get call transcript by call id", "tags": [ - "Export" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/download/reporting_data/{job_identifier}", + "raw": "https://api.intercom.io/calls/{id}/transcript", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "download", - "reporting_data", - "{job_identifier}" + "calls", + "{id}", + "transcript" ], - "query": [ - { - "key": "app_id", - "value": "app_id" - }, + "query": [], + "variable": [ { - "key": "job_identifier", - "value": "job_identifier" + "key": "id", + "value": "id", + "disabled": false, + "description": "The id of the call" } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -9155,6 +10101,7 @@ ] }, "method": "GET", + "description": "Returns the transcript for the specified call as a downloadable text file.\n", "header": [ { "key": "Intercom-Version", @@ -9170,21 +10117,20 @@ "response": [] }, { - "name": "Enqueue a new reporting data export job", + "name": "List calls with transcripts", "tags": [ - "Export" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/export/reporting_data/enqueue", + "raw": "https://api.intercom.io/calls/search", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "export", - "reporting_data", - "enqueue" + "calls", + "search" ], "query": [], "variable": [] @@ -9210,6 +10156,7 @@ ] }, "method": "POST", + "description": "Retrieve calls by a list of conversation ids and include transcripts when available.\nA maximum of 20 `conversation_ids` can be provided. If none are provided or more than 20 are provided, a 400 error is returned.\n", "header": [ { "key": "Intercom-Version", @@ -9226,7 +10173,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"dataset_id\": \"conversation\",\n \"attribute_ids\": [\n \"conversation_id\",\n \"conversation_started_at\"\n ],\n \"start_time\": 1717490000,\n \"end_time\": 1717510000\n}", + "raw": "{\n \"conversation_ids\": \"\"\n}", "urlencoded": [], "formdata": [] } @@ -9239,7 +10186,7 @@ "event": [], "variable": [ { - "id": "02513ace-fee8-491d-a182-ea7bdcdff035", + "id": "b3223a1f-c5b2-43f8-af0b-8ef7a1380110", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string",