From 68a0ef7d6ae72385ecf69ce35caba1c1efe03292 Mon Sep 17 00:00:00 2001 From: Rahul D'Souza Date: Thu, 16 Apr 2026 10:27:37 +0100 Subject: [PATCH] Add Fin Agent API endpoints to v2.14, v2.15, and Preview specs The Fin Agent API (POST /fin/start, POST /fin/reply) was documented in developer-docs but missing from the OpenAPI specs. This adds the full API definition including 2 endpoints, 8 component schemas, and the Fin Agent tag to all applicable versions. Also generates the missing v2.15 Postman collection and refreshes v2.14 and Preview collections with the new Fin Agent endpoints. Co-Authored-By: Claude Opus 4.6 --- descriptions/0/api.intercom.io.yaml | 739 ++ descriptions/2.14/api.intercom.io.yaml | 728 ++ descriptions/2.15/api.intercom.io.yaml | 728 ++ postman/2.14/README.md | 2 +- .../2.14/intercom-api.postman_collection.json | 762 +- postman/2.15/README.md | 15 + postman/2.15/environment.json | 18 + .../2.15/intercom-api.postman_collection.json | 10695 ++++++++++++++++ postman/Preview/README.md | 2 +- .../intercom-api.postman_collection.json | 4135 ++++-- 10 files changed, 16699 insertions(+), 1125 deletions(-) create mode 100644 postman/2.15/README.md create mode 100644 postman/2.15/environment.json create mode 100644 postman/2.15/intercom-api.postman_collection.json diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 52e7d9a..25a899a 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -2020,6 +2020,360 @@ paths: message: "Export job not found for identifier: job1" schema: "$ref": "#/components/schemas/error" + "/fin/start": + post: + summary: Start a conversation with Fin + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Fin Agent + operationId: startFinConversation + description: | + Initialize Fin by passing it the user's message along with conversation history and user details. + + These additional pieces of context will be used by Fin to provide a better and more contextual answer to the user. + + {% admonition type="warning" %} + Please reach out to your accounts team to discuss access. + {% /admonition %} + + Once Fin is initialized, it progresses through a series of statuses such as *thinking*, *replying*, *awaiting_user_reply*, or *resolved* before ending with a status of *complete*. + + During this workflow, the client should allow Fin to continue uninterrupted until a final *complete* status is returned, at which point control of the conversation passes back to the client. + + Events can be received via webhooks or Server-Sent Events (SSE) using the `sse_subscription_url` in the response. + responses: + '200': + description: Fin conversation started successfully + content: + application/json: + examples: + Successful response: + value: + conversation_id: ext-123 + user_id: user-456 + status: thinking + created_at_ms: '2025-01-24T10:00:00.123Z' + sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...&rewind=2m' + Response with attribute errors: + value: + conversation_id: ext-123 + user_id: user-456 + status: thinking + created_at_ms: '2025-01-24T10:00:00.123Z' + sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...&rewind=2m' + errors: + user: + attributes: + invalid_attr: User attribute 'invalid_attr' does not exist + conversation: + attributes: + bad_attr: Conversation attribute 'bad_attr' does not exist + schema: + type: object + properties: + conversation_id: + type: string + description: The ID of the conversation. + example: ext-123 + user_id: + type: string + description: The ID of the user. + example: user-456 + status: + type: string + enum: + - thinking + - replying + - awaiting_user_reply + - escalated + - resolved + - complete + description: | + Fin's current status in the conversation workflow. + example: thinking + created_at_ms: + type: string + format: date-time + description: The timestamp the response was created at, with millisecond precision. + example: '2025-01-24T10:00:00.123Z' + errors: + "$ref": "#/components/schemas/fin_agent_attribute_errors" + sse_subscription_url: + type: string + description: | + Optional. A URL to subscribe to Server-Sent Events (SSE) for this conversation, if SSE is enabled. The access token is a JWT with a 3-minute TTL. The token is revoked when Fin sets the conversation to awaiting_user_reply or complete status. + example: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...&rewind=2m' + '400': + description: Bad Request + content: + application/json: + examples: + Invalid request: + value: + type: error.list + request_id: b68959ea-6328-4f70-83cb-e7913dba1542 + errors: + - code: parameter_invalid + message: conversation_id is required + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b68959ea-6328-4f70-83cb-e7913dba1542 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + conversation_id: + type: string + description: The ID of the conversation that is calling Fin via this API. + example: ext-123 + message: + "$ref": "#/components/schemas/fin_agent_message" + user: + "$ref": "#/components/schemas/fin_agent_user" + attachments: + type: array + description: An array of attachments to include with the message. Maximum of 10 attachments. + maxItems: 10 + items: + "$ref": "#/components/schemas/fin_agent_attachment" + conversation_metadata: + "$ref": "#/components/schemas/fin_agent_conversation_metadata" + required: + - conversation_id + - message + - user + examples: + Basic request: + value: + conversation_id: ext-123 + message: + author: user + body: How can I see my account details? + timestamp: '2025-01-24T10:01:20.000Z' + user: + id: '123456' + name: John Doe + email: john.doe@example.com + Request with conversation history: + value: + conversation_id: ext-123 + message: + author: user + body: How can I see my account details? + timestamp: '2025-01-24T10:01:20.000Z' + user: + id: '123456' + name: John Doe + email: john.doe@example.com + attributes: + plan_type: Pro + subscription_status: active + conversation_metadata: + history: + - author: user + body: I need help + timestamp: '2025-01-24T10:00:01Z' + - author: agent + body: What do you need help with? + timestamp: '2025-01-24T10:01:00Z' + attributes: + priority_level: high + department: sales + Request with attachments: + value: + conversation_id: ext-123 + message: + author: user + body: Here is a screenshot of the issue + timestamp: '2025-01-24T10:01:20.000Z' + user: + id: '123456' + name: John Doe + email: john.doe@example.com + attachments: + - type: url + url: https://example.com/document.pdf + - type: file + name: screenshot.png + content_type: image/png + data: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk... + "/fin/reply": + post: + summary: Reply to Fin + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Fin Agent + operationId: replyToFin + description: | + Once Fin has returned a response to a user's message, its status will be `awaiting_user_reply`. + + If a user replies, use this endpoint to send this response to Fin. + + {% admonition type="warning" %} + Please reach out to your accounts team to discuss access. + {% /admonition %} + responses: + '200': + description: Reply sent successfully + content: + application/json: + examples: + Successful response: + value: + conversation_id: ext-123 + user_id: user-456 + status: thinking + created_at_ms: '2025-01-24T10:00:00.123Z' + sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...' + Response with attribute errors: + value: + conversation_id: ext-123 + user_id: user-456 + status: thinking + created_at_ms: '2025-01-24T10:00:00.123Z' + sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...' + errors: + user: + attributes: + invalid_attr: User attribute 'invalid_attr' does not exist + schema: + type: object + properties: + conversation_id: + type: string + description: The ID of the conversation. + example: ext-123 + user_id: + type: string + description: The ID of the user. + example: user-456 + status: + type: string + enum: + - thinking + - replying + - awaiting_user_reply + - escalated + - resolved + - complete + description: | + Fin's current status in the conversation workflow. + example: thinking + created_at_ms: + type: string + format: date-time + description: The timestamp the response was created at, with millisecond precision. + example: '2025-01-24T10:00:00.123Z' + errors: + "$ref": "#/components/schemas/fin_agent_attribute_errors" + sse_subscription_url: + type: string + description: | + Optional. A URL to subscribe to Server-Sent Events (SSE) for this conversation, if SSE is enabled. The access token is a JWT with a 3-minute TTL. The token is revoked when Fin sets the conversation to awaiting_user_reply or complete status. + example: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...' + '400': + description: Bad Request + content: + application/json: + examples: + Invalid request: + value: + type: error.list + request_id: b68959ea-6328-4f70-83cb-e7913dba1542 + errors: + - code: parameter_invalid + message: conversation_id is required + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b68959ea-6328-4f70-83cb-e7913dba1542 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + conversation_id: + type: string + description: The ID of the conversation. + example: '123456' + message: + "$ref": "#/components/schemas/fin_agent_message" + user: + "$ref": "#/components/schemas/fin_agent_user" + attachments: + type: array + description: An array of attachments to include with the message. Maximum of 10 attachments. + maxItems: 10 + items: + "$ref": "#/components/schemas/fin_agent_attachment" + required: + - conversation_id + - message + - user + examples: + Basic reply: + value: + conversation_id: '123456' + message: + author: user + body: Here's the information you requested. + timestamp: '2025-01-24T09:01:00.000Z' + user: + id: '123456' + name: John Doe + email: john.doe@example.com + Reply with attachments: + value: + conversation_id: '123456' + message: + author: user + body: Here's the invoice you asked for. + timestamp: '2025-01-24T09:01:00.000Z' + user: + id: '123456' + name: John Doe + email: john.doe@example.com + attachments: + - type: url + url: https://example.com/invoice.pdf "/help_center/collections": get: summary: List all collections @@ -24997,6 +25351,366 @@ components: description: An array of External Page objects items: "$ref": "#/components/schemas/external_page" + fin_agent_message: + title: Fin Agent Message + type: object + description: A message exchanged within a Fin Agent conversation. + x-tags: + - Fin Agent + properties: + author: + type: string + enum: + - user + - agent + - fin + description: The author that created the message. + example: user + body: + type: string + description: | + The body of the message. Accepts both plain text and HTML format. + When sending a message to Fin, this should contain the user's message. + Fin's response will be returned as HTML. + example: How can I see my account details? + timestamp: + type: string + format: date-time + description: | + The timestamp when the message was created. + Used to deduplicate messages sent within a 5 minute window. + Ideally should include milliseconds for higher precision. + example: '2025-01-24T10:01:20.000Z' + timestamp_ms: + type: string + format: date-time + description: | + The timestamp when the message was created, with millisecond precision. + Only present in event responses (fin_replied). + example: '2025-01-24T10:01:20.456Z' + required: + - author + - body + - timestamp + fin_agent_user: + title: Fin Agent User + type: object + description: A user object representing the user in a Fin Agent conversation. + x-tags: + - Fin Agent + properties: + id: + type: string + description: | + The ID of the user. This value will be used to uniquely identify the user + during a conversation with Fin. Maps to the user_id field on the Intercom User object. + example: '123456' + name: + type: string + description: The name of the user. + example: John Doe + email: + type: string + format: email + description: The email of the user. + example: john.doe@example.com + attributes: + type: object + description: | + A hash of attributes associated with the user. + Attributes can be used by Fin to target content and responses. + Limit to 10 attributes. + additionalProperties: true + example: + plan_type: Pro + subscription_status: active + required: + - id + fin_agent_attachment: + title: Fin Agent Attachment + type: object + description: | + An attachment object representing a file or URL attachment included with a message. + Attachments can be used to provide additional context to Fin. + Maximum of 10 attachments per request. + x-tags: + - Fin Agent + properties: + type: + type: string + enum: + - url + - file + description: The type of attachment. + example: url + url: + type: string + format: uri + description: The URL of the attachment. Required when type is 'url'. Must be publicly accessible. + example: https://example.com/document.pdf + name: + type: string + description: The name of the file. Required when type is 'file'. + example: screenshot.png + content_type: + type: string + description: The MIME type of the file. Required when type is 'file'. + example: image/png + data: + type: string + format: byte + description: Base64-encoded file data. Required when type is 'file'. + example: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk... + required: + - type + fin_agent_conversation_metadata: + title: Fin Agent Conversation Metadata + type: object + description: Metadata about the conversation, including history and attributes. + x-tags: + - Fin Agent + properties: + history: + type: array + description: | + An array of previous messages in the conversation before Fin is initialized. + This data provides context to Fin and helps generate a better answer. + Limit to the last 10 messages. + maxItems: 10 + items: + "$ref": "#/components/schemas/fin_agent_message" + attributes: + type: object + description: | + A hash of attributes associated with the conversation. + These attributes can be used by Fin to provide more contextual responses. + Limit to 10 attributes. + additionalProperties: true + example: + priority_level: high + department: sales + fin_agent_attribute_errors: + title: Fin Agent Attribute Errors + type: object + description: Contains error details if any user or conversation attribute updates failed. + x-tags: + - Fin Agent + properties: + user: + type: object + description: User-related attribute errors. + properties: + attributes: + type: object + description: Map of user attribute names to error messages. + additionalProperties: + type: string + example: + invalid_attr: User attribute 'invalid_attr' does not exist + conversation: + type: object + description: Conversation-related attribute errors. + properties: + attributes: + type: object + description: Map of conversation attribute names to error messages. + additionalProperties: + type: string + example: + bad_attr: Conversation attribute 'bad_attr' does not exist + fin_agent_status_updated_event: + title: Fin Agent Status Updated Event + type: object + description: | + Event fired when Fin's status changes during a conversation. + Fin will report its status to the client via this event. + x-tags: + - Fin Agent + properties: + event_name: + type: string + enum: + - fin_status_updated + description: The name of the event. + example: fin_status_updated + conversation_id: + type: string + description: The ID of the conversation. + example: '123456' + user_id: + type: string + description: The ID of the user. + example: '7891' + status: + type: string + enum: + - awaiting_user_reply + - escalated + - resolved + - complete + description: | + Fin's current status. + - awaiting_user_reply: Fin has finished replying and is waiting for the user to respond + - escalated: The conversation has been escalated to a human + - resolved: The user's query has been resolved + - complete: Fin has completed its workflow + example: escalated + reason: + type: string + description: | + Optional. A human-readable explanation of why the conversation was escalated. + Only present when status is 'escalated'. + Possible values include: + - "Escalation requested by user" + - "Escalation rule: {rule_name}" + - "Escalation rule matched" + - "Routed to team" + - "Conversation finished without resolution" + example: Escalation requested by user + created_at_ms: + type: string + format: date-time + description: The timestamp the event was created at, with millisecond precision. + example: '2025-01-24T10:00:00.123Z' + required: + - event_name + - conversation_id + - user_id + - status + - created_at_ms + fin_agent_replied_event: + title: Fin Agent Replied Event + type: object + description: | + Event fired when Fin replies to a user. + The content of the response will be contained in the message object. + Intermediate replies have status 'replying'; a separate fin_status_updated + event with 'awaiting_user_reply' fires as a done signal. + x-tags: + - Fin Agent + properties: + event_name: + type: string + enum: + - fin_replied + description: The name of the event. + example: fin_replied + conversation_id: + type: string + description: The ID of the conversation. + example: '123456' + user_id: + type: string + description: The ID of the user. + example: '7891' + message: + type: object + description: Fin's answer to the user's query. + properties: + author: + type: string + enum: + - fin + description: The author of the message (always 'fin' for this event). + example: fin + body: + type: string + description: The HTML body of Fin's response. + example:

You can see your account details by clicking on the Account tab in the top right corner of the screen.

+ timestamp_ms: + type: string + format: date-time + description: The timestamp the message was created at, with millisecond precision. + example: '2025-01-24T09:01:00.456Z' + required: + - author + - body + - timestamp_ms + status: + type: string + enum: + - replying + - awaiting_user_reply + description: | + Fin's current status. + - replying: Intermediate reply part; more parts may follow + - awaiting_user_reply: Legacy status; use fin_status_updated event as the done signal instead + example: replying + stream_id: + type: string + description: | + Optional. Present when the reply was generated via streaming. + Correlates this event with the fin_reply_chunk events that preceded it. + Use this to know when to replace streamed chunk_text with the final message body. + example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 + created_at_ms: + type: string + format: date-time + description: The timestamp the event was created at, with millisecond precision. + example: '2025-01-24T10:00:00.123Z' + required: + - event_name + - conversation_id + - user_id + - message + - status + - created_at_ms + fin_agent_reply_chunk_event: + title: Fin Agent Reply Chunk Event + type: object + description: | + SSE-only event fired during streaming reply generation. + Each chunk contains the full accumulated plain text of Fin's answer so far (cumulative, not a delta). + Only delivered over SSE when streaming is enabled. Not available via webhooks. + When the fin_replied event arrives with the same stream_id, replace streamed text with the final HTML body. + x-tags: + - Fin Agent + properties: + event_name: + type: string + enum: + - fin_reply_chunk + description: The name of the event. + example: fin_reply_chunk + conversation_id: + type: string + description: The ID of the conversation. + example: '123456' + stream_id: + type: string + description: | + A unique identifier for this streaming response. + Correlates chunks with each other and with the eventual fin_replied event. + example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 + chunk_index: + type: integer + description: | + 0-based counter for this chunk within the stream. Contiguous. + example: 3 + chunk_text: + type: string + description: | + The full accumulated plain text of Fin's answer so far. + Each chunk supersedes the previous — replace rather than append. + example: You can see your account details by clicking + status: + type: string + enum: + - replying + description: Fin's current status (always 'replying' for this event). + example: replying + created_at_ms: + type: string + format: date-time + description: The timestamp the event was created at, with millisecond precision. + example: '2025-01-24T10:00:00.123Z' + required: + - event_name + - conversation_id + - stream_id + - chunk_index + - chunk_text + - created_at_ms file_attribute: title: File type: object @@ -28693,6 +29407,31 @@ tags: description: Everything about your Data Exports - name: Emails description: Everything about your Emails +- name: Fin Agent + description: | + Access Fin programmatically via the Fin Agent API endpoints. + +   + + {% admonition type="warning" %} + Please reach out to your accounts team to discuss access and tailored, hands-on support. + {% /admonition %} + +   + + Integration is centered around two endpoints (`/fin/start` and `/fin/reply`) and a set of events that notify your application of Fin's status and responses. Events can be delivered via webhooks or Server-Sent Events (SSE). + +   + + **Events** + + Configure a webhook endpoint in the Fin Agent API settings to receive events, or use the `sse_subscription_url` from the API response to subscribe via SSE. See the [setup guide](/docs/guides/fin-agent-api/setup) for configuration details. + + - `fin_status_updated` - Fired when Fin's status changes (awaiting_user_reply, escalated, resolved, complete) + - `fin_replied` - Fired when Fin sends a reply to the user + - `fin_reply_chunk` - SSE-only streaming event fired during reply generation (requires streaming enabled) + + All webhook requests include an `X-Fin-Agent-API-Webhook-Signature` header for request validation. - name: Help Center description: Everything about your Help Center - name: Internal Articles diff --git a/descriptions/2.14/api.intercom.io.yaml b/descriptions/2.14/api.intercom.io.yaml index 4fcceea..13ede78 100644 --- a/descriptions/2.14/api.intercom.io.yaml +++ b/descriptions/2.14/api.intercom.io.yaml @@ -1803,6 +1803,356 @@ paths: message: "Export job not found for identifier: job1" schema: "$ref": "#/components/schemas/error" + "/fin/start": + post: + summary: Start a conversation with Fin + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Fin Agent + operationId: startFinConversation + description: | + Initialize Fin by passing it the user's message along with conversation history and user details. + + These additional pieces of context will be used by Fin to provide a better and more contextual answer to the user. + + {% admonition type="warning" %} + Please reach out to your accounts team to discuss access. + {% /admonition %} + + Once Fin is initialized, it progresses through a series of statuses such as *thinking*, *awaiting_user_reply*, or *resolved* before ending with a status of *complete*. + + During this workflow, the client should allow Fin to continue uninterrupted until a final *complete* status is returned via webhook, at which point control of the conversation passes back to the client. + responses: + '200': + description: Fin conversation started successfully + content: + application/json: + examples: + Successful response: + value: + conversation_id: ext-123 + user_id: user-456 + status: thinking + created_at_ms: '2025-01-24T10:00:00.123Z' + sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...&rewind=2m' + Response with attribute errors: + value: + conversation_id: ext-123 + user_id: user-456 + status: thinking + created_at_ms: '2025-01-24T10:00:00.123Z' + sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...&rewind=2m' + errors: + user: + attributes: + invalid_attr: User attribute 'invalid_attr' does not exist + conversation: + attributes: + bad_attr: Conversation attribute 'bad_attr' does not exist + schema: + type: object + properties: + conversation_id: + type: string + description: The ID of the conversation. + example: ext-123 + user_id: + type: string + description: The ID of the user. + example: user-456 + status: + type: string + enum: + - thinking + - awaiting_user_reply + - escalated + - resolved + - complete + description: | + Fin's current status in the conversation workflow. + example: thinking + created_at_ms: + type: string + format: date-time + description: The timestamp the response was created at, with millisecond precision. + example: '2025-01-24T10:00:00.123Z' + errors: + "$ref": "#/components/schemas/fin_agent_attribute_errors" + sse_subscription_url: + type: string + description: | + Optional. A URL to subscribe to Server-Sent Events (SSE) for this conversation, if SSE is enabled. The access token is a JWT with a 3-minute TTL. The token is revoked when Fin sets the conversation to awaiting_user_reply or complete status. + example: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...&rewind=2m' + '400': + description: Bad Request + content: + application/json: + examples: + Invalid request: + value: + type: error.list + request_id: b68959ea-6328-4f70-83cb-e7913dba1542 + errors: + - code: parameter_invalid + message: conversation_id is required + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b68959ea-6328-4f70-83cb-e7913dba1542 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + conversation_id: + type: string + description: The ID of the conversation that is calling Fin via this API. + example: ext-123 + message: + "$ref": "#/components/schemas/fin_agent_message" + user: + "$ref": "#/components/schemas/fin_agent_user" + attachments: + type: array + description: An array of attachments to include with the message. Maximum of 10 attachments. + maxItems: 10 + items: + "$ref": "#/components/schemas/fin_agent_attachment" + conversation_metadata: + "$ref": "#/components/schemas/fin_agent_conversation_metadata" + required: + - conversation_id + - message + - user + examples: + Basic request: + value: + conversation_id: ext-123 + message: + author: user + body: How can I see my account details? + timestamp: '2025-01-24T10:01:20.000Z' + user: + id: '123456' + name: John Doe + email: john.doe@example.com + Request with conversation history: + value: + conversation_id: ext-123 + message: + author: user + body: How can I see my account details? + timestamp: '2025-01-24T10:01:20.000Z' + user: + id: '123456' + name: John Doe + email: john.doe@example.com + attributes: + plan_type: Pro + subscription_status: active + conversation_metadata: + history: + - author: user + body: I need help + timestamp: '2025-01-24T10:00:01Z' + - author: agent + body: What do you need help with? + timestamp: '2025-01-24T10:01:00Z' + attributes: + priority_level: high + department: sales + Request with attachments: + value: + conversation_id: ext-123 + message: + author: user + body: Here is a screenshot of the issue + timestamp: '2025-01-24T10:01:20.000Z' + user: + id: '123456' + name: John Doe + email: john.doe@example.com + attachments: + - type: url + url: https://example.com/document.pdf + - type: file + name: screenshot.png + content_type: image/png + data: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk... + "/fin/reply": + post: + summary: Reply to Fin + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Fin Agent + operationId: replyToFin + description: | + Once Fin has returned a response to a user's message, its status will be `awaiting_user_reply`. + + If a user replies, use this endpoint to send this response to Fin. + + {% admonition type="warning" %} + Please reach out to your accounts team to discuss access. + {% /admonition %} + responses: + '200': + description: Reply sent successfully + content: + application/json: + examples: + Successful response: + value: + conversation_id: ext-123 + user_id: user-456 + status: thinking + created_at_ms: '2025-01-24T10:00:00.123Z' + sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...' + Response with attribute errors: + value: + conversation_id: ext-123 + user_id: user-456 + status: thinking + created_at_ms: '2025-01-24T10:00:00.123Z' + sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...' + errors: + user: + attributes: + invalid_attr: User attribute 'invalid_attr' does not exist + schema: + type: object + properties: + conversation_id: + type: string + description: The ID of the conversation. + example: ext-123 + user_id: + type: string + description: The ID of the user. + example: user-456 + status: + type: string + enum: + - thinking + - awaiting_user_reply + - escalated + - resolved + - complete + description: | + Fin's current status in the conversation workflow. + example: thinking + created_at_ms: + type: string + format: date-time + description: The timestamp the response was created at, with millisecond precision. + example: '2025-01-24T10:00:00.123Z' + errors: + "$ref": "#/components/schemas/fin_agent_attribute_errors" + sse_subscription_url: + type: string + description: | + Optional. A URL to subscribe to Server-Sent Events (SSE) for this conversation, if SSE is enabled. The access token is a JWT with a 3-minute TTL. The token is revoked when Fin sets the conversation to awaiting_user_reply or complete status. + example: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...' + '400': + description: Bad Request + content: + application/json: + examples: + Invalid request: + value: + type: error.list + request_id: b68959ea-6328-4f70-83cb-e7913dba1542 + errors: + - code: parameter_invalid + message: conversation_id is required + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b68959ea-6328-4f70-83cb-e7913dba1542 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + conversation_id: + type: string + description: The ID of the conversation. + example: '123456' + message: + "$ref": "#/components/schemas/fin_agent_message" + user: + "$ref": "#/components/schemas/fin_agent_user" + attachments: + type: array + description: An array of attachments to include with the message. Maximum of 10 attachments. + maxItems: 10 + items: + "$ref": "#/components/schemas/fin_agent_attachment" + required: + - conversation_id + - message + - user + examples: + Basic reply: + value: + conversation_id: '123456' + message: + author: user + body: Here's the information you requested. + timestamp: '2025-01-24T09:01:00.000Z' + user: + id: '123456' + name: John Doe + email: john.doe@example.com + Reply with attachments: + value: + conversation_id: '123456' + message: + author: user + body: Here's the invoice you asked for. + timestamp: '2025-01-24T09:01:00.000Z' + user: + id: '123456' + name: John Doe + email: john.doe@example.com + attachments: + - type: url + url: https://example.com/invoice.pdf "/help_center/collections": get: summary: List all collections @@ -19598,6 +19948,359 @@ components: description: An array of External Page objects items: "$ref": "#/components/schemas/external_page" + fin_agent_message: + title: Fin Agent Message + type: object + description: A message exchanged within a Fin Agent conversation. + x-tags: + - Fin Agent + properties: + author: + type: string + enum: + - user + - agent + - fin + description: The author that created the message. + example: user + body: + type: string + description: | + The body of the message. Accepts both plain text and HTML format. + When sending a message to Fin, this should contain the user's message. + Fin's response will be returned as HTML. + example: How can I see my account details? + timestamp: + type: string + format: date-time + description: | + The timestamp when the message was created. + Used to deduplicate messages sent within a 5 minute window. + Ideally should include milliseconds for higher precision. + example: '2025-01-24T10:01:20.000Z' + timestamp_ms: + type: string + format: date-time + description: | + The timestamp when the message was created, with millisecond precision. + Only present in webhook event responses (fin_replied). + example: '2025-01-24T10:01:20.456Z' + required: + - author + - body + - timestamp + fin_agent_user: + title: Fin Agent User + type: object + description: A user object representing the user in a Fin Agent conversation. + x-tags: + - Fin Agent + properties: + id: + type: string + description: | + The ID of the user. This value will be used to uniquely identify the user + during a conversation with Fin. Maps to the user_id field on the Intercom User object. + example: '123456' + name: + type: string + description: The name of the user. + example: John Doe + email: + type: string + format: email + description: The email of the user. + example: john.doe@example.com + attributes: + type: object + description: | + A hash of attributes associated with the user. + Attributes can be used by Fin to target content and responses. + Limit to 10 attributes. + additionalProperties: true + example: + plan_type: Pro + subscription_status: active + required: + - id + fin_agent_attachment: + title: Fin Agent Attachment + type: object + description: | + An attachment object representing a file or URL attachment included with a message. + Attachments can be used to provide additional context to Fin. + Maximum of 10 attachments per request. + x-tags: + - Fin Agent + properties: + type: + type: string + enum: + - url + - file + description: The type of attachment. + example: url + url: + type: string + format: uri + description: The URL of the attachment. Required when type is 'url'. Must be publicly accessible. + example: https://example.com/document.pdf + name: + type: string + description: The name of the file. Required when type is 'file'. + example: screenshot.png + content_type: + type: string + description: The MIME type of the file. Required when type is 'file'. + example: image/png + data: + type: string + format: byte + description: Base64-encoded file data. Required when type is 'file'. + example: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk... + required: + - type + fin_agent_conversation_metadata: + title: Fin Agent Conversation Metadata + type: object + description: Metadata about the conversation, including history and attributes. + x-tags: + - Fin Agent + properties: + history: + type: array + description: | + An array of previous messages in the conversation before Fin is initialized. + This data provides context to Fin and helps generate a better answer. + Limit to the last 10 messages. + maxItems: 10 + items: + "$ref": "#/components/schemas/fin_agent_message" + attributes: + type: object + description: | + A hash of attributes associated with the conversation. + These attributes can be used by Fin to provide more contextual responses. + Limit to 10 attributes. + additionalProperties: true + example: + priority_level: high + department: sales + fin_agent_attribute_errors: + title: Fin Agent Attribute Errors + type: object + description: Contains error details if any user or conversation attribute updates failed. + x-tags: + - Fin Agent + properties: + user: + type: object + description: User-related attribute errors. + properties: + attributes: + type: object + description: Map of user attribute names to error messages. + additionalProperties: + type: string + example: + invalid_attr: User attribute 'invalid_attr' does not exist + conversation: + type: object + description: Conversation-related attribute errors. + properties: + attributes: + type: object + description: Map of conversation attribute names to error messages. + additionalProperties: + type: string + example: + bad_attr: Conversation attribute 'bad_attr' does not exist + fin_agent_status_updated_event: + title: Fin Agent Status Updated Event + type: object + description: | + Event fired when Fin's status changes during a conversation. + Delivered via webhooks or SSE. Fin will report its status to the client via this event. + x-tags: + - Fin Agent + properties: + event_name: + type: string + enum: + - fin_status_updated + description: The name of the event. + example: fin_status_updated + conversation_id: + type: string + description: The ID of the conversation. + example: '123456' + user_id: + type: string + description: The ID of the user. + example: '7891' + status: + type: string + enum: + - escalated + - resolved + - complete + description: | + Fin's current status. + - escalated: The conversation has been escalated to a human + - resolved: The user's query has been resolved + - complete: Fin has completed its workflow + example: escalated + reason: + type: string + description: | + Optional. A human-readable explanation of why the conversation was escalated. + Only present when status is 'escalated'. + Possible values include: + - "Escalation requested by user" + - "Escalation rule: {rule_name}" + - "Escalation rule matched" + - "Routed to team" + - "Conversation finished without resolution" + example: Escalation requested by user + created_at_ms: + type: string + format: date-time + description: The timestamp the event was created at, with millisecond precision. + example: '2025-01-24T10:00:00.123Z' + required: + - event_name + - conversation_id + - user_id + - status + - created_at_ms + fin_agent_replied_event: + title: Fin Agent Replied Event + type: object + description: | + Event fired when Fin replies to a user. + Delivered via webhooks or SSE. The content of the response will be contained in the message object. + Fin's status will update to 'awaiting_user_reply'. + x-tags: + - Fin Agent + properties: + event_name: + type: string + enum: + - fin_replied + description: The name of the event. + example: fin_replied + conversation_id: + type: string + description: The ID of the conversation. + example: '123456' + user_id: + type: string + description: The ID of the user. + example: '7891' + message: + type: object + description: Fin's answer to the user's query. + properties: + author: + type: string + enum: + - fin + description: The author of the message (always 'fin' for this event). + example: fin + body: + type: string + description: The HTML body of Fin's response. + example:

You can see your account details by clicking on the Account tab in the top right corner of the screen.

+ timestamp_ms: + type: string + format: date-time + description: The timestamp the message was created at, with millisecond precision. + example: '2025-01-24T09:01:00.456Z' + required: + - author + - body + - timestamp_ms + status: + type: string + enum: + - awaiting_user_reply + description: Fin's current status (always 'awaiting_user_reply' for this event). + example: awaiting_user_reply + stream_id: + type: string + description: | + Optional. Present when the reply was generated via streaming. + Correlates this event with the fin_reply_chunk events that preceded it. + Use this to know when to replace streamed chunk_text with the final message body. + example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 + created_at_ms: + type: string + format: date-time + description: The timestamp the event was created at, with millisecond precision. + example: '2025-01-24T10:00:00.123Z' + required: + - event_name + - conversation_id + - user_id + - message + - status + - created_at_ms + fin_agent_reply_chunk_event: + title: Fin Agent Reply Chunk Event + type: object + description: | + SSE-only event fired during streaming reply generation. + Each chunk contains the full accumulated plain text of Fin's answer so far (cumulative, not a delta). + Only delivered over SSE when streaming is enabled. Not available via webhooks. + When the fin_replied event arrives with the same stream_id, replace streamed text with the final HTML body. + x-tags: + - Fin Agent + properties: + event_name: + type: string + enum: + - fin_reply_chunk + description: The name of the event. + example: fin_reply_chunk + conversation_id: + type: string + description: The ID of the conversation. + example: '123456' + stream_id: + type: string + description: | + A unique identifier for this streaming response. + Correlates chunks with each other and with the eventual fin_replied event. + example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 + chunk_index: + type: integer + description: | + 0-based counter for this chunk within the stream. Contiguous. + example: 3 + chunk_text: + type: string + description: | + The full accumulated plain text of Fin's answer so far. + Each chunk supersedes the previous — replace rather than append. + example: You can see your account details by clicking + status: + type: string + enum: + - awaiting_user_reply + description: Fin's current status (always 'awaiting_user_reply' for this event). + example: awaiting_user_reply + created_at_ms: + type: string + format: date-time + description: The timestamp the event was created at, with millisecond precision. + example: '2025-01-24T10:00:00.123Z' + required: + - event_name + - conversation_id + - stream_id + - chunk_index + - chunk_text + - created_at_ms file_attribute: title: File type: object @@ -22753,6 +23456,31 @@ tags: description: Everything about your Data Events - name: Data Export description: Everything about your Data Exports +- name: Fin Agent + description: | + Access Fin programmatically via the Fin Agent API endpoints. + +   + + {% admonition type="warning" %} + Please reach out to your accounts team to discuss access and tailored, hands-on support. + {% /admonition %} + +   + + Integration is centered around two endpoints (`/fin/start` and `/fin/reply`) and a set of events that notify your application of Fin's status and responses. Events can be delivered via webhooks or Server-Sent Events (SSE). + +   + + **Events** + + Configure a webhook endpoint in the Fin Agent API settings to receive events, or use the `sse_subscription_url` from the API response to subscribe via SSE. See the [setup guide](/docs/guides/fin-agent-api/setup) for configuration details. + + - `fin_status_updated` - Fired when Fin's status changes (escalated, resolved, complete) + - `fin_replied` - Fired when Fin sends a reply to the user + - `fin_reply_chunk` - SSE-only streaming event fired during reply generation (requires streaming enabled) + + All webhook requests include an `X-Fin-Agent-API-Webhook-Signature` header for request validation. - name: Help Center description: Everything about your Help Center - name: Internal Articles diff --git a/descriptions/2.15/api.intercom.io.yaml b/descriptions/2.15/api.intercom.io.yaml index b49a8ec..e6b8820 100644 --- a/descriptions/2.15/api.intercom.io.yaml +++ b/descriptions/2.15/api.intercom.io.yaml @@ -1803,6 +1803,356 @@ paths: message: "Export job not found for identifier: job1" schema: "$ref": "#/components/schemas/error" + "/fin/start": + post: + summary: Start a conversation with Fin + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Fin Agent + operationId: startFinConversation + description: | + Initialize Fin by passing it the user's message along with conversation history and user details. + + These additional pieces of context will be used by Fin to provide a better and more contextual answer to the user. + + {% admonition type="warning" %} + Please reach out to your accounts team to discuss access. + {% /admonition %} + + Once Fin is initialized, it progresses through a series of statuses such as *thinking*, *awaiting_user_reply*, or *resolved* before ending with a status of *complete*. + + During this workflow, the client should allow Fin to continue uninterrupted until a final *complete* status is returned via webhook, at which point control of the conversation passes back to the client. + responses: + '200': + description: Fin conversation started successfully + content: + application/json: + examples: + Successful response: + value: + conversation_id: ext-123 + user_id: user-456 + status: thinking + created_at_ms: '2025-01-24T10:00:00.123Z' + sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...&rewind=2m' + Response with attribute errors: + value: + conversation_id: ext-123 + user_id: user-456 + status: thinking + created_at_ms: '2025-01-24T10:00:00.123Z' + sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...&rewind=2m' + errors: + user: + attributes: + invalid_attr: User attribute 'invalid_attr' does not exist + conversation: + attributes: + bad_attr: Conversation attribute 'bad_attr' does not exist + schema: + type: object + properties: + conversation_id: + type: string + description: The ID of the conversation. + example: ext-123 + user_id: + type: string + description: The ID of the user. + example: user-456 + status: + type: string + enum: + - thinking + - awaiting_user_reply + - escalated + - resolved + - complete + description: | + Fin's current status in the conversation workflow. + example: thinking + created_at_ms: + type: string + format: date-time + description: The timestamp the response was created at, with millisecond precision. + example: '2025-01-24T10:00:00.123Z' + errors: + "$ref": "#/components/schemas/fin_agent_attribute_errors" + sse_subscription_url: + type: string + description: | + Optional. A URL to subscribe to Server-Sent Events (SSE) for this conversation, if SSE is enabled. The access token is a JWT with a 3-minute TTL. The token is revoked when Fin sets the conversation to awaiting_user_reply or complete status. + example: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...&rewind=2m' + '400': + description: Bad Request + content: + application/json: + examples: + Invalid request: + value: + type: error.list + request_id: b68959ea-6328-4f70-83cb-e7913dba1542 + errors: + - code: parameter_invalid + message: conversation_id is required + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b68959ea-6328-4f70-83cb-e7913dba1542 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + conversation_id: + type: string + description: The ID of the conversation that is calling Fin via this API. + example: ext-123 + message: + "$ref": "#/components/schemas/fin_agent_message" + user: + "$ref": "#/components/schemas/fin_agent_user" + attachments: + type: array + description: An array of attachments to include with the message. Maximum of 10 attachments. + maxItems: 10 + items: + "$ref": "#/components/schemas/fin_agent_attachment" + conversation_metadata: + "$ref": "#/components/schemas/fin_agent_conversation_metadata" + required: + - conversation_id + - message + - user + examples: + Basic request: + value: + conversation_id: ext-123 + message: + author: user + body: How can I see my account details? + timestamp: '2025-01-24T10:01:20.000Z' + user: + id: '123456' + name: John Doe + email: john.doe@example.com + Request with conversation history: + value: + conversation_id: ext-123 + message: + author: user + body: How can I see my account details? + timestamp: '2025-01-24T10:01:20.000Z' + user: + id: '123456' + name: John Doe + email: john.doe@example.com + attributes: + plan_type: Pro + subscription_status: active + conversation_metadata: + history: + - author: user + body: I need help + timestamp: '2025-01-24T10:00:01Z' + - author: agent + body: What do you need help with? + timestamp: '2025-01-24T10:01:00Z' + attributes: + priority_level: high + department: sales + Request with attachments: + value: + conversation_id: ext-123 + message: + author: user + body: Here is a screenshot of the issue + timestamp: '2025-01-24T10:01:20.000Z' + user: + id: '123456' + name: John Doe + email: john.doe@example.com + attachments: + - type: url + url: https://example.com/document.pdf + - type: file + name: screenshot.png + content_type: image/png + data: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk... + "/fin/reply": + post: + summary: Reply to Fin + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Fin Agent + operationId: replyToFin + description: | + Once Fin has returned a response to a user's message, its status will be `awaiting_user_reply`. + + If a user replies, use this endpoint to send this response to Fin. + + {% admonition type="warning" %} + Please reach out to your accounts team to discuss access. + {% /admonition %} + responses: + '200': + description: Reply sent successfully + content: + application/json: + examples: + Successful response: + value: + conversation_id: ext-123 + user_id: user-456 + status: thinking + created_at_ms: '2025-01-24T10:00:00.123Z' + sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...' + Response with attribute errors: + value: + conversation_id: ext-123 + user_id: user-456 + status: thinking + created_at_ms: '2025-01-24T10:00:00.123Z' + sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...' + errors: + user: + attributes: + invalid_attr: User attribute 'invalid_attr' does not exist + schema: + type: object + properties: + conversation_id: + type: string + description: The ID of the conversation. + example: ext-123 + user_id: + type: string + description: The ID of the user. + example: user-456 + status: + type: string + enum: + - thinking + - awaiting_user_reply + - escalated + - resolved + - complete + description: | + Fin's current status in the conversation workflow. + example: thinking + created_at_ms: + type: string + format: date-time + description: The timestamp the response was created at, with millisecond precision. + example: '2025-01-24T10:00:00.123Z' + errors: + "$ref": "#/components/schemas/fin_agent_attribute_errors" + sse_subscription_url: + type: string + description: | + Optional. A URL to subscribe to Server-Sent Events (SSE) for this conversation, if SSE is enabled. The access token is a JWT with a 3-minute TTL. The token is revoked when Fin sets the conversation to awaiting_user_reply or complete status. + example: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...' + '400': + description: Bad Request + content: + application/json: + examples: + Invalid request: + value: + type: error.list + request_id: b68959ea-6328-4f70-83cb-e7913dba1542 + errors: + - code: parameter_invalid + message: conversation_id is required + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b68959ea-6328-4f70-83cb-e7913dba1542 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + conversation_id: + type: string + description: The ID of the conversation. + example: '123456' + message: + "$ref": "#/components/schemas/fin_agent_message" + user: + "$ref": "#/components/schemas/fin_agent_user" + attachments: + type: array + description: An array of attachments to include with the message. Maximum of 10 attachments. + maxItems: 10 + items: + "$ref": "#/components/schemas/fin_agent_attachment" + required: + - conversation_id + - message + - user + examples: + Basic reply: + value: + conversation_id: '123456' + message: + author: user + body: Here's the information you requested. + timestamp: '2025-01-24T09:01:00.000Z' + user: + id: '123456' + name: John Doe + email: john.doe@example.com + Reply with attachments: + value: + conversation_id: '123456' + message: + author: user + body: Here's the invoice you asked for. + timestamp: '2025-01-24T09:01:00.000Z' + user: + id: '123456' + name: John Doe + email: john.doe@example.com + attachments: + - type: url + url: https://example.com/invoice.pdf "/help_center/collections": get: summary: List all collections @@ -20426,6 +20776,359 @@ components: description: An array of External Page objects items: "$ref": "#/components/schemas/external_page" + fin_agent_message: + title: Fin Agent Message + type: object + description: A message exchanged within a Fin Agent conversation. + x-tags: + - Fin Agent + properties: + author: + type: string + enum: + - user + - agent + - fin + description: The author that created the message. + example: user + body: + type: string + description: | + The body of the message. Accepts both plain text and HTML format. + When sending a message to Fin, this should contain the user's message. + Fin's response will be returned as HTML. + example: How can I see my account details? + timestamp: + type: string + format: date-time + description: | + The timestamp when the message was created. + Used to deduplicate messages sent within a 5 minute window. + Ideally should include milliseconds for higher precision. + example: '2025-01-24T10:01:20.000Z' + timestamp_ms: + type: string + format: date-time + description: | + The timestamp when the message was created, with millisecond precision. + Only present in webhook event responses (fin_replied). + example: '2025-01-24T10:01:20.456Z' + required: + - author + - body + - timestamp + fin_agent_user: + title: Fin Agent User + type: object + description: A user object representing the user in a Fin Agent conversation. + x-tags: + - Fin Agent + properties: + id: + type: string + description: | + The ID of the user. This value will be used to uniquely identify the user + during a conversation with Fin. Maps to the user_id field on the Intercom User object. + example: '123456' + name: + type: string + description: The name of the user. + example: John Doe + email: + type: string + format: email + description: The email of the user. + example: john.doe@example.com + attributes: + type: object + description: | + A hash of attributes associated with the user. + Attributes can be used by Fin to target content and responses. + Limit to 10 attributes. + additionalProperties: true + example: + plan_type: Pro + subscription_status: active + required: + - id + fin_agent_attachment: + title: Fin Agent Attachment + type: object + description: | + An attachment object representing a file or URL attachment included with a message. + Attachments can be used to provide additional context to Fin. + Maximum of 10 attachments per request. + x-tags: + - Fin Agent + properties: + type: + type: string + enum: + - url + - file + description: The type of attachment. + example: url + url: + type: string + format: uri + description: The URL of the attachment. Required when type is 'url'. Must be publicly accessible. + example: https://example.com/document.pdf + name: + type: string + description: The name of the file. Required when type is 'file'. + example: screenshot.png + content_type: + type: string + description: The MIME type of the file. Required when type is 'file'. + example: image/png + data: + type: string + format: byte + description: Base64-encoded file data. Required when type is 'file'. + example: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk... + required: + - type + fin_agent_conversation_metadata: + title: Fin Agent Conversation Metadata + type: object + description: Metadata about the conversation, including history and attributes. + x-tags: + - Fin Agent + properties: + history: + type: array + description: | + An array of previous messages in the conversation before Fin is initialized. + This data provides context to Fin and helps generate a better answer. + Limit to the last 10 messages. + maxItems: 10 + items: + "$ref": "#/components/schemas/fin_agent_message" + attributes: + type: object + description: | + A hash of attributes associated with the conversation. + These attributes can be used by Fin to provide more contextual responses. + Limit to 10 attributes. + additionalProperties: true + example: + priority_level: high + department: sales + fin_agent_attribute_errors: + title: Fin Agent Attribute Errors + type: object + description: Contains error details if any user or conversation attribute updates failed. + x-tags: + - Fin Agent + properties: + user: + type: object + description: User-related attribute errors. + properties: + attributes: + type: object + description: Map of user attribute names to error messages. + additionalProperties: + type: string + example: + invalid_attr: User attribute 'invalid_attr' does not exist + conversation: + type: object + description: Conversation-related attribute errors. + properties: + attributes: + type: object + description: Map of conversation attribute names to error messages. + additionalProperties: + type: string + example: + bad_attr: Conversation attribute 'bad_attr' does not exist + fin_agent_status_updated_event: + title: Fin Agent Status Updated Event + type: object + description: | + Event fired when Fin's status changes during a conversation. + Delivered via webhooks or SSE. Fin will report its status to the client via this event. + x-tags: + - Fin Agent + properties: + event_name: + type: string + enum: + - fin_status_updated + description: The name of the event. + example: fin_status_updated + conversation_id: + type: string + description: The ID of the conversation. + example: '123456' + user_id: + type: string + description: The ID of the user. + example: '7891' + status: + type: string + enum: + - escalated + - resolved + - complete + description: | + Fin's current status. + - escalated: The conversation has been escalated to a human + - resolved: The user's query has been resolved + - complete: Fin has completed its workflow + example: escalated + reason: + type: string + description: | + Optional. A human-readable explanation of why the conversation was escalated. + Only present when status is 'escalated'. + Possible values include: + - "Escalation requested by user" + - "Escalation rule: {rule_name}" + - "Escalation rule matched" + - "Routed to team" + - "Conversation finished without resolution" + example: Escalation requested by user + created_at_ms: + type: string + format: date-time + description: The timestamp the event was created at, with millisecond precision. + example: '2025-01-24T10:00:00.123Z' + required: + - event_name + - conversation_id + - user_id + - status + - created_at_ms + fin_agent_replied_event: + title: Fin Agent Replied Event + type: object + description: | + Event fired when Fin replies to a user. + Delivered via webhooks or SSE. The content of the response will be contained in the message object. + Fin's status will update to 'awaiting_user_reply'. + x-tags: + - Fin Agent + properties: + event_name: + type: string + enum: + - fin_replied + description: The name of the event. + example: fin_replied + conversation_id: + type: string + description: The ID of the conversation. + example: '123456' + user_id: + type: string + description: The ID of the user. + example: '7891' + message: + type: object + description: Fin's answer to the user's query. + properties: + author: + type: string + enum: + - fin + description: The author of the message (always 'fin' for this event). + example: fin + body: + type: string + description: The HTML body of Fin's response. + example:

You can see your account details by clicking on the Account tab in the top right corner of the screen.

+ timestamp_ms: + type: string + format: date-time + description: The timestamp the message was created at, with millisecond precision. + example: '2025-01-24T09:01:00.456Z' + required: + - author + - body + - timestamp_ms + status: + type: string + enum: + - awaiting_user_reply + description: Fin's current status (always 'awaiting_user_reply' for this event). + example: awaiting_user_reply + stream_id: + type: string + description: | + Optional. Present when the reply was generated via streaming. + Correlates this event with the fin_reply_chunk events that preceded it. + Use this to know when to replace streamed chunk_text with the final message body. + example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 + created_at_ms: + type: string + format: date-time + description: The timestamp the event was created at, with millisecond precision. + example: '2025-01-24T10:00:00.123Z' + required: + - event_name + - conversation_id + - user_id + - message + - status + - created_at_ms + fin_agent_reply_chunk_event: + title: Fin Agent Reply Chunk Event + type: object + description: | + SSE-only event fired during streaming reply generation. + Each chunk contains the full accumulated plain text of Fin's answer so far (cumulative, not a delta). + Only delivered over SSE when streaming is enabled. Not available via webhooks. + When the fin_replied event arrives with the same stream_id, replace streamed text with the final HTML body. + x-tags: + - Fin Agent + properties: + event_name: + type: string + enum: + - fin_reply_chunk + description: The name of the event. + example: fin_reply_chunk + conversation_id: + type: string + description: The ID of the conversation. + example: '123456' + stream_id: + type: string + description: | + A unique identifier for this streaming response. + Correlates chunks with each other and with the eventual fin_replied event. + example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 + chunk_index: + type: integer + description: | + 0-based counter for this chunk within the stream. Contiguous. + example: 3 + chunk_text: + type: string + description: | + The full accumulated plain text of Fin's answer so far. + Each chunk supersedes the previous — replace rather than append. + example: You can see your account details by clicking + status: + type: string + enum: + - awaiting_user_reply + description: Fin's current status (always 'awaiting_user_reply' for this event). + example: awaiting_user_reply + created_at_ms: + type: string + format: date-time + description: The timestamp the event was created at, with millisecond precision. + example: '2025-01-24T10:00:00.123Z' + required: + - event_name + - conversation_id + - stream_id + - chunk_index + - chunk_text + - created_at_ms file_attribute: title: File type: object @@ -23703,6 +24406,31 @@ tags: description: Everything about your Data Exports - name: Emails description: Everything about your Email Settings +- name: Fin Agent + description: | + Access Fin programmatically via the Fin Agent API endpoints. + +   + + {% admonition type="warning" %} + Please reach out to your accounts team to discuss access and tailored, hands-on support. + {% /admonition %} + +   + + Integration is centered around two endpoints (`/fin/start` and `/fin/reply`) and a set of events that notify your application of Fin's status and responses. Events can be delivered via webhooks or Server-Sent Events (SSE). + +   + + **Events** + + Configure a webhook endpoint in the Fin Agent API settings to receive events, or use the `sse_subscription_url` from the API response to subscribe via SSE. See the [setup guide](/docs/guides/fin-agent-api/setup) for configuration details. + + - `fin_status_updated` - Fired when Fin's status changes (escalated, resolved, complete) + - `fin_replied` - Fired when Fin sends a reply to the user + - `fin_reply_chunk` - SSE-only streaming event fired during reply generation (requires streaming enabled) + + All webhook requests include an `X-Fin-Agent-API-Webhook-Signature` header for request validation. - name: Help Center description: Everything about your Help Center - name: Internal Articles diff --git a/postman/2.14/README.md b/postman/2.14/README.md index f7ab163..a37c19a 100644 --- a/postman/2.14/README.md +++ b/postman/2.14/README.md @@ -12,4 +12,4 @@ This directory contains the Postman collection for Intercom API version 2.14. 3. Set your access token in the environment variables 4. Start making API calls! -Last updated: 2025-08-27T09:13:42.538Z +Last updated: 2026-04-16T09:25:37.595Z diff --git a/postman/2.14/intercom-api.postman_collection.json b/postman/2.14/intercom-api.postman_collection.json index 411581e..a48fc48 100644 --- a/postman/2.14/intercom-api.postman_collection.json +++ b/postman/2.14/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-08-27T09:13:42.535Z" + "updatedAt": "2026-04-16T09:25:37.594Z" }, "item": [ { @@ -76,7 +76,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/ai/content_import_sources/{id}", + "raw": "https://api.intercom.io/ai/content_import_sources/{source_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -84,7 +84,7 @@ "path": [ "ai", "content_import_sources", - "{id}" + "{source_id}" ], "query": [], "variable": [] @@ -186,7 +186,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/ai/external_pages/{id}", + "raw": "https://api.intercom.io/ai/external_pages/{page_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -194,7 +194,7 @@ "path": [ "ai", "external_pages", - "{id}" + "{page_id}" ], "query": [], "variable": [] @@ -370,7 +370,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/ai/content_import_sources/{id}", + "raw": "https://api.intercom.io/ai/content_import_sources/{source_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -378,7 +378,7 @@ "path": [ "ai", "content_import_sources", - "{id}" + "{source_id}" ], "query": [], "variable": [] @@ -435,7 +435,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/ai/external_pages/{id}", + "raw": "https://api.intercom.io/ai/external_pages/{page_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -443,7 +443,7 @@ "path": [ "ai", "external_pages", - "{id}" + "{page_id}" ], "query": [], "variable": [] @@ -500,7 +500,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/ai/content_import_sources/{id}", + "raw": "https://api.intercom.io/ai/content_import_sources/{source_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -508,7 +508,7 @@ "path": [ "ai", "content_import_sources", - "{id}" + "{source_id}" ], "query": [], "variable": [] @@ -556,7 +556,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/ai/external_pages/{id}", + "raw": "https://api.intercom.io/ai/external_pages/{page_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -564,7 +564,7 @@ "path": [ "ai", "external_pages", - "{id}" + "{page_id}" ], "query": [], "variable": [] @@ -745,7 +745,13 @@ "path": [ "admins" ], - "query": [], + "query": [ + { + "key": "display_avatar", + "value": "true", + "description": "If set to true, the response will include the admin's avatar object containing the image URL. Defaults to false." + } + ], "variable": [] }, "auth": { @@ -791,19 +797,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/admins/{id}", + "raw": "https://api.intercom.io/admins/{admin_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "admins", - "{id}" + "{admin_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "admin_id", "value": "123", "disabled": false, "description": "The unique identifier of a given admin" @@ -853,21 +859,21 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/admins/{id}/away", + "raw": "https://api.intercom.io/admins/{admin_id}/away", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "admins", - "{id}", + "{admin_id}", "away" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "admin_id", + "value": "admin_id", "disabled": false, "description": "The unique identifier of a given admin" } @@ -984,19 +990,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/articles/{id}", + "raw": "https://api.intercom.io/articles/{article_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "articles", - "{id}" + "{article_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "article_id", "value": "123", "disabled": false, "description": "The unique identifier for the article which is given by Intercom." @@ -1154,7 +1160,7 @@ ] }, "method": "POST", - "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", + "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.\n\n> 📘 Tags cannot be managed via the Articles API\n>\n> Article tags are read-only in responses. To create, update, or delete tags, use the Intercom UI or the Tags API endpoints.\n", "header": [ { "key": "Intercom-Version", @@ -1185,19 +1191,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/articles/{id}", + "raw": "https://api.intercom.io/articles/{article_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "articles", - "{id}" + "{article_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "article_id", "value": "123", "disabled": false, "description": "The unique identifier for the article which is given by Intercom." @@ -1225,7 +1231,7 @@ ] }, "method": "PUT", - "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", + "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.\n\n> 📘 Tags cannot be managed via the Articles API\n>\n> Article tags are read-only in responses. To create, update, or delete tags, use the Intercom UI or the Tags API endpoints.\n", "header": [ { "key": "Intercom-Version", @@ -1256,19 +1262,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/articles/{id}", + "raw": "https://api.intercom.io/articles/{article_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "articles", - "{id}" + "{article_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "article_id", "value": "123", "disabled": false, "description": "The unique identifier for the article which is given by Intercom." @@ -1467,19 +1473,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{id}", + "raw": "https://api.intercom.io/companies/{company_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "companies", - "{id}" + "{company_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "company_id", "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", "disabled": false, "description": "The unique identifier for the company which is given by Intercom" @@ -1530,20 +1536,20 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{id}/contacts", + "raw": "https://api.intercom.io/companies/{company_id}/contacts", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "companies", - "{id}", + "{company_id}", "contacts" ], "query": [], "variable": [ { - "key": "id", + "key": "company_id", "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", "disabled": false, "description": "The unique identifier for the company which is given by Intercom" @@ -1593,20 +1599,20 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{id}/segments", + "raw": "https://api.intercom.io/companies/{company_id}/segments", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "companies", - "{id}", + "{company_id}", "segments" ], "query": [], "variable": [ { - "key": "id", + "key": "company_id", "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", "disabled": false, "description": "The unique identifier for the company which is given by Intercom" @@ -1852,21 +1858,21 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/companies", + "raw": "https://api.intercom.io/contacts/{contact_id}/companies", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "contacts", - "{id}", + "{contact_id}", "companies" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "contact_id", + "value": "contact_id", "disabled": false, "description": "The unique identifier for the contact which is given by Intercom" } @@ -1924,19 +1930,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{id}", + "raw": "https://api.intercom.io/companies/{company_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "companies", - "{id}" + "{company_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "company_id", "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", "disabled": false, "description": "The unique identifier for the company which is given by Intercom" @@ -1970,12 +1976,21 @@ "key": "Intercom-Version", "value": "2.14" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Intercom\",\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 \"monthly_spend\": 1000\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, @@ -1986,19 +2001,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{id}", + "raw": "https://api.intercom.io/companies/{company_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "companies", - "{id}" + "{company_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "company_id", "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", "disabled": false, "description": "The unique identifier for the company which is given by Intercom" @@ -2049,7 +2064,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{contact_id}/companies/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/companies/{company_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -2058,7 +2073,7 @@ "contacts", "{contact_id}", "companies", - "{id}" + "{company_id}" ], "query": [], "variable": [ @@ -2069,7 +2084,7 @@ "description": "The unique identifier for the contact which is given by Intercom" }, { - "key": "id", + "key": "company_id", "value": "58a430d35458202d41b1e65b", "disabled": false, "description": "The unique identifier for the company which is given by Intercom" @@ -2125,20 +2140,20 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/companies", + "raw": "https://api.intercom.io/contacts/{contact_id}/companies", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "contacts", - "{id}", + "{contact_id}", "companies" ], "query": [], "variable": [ { - "key": "id", + "key": "contact_id", "value": "63a07ddf05a32042dffac965", "disabled": false, "description": "The unique identifier for the contact which is given by Intercom" @@ -2380,22 +2395,22 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "contacts", - "{id}" + "{contact_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "contact_id", "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "id" + "description": "contact_id" } ] }, @@ -2736,7 +2751,7 @@ ], "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}", + "raw": "{\n \"role\": \"user\",\n \"external_id\": \"625e90fc55ab113b6d92175f\",\n \"email\": \"jdoe@example.com\",\n \"phone\": \"+353871234567\",\n \"name\": \"John Doe\",\n \"avatar\": \"https://www.example.com/avatar_image.jpg\",\n \"signed_up_at\": 1571672154,\n \"last_seen_at\": 1571672154,\n \"owner_id\": 123,\n \"unsubscribed_from_emails\": true,\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 1\n }\n}", "urlencoded": [], "formdata": [] } @@ -2750,23 +2765,23 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/archive", + "raw": "https://api.intercom.io/contacts/{contact_id}/archive", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "contacts", - "{id}", + "{contact_id}", "archive" ], "query": [], "variable": [ { - "key": "id", + "key": "contact_id", "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "id" + "description": "contact_id" } ] }, @@ -2813,23 +2828,23 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/unarchive", + "raw": "https://api.intercom.io/contacts/{contact_id}/unarchive", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "contacts", - "{id}", + "{contact_id}", "unarchive" ], "query": [], "variable": [ { - "key": "id", + "key": "contact_id", "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "id" + "description": "contact_id" } ] }, @@ -2876,23 +2891,23 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/block", + "raw": "https://api.intercom.io/contacts/{contact_id}/block", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "contacts", - "{id}", + "{contact_id}", "block" ], "query": [], "variable": [ { - "key": "id", + "key": "contact_id", "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "id" + "description": "contact_id" } ] }, @@ -2940,19 +2955,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "contacts", - "{id}" + "{contact_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "contact_id", "value": "63a07ddf05a32042dffac965", "disabled": false, "description": "id" @@ -3011,22 +3026,22 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "contacts", - "{id}" + "{contact_id}" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "contact_id", + "value": "contact_id", "disabled": false, - "description": "id" + "description": "contact_id" } ] }, @@ -3143,14 +3158,14 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "conversations", - "{id}" + "{conversation_id}" ], "query": [ { @@ -3166,7 +3181,7 @@ ], "variable": [ { - "key": "id", + "key": "conversation_id", "value": "123", "disabled": false, "description": "The id of the conversation to target" @@ -3265,7 +3280,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"from\": {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n \"body\": \"Hello\",\n \"created_at\": 1671028894\n}", + "raw": "{\n \"from\": {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n \"body\": \"Hello\",\n \"subject\": \"Thanks for everything\",\n \"attachment_urls\": \"\",\n \"created_at\": 1671028894\n}", "urlencoded": [], "formdata": [] } @@ -3343,20 +3358,20 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}/reply", + "raw": "https://api.intercom.io/conversations/{conversation_id}/reply", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "conversations", - "{id}", + "{conversation_id}", "reply" ], "query": [], "variable": [ { - "key": "id", + "key": "conversation_id", "value": "123 or \"last\"", "disabled": false, "description": "The Intercom provisioned identifier for the conversation or the string \"last\" to reply to the last part of the conversation" @@ -3415,20 +3430,20 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}/parts", + "raw": "https://api.intercom.io/conversations/{conversation_id}/parts", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "conversations", - "{id}", + "{conversation_id}", "parts" ], "query": [], "variable": [ { - "key": "id", + "key": "conversation_id", "value": "123", "disabled": false, "description": "The identifier for the conversation as given by Intercom." @@ -3487,20 +3502,20 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}/customers", + "raw": "https://api.intercom.io/conversations/{conversation_id}/customers", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "conversations", - "{id}", + "{conversation_id}", "customers" ], "query": [], "variable": [ { - "key": "id", + "key": "conversation_id", "value": "123", "disabled": false, "description": "The identifier for the conversation as given by Intercom." @@ -3623,20 +3638,20 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}/convert", + "raw": "https://api.intercom.io/conversations/{conversation_id}/convert", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "conversations", - "{id}", + "{conversation_id}", "convert" ], "query": [], "variable": [ { - "key": "id", + "key": "conversation_id", "value": "123", "disabled": false, "description": "The id of the conversation to target" @@ -3696,14 +3711,14 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "conversations", - "{id}" + "{conversation_id}" ], "query": [ { @@ -3714,7 +3729,7 @@ ], "variable": [ { - "key": "id", + "key": "conversation_id", "value": "123", "disabled": false, "description": "The id of the conversation to target" @@ -3759,7 +3774,7 @@ ], "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}", + "raw": "{\n \"read\": true,\n \"title\": \"Conversation Title\",\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 9,\n \"start_date_iso8601\": \"2023-03-04T09:46:14Z\",\n \"end_date_timestamp\": 1677923174,\n \"CX Score rating\": 4,\n \"CX Score explanation\": \"The conversation was resolved quickly and the customer expressed satisfaction with the outcome.\"\n },\n \"company_id\": \"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632\"\n}", "urlencoded": [], "formdata": [] } @@ -3773,20 +3788,20 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "conversations", - "{id}" + "{conversation_id}" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "conversation_id", + "value": "conversation_id", "disabled": false, "description": "id" } @@ -3813,7 +3828,7 @@ ] }, "method": "DELETE", - "description": "You can delete a single conversation.", + "description": "{% admonition type=\"warning\" name=\"Irreversible operation\" %}\nDeleting a conversation is permanent and cannot be reversed.\n{% /admonition %}\n\nDeleting a conversation permanently removes it from the inbox. All sensitive data is deleted, including admin and user replies, conversation attributes, uploads, and related content. The conversation will still appear in reporting, though some data may be incomplete due to the deletion.\n", "header": [ { "key": "Intercom-Version", @@ -4224,7 +4239,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -4232,13 +4247,13 @@ "path": [ "custom_object_instances", "{custom_object_type_identifier}", - "{id}" + "{custom_object_instance_id}" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "custom_object_instance_id", + "value": "custom_object_instance_id", "disabled": false, "description": "The id or external_id of the custom object instance" } @@ -4411,7 +4426,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -4419,13 +4434,13 @@ "path": [ "custom_object_instances", "{custom_object_type_identifier}", - "{id}" + "{custom_object_instance_id}" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "custom_object_instance_id", + "value": "custom_object_instance_id", "disabled": false, "description": "The Intercom defined id of the custom object instance" } @@ -4607,19 +4622,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/data_attributes/{id}", + "raw": "https://api.intercom.io/data_attributes/{data_attribute_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "data_attributes", - "{id}" + "{data_attribute_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "data_attribute_id", "value": "1", "disabled": false, "description": "The data attribute id" @@ -5135,6 +5150,139 @@ } ] }, + { + "name": "Fin Agent", + "item": [ + { + "name": "Start a conversation with Fin", + "tags": [ + "Fin Agent" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin/start", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin", + "start" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Initialize Fin by passing it the user's message along with conversation history and user details.\n\nThese additional pieces of context will be used by Fin to provide a better and more contextual answer to the user.\n\n{% admonition type=\"warning\" %}\nPlease reach out to your accounts team to discuss access.\n{% /admonition %}\n\nOnce Fin is initialized, it progresses through a series of statuses such as *thinking*, *awaiting_user_reply*, or *resolved* before ending with a status of *complete*.\n\nDuring this workflow, the client should allow Fin to continue uninterrupted until a final *complete* status is returned via webhook, at which point control of the conversation passes back to the client.\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_id\": \"ext-123\",\n \"message\": {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n },\n \"user\": {\n \"id\": \"123456\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"attributes\": {\n \"plan_type\": \"Pro\",\n \"subscription_status\": \"active\"\n }\n },\n \"attachments\": [\n {\n \"type\": \"url\",\n \"url\": \"https://example.com/document.pdf\",\n \"name\": \"screenshot.png\",\n \"content_type\": \"image/png\",\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk...\"\n }\n ],\n \"conversation_metadata\": {\n \"history\": [\n {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n }\n ],\n \"attributes\": {\n \"priority_level\": \"high\",\n \"department\": \"sales\"\n }\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Reply to Fin", + "tags": [ + "Fin Agent" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin", + "reply" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Once Fin has returned a response to a user's message, its status will be `awaiting_user_reply`.\n\nIf a user replies, use this endpoint to send this response to Fin.\n\n{% admonition type=\"warning\" %}\nPlease reach out to your accounts team to discuss access.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"conversation_id\": \"123456\",\n \"message\": {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n },\n \"user\": {\n \"id\": \"123456\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"attributes\": {\n \"plan_type\": \"Pro\",\n \"subscription_status\": \"active\"\n }\n },\n \"attachments\": [\n {\n \"type\": \"url\",\n \"url\": \"https://example.com/document.pdf\",\n \"name\": \"screenshot.png\",\n \"content_type\": \"image/png\",\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk...\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, { "name": "Help Center", "item": [ @@ -5200,7 +5348,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/help_center/collections/{id}", + "raw": "https://api.intercom.io/help_center/collections/{collection_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -5208,12 +5356,12 @@ "path": [ "help_center", "collections", - "{id}" + "{collection_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "collection_id", "value": "123", "disabled": false, "description": "The unique identifier for the collection which is given by Intercom." @@ -5263,7 +5411,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/help_center/help_centers/{id}", + "raw": "https://api.intercom.io/help_center/help_centers/{help_center_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -5271,12 +5419,12 @@ "path": [ "help_center", "help_centers", - "{id}" + "{help_center_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "help_center_id", "value": "123", "disabled": false, "description": "The unique identifier for the collection which is given by Intercom." @@ -5445,7 +5593,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/help_center/collections/{id}", + "raw": "https://api.intercom.io/help_center/collections/{collection_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -5453,12 +5601,12 @@ "path": [ "help_center", "collections", - "{id}" + "{collection_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "collection_id", "value": "123", "disabled": false, "description": "The unique identifier for the collection which is given by Intercom." @@ -5517,7 +5665,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/help_center/collections/{id}", + "raw": "https://api.intercom.io/help_center/collections/{collection_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -5525,12 +5673,12 @@ "path": [ "help_center", "collections", - "{id}" + "{collection_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "collection_id", "value": "123", "disabled": false, "description": "The unique identifier for the collection which is given by Intercom." @@ -5575,6 +5723,128 @@ } ] }, + { + "name": "IP Allowlist", + "item": [ + { + "name": "Get IP allowlist settings", + "tags": [ + "IP Allowlist" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/ip_allowlist", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ip_allowlist" + ], + "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": "Retrieve the current IP allowlist configuration for the workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.14" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Update IP allowlist settings", + "tags": [ + "IP Allowlist" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/ip_allowlist", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ip_allowlist" + ], + "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": "Update the IP allowlist configuration for the workspace.\n\n{% admonition type=\"warning\" name=\"Lockout Protection\" %}\n The API will reject updates that would lock out the caller's IP address. Ensure your current IP is included in the allowlist when enabling the feature.\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 \"type\": \"ip_allowlist\",\n \"enabled\": true,\n \"ip_allowlist\": [\n \"192.168.1.0/24\",\n \"10.0.0.1\"\n ]\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, { "name": "Internal Articles", "item": [ @@ -5639,19 +5909,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/internal_articles/{id}", + "raw": "https://api.intercom.io/internal_articles/{internal_article_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "internal_articles", - "{id}" + "{internal_article_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "internal_article_id", "value": "123", "disabled": false, "description": "The unique identifier for the article which is given by Intercom." @@ -5825,19 +6095,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/internal_articles/{id}", + "raw": "https://api.intercom.io/internal_articles/{internal_article_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "internal_articles", - "{id}" + "{internal_article_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "internal_article_id", "value": "123", "disabled": false, "description": "The unique identifier for the internal article which is given by Intercom." @@ -5896,19 +6166,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/internal_articles/{id}", + "raw": "https://api.intercom.io/internal_articles/{internal_article_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "internal_articles", - "{id}" + "{internal_article_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "internal_article_id", "value": "123", "disabled": false, "description": "The unique identifier for the internal article which is given by Intercom." @@ -5963,7 +6233,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/jobs/status/{id}", + "raw": "https://api.intercom.io/jobs/status/{job_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -5971,13 +6241,13 @@ "path": [ "jobs", "status", - "{id}" + "{job_id}" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "job_id", + "value": "job_id", "disabled": false, "description": "The unique identifier for the job which is given by Intercom" } @@ -6154,7 +6424,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/news/news_items/{id}", + "raw": "https://api.intercom.io/news/news_items/{news_item_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -6162,12 +6432,12 @@ "path": [ "news", "news_items", - "{id}" + "{news_item_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "news_item_id", "value": "123", "disabled": false, "description": "The unique identifier for the news item which is given by Intercom." @@ -6217,7 +6487,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/news/newsfeeds/{id}/items", + "raw": "https://api.intercom.io/news/newsfeeds/{newsfeed_id}/items", "protocol": "https", "host": [ "api.intercom.io" @@ -6225,13 +6495,13 @@ "path": [ "news", "newsfeeds", - "{id}", + "{newsfeed_id}", "items" ], "query": [], "variable": [ { - "key": "id", + "key": "newsfeed_id", "value": "123", "disabled": false, "description": "The unique identifier for the news feed item which is given by Intercom." @@ -6336,7 +6606,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/news/newsfeeds/{id}", + "raw": "https://api.intercom.io/news/newsfeeds/{newsfeed_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -6344,12 +6614,12 @@ "path": [ "news", "newsfeeds", - "{id}" + "{newsfeed_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "newsfeed_id", "value": "123", "disabled": false, "description": "The unique identifier for the news feed item which is given by Intercom." @@ -6463,7 +6733,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/news/news_items/{id}", + "raw": "https://api.intercom.io/news/news_items/{news_item_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -6471,12 +6741,12 @@ "path": [ "news", "news_items", - "{id}" + "{news_item_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "news_item_id", "value": "123", "disabled": false, "description": "The unique identifier for the news item which is given by Intercom." @@ -6534,7 +6804,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/news/news_items/{id}", + "raw": "https://api.intercom.io/news/news_items/{news_item_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -6542,12 +6812,12 @@ "path": [ "news", "news_items", - "{id}" + "{news_item_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "news_item_id", "value": "123", "disabled": false, "description": "The unique identifier for the news item which is given by Intercom." @@ -6603,21 +6873,21 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/notes", + "raw": "https://api.intercom.io/contacts/{contact_id}/notes", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "contacts", - "{id}", + "{contact_id}", "notes" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "contact_id", + "value": "contact_id", "disabled": false, "description": "The unique identifier of a contact." } @@ -6666,19 +6936,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/notes/{id}", + "raw": "https://api.intercom.io/notes/{note_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "notes", - "{id}" + "{note_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "note_id", "value": "1", "disabled": false, "description": "The unique identifier of a given note" @@ -6729,20 +6999,20 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/notes", + "raw": "https://api.intercom.io/contacts/{contact_id}/notes", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "contacts", - "{id}", + "{contact_id}", "notes" ], "query": [], "variable": [ { - "key": "id", + "key": "contact_id", "value": "123", "disabled": false, "description": "The unique identifier of a given contact." @@ -6787,7 +7057,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"body\": \"New note\",\n \"contact_id\": \"123\",\n \"admin_id\": \"123\"\n}", + "raw": "{\n \"body\": \"New note\",\n \"admin_id\": \"123\"\n}", "urlencoded": [], "formdata": [] } @@ -6866,19 +7136,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/segments/{id}", + "raw": "https://api.intercom.io/segments/{segment_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "segments", - "{id}" + "{segment_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "segment_id", "value": "123", "disabled": false, "description": "The unique identified of a given segment." @@ -7061,7 +7331,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions/{subscription_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -7070,7 +7340,7 @@ "contacts", "{contact_id}", "subscriptions", - "{id}" + "{subscription_id}" ], "query": [], "variable": [ @@ -7081,7 +7351,7 @@ "description": "The unique identifier for the contact which is given by Intercom" }, { - "key": "id", + "key": "subscription_id", "value": "37846", "disabled": false, "description": "The unique identifier for the subscription type which is given by Intercom" @@ -7185,7 +7455,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 \"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 \"CX Score rating\": 4,\n \"CX Score explanation\": \"The conversation was resolved quickly and the customer expressed satisfaction with the outcome.\"\n }\n}", "urlencoded": [], "formdata": [] } @@ -7258,19 +7528,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/tags/{id}", + "raw": "https://api.intercom.io/tags/{tag_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "tags", - "{id}" + "{tag_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "tag_id", "value": "123", "disabled": false, "description": "The unique identifier of a given tag" @@ -7603,7 +7873,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{contact_id}/tags/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags/{tag_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -7612,7 +7882,7 @@ "contacts", "{contact_id}", "tags", - "{id}" + "{tag_id}" ], "query": [], "variable": [ @@ -7623,7 +7893,7 @@ "description": "The unique identifier for the contact which is given by Intercom" }, { - "key": "id", + "key": "tag_id", "value": "7522907", "disabled": false, "description": "The unique identifier for the tag which is given by Intercom" @@ -7674,7 +7944,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{conversation_id}/tags/{id}", + "raw": "https://api.intercom.io/conversations/{conversation_id}/tags/{tag_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -7683,7 +7953,7 @@ "conversations", "{conversation_id}", "tags", - "{id}" + "{tag_id}" ], "query": [], "variable": [ @@ -7694,10 +7964,10 @@ "description": "conversation_id" }, { - "key": "id", + "key": "tag_id", "value": "7522907", "disabled": false, - "description": "id" + "description": "tag_id" } ] }, @@ -7753,19 +8023,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/tags/{id}", + "raw": "https://api.intercom.io/tags/{tag_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "tags", - "{id}" + "{tag_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "tag_id", "value": "123", "disabled": false, "description": "The unique identifier of a given tag" @@ -7816,7 +8086,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/{ticket_id}/tags/{id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}/tags/{tag_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -7825,7 +8095,7 @@ "tickets", "{ticket_id}", "tags", - "{id}" + "{tag_id}" ], "query": [], "variable": [ @@ -7836,7 +8106,7 @@ "description": "ticket_id" }, { - "key": "id", + "key": "tag_id", "value": "7522907", "disabled": false, "description": "The unique identifier for the tag which is given by Intercom" @@ -7954,19 +8224,19 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/teams/{id}", + "raw": "https://api.intercom.io/teams/{team_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "teams", - "{id}" + "{team_id}" ], "query": [], "variable": [ { - "key": "id", + "key": "team_id", "value": "123", "disabled": false, "description": "The unique identifier of a given team." @@ -8152,7 +8422,7 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes/{id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}/attributes/{attribute_id}", "protocol": "https", "host": [ "api.intercom.io" @@ -8161,7 +8431,7 @@ "ticket_types", "{ticket_type_id}", "attributes", - "{id}" + "{attribute_id}" ], "query": [], "variable": [ @@ -8172,8 +8442,8 @@ "description": "The unique identifier for the ticket type which is given by Intercom." }, { - "key": "id", - "value": "id", + "key": "attribute_id", + "value": "attribute_id", "disabled": false, "description": "The unique identifier for the ticket type attribute which is given by Intercom." } @@ -8290,20 +8560,20 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/ticket_types/{id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "ticket_types", - "{id}" + "{ticket_type_id}" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "ticket_type_id", + "value": "ticket_type_id", "disabled": false, "description": "The unique identifier for the ticket type which is given by Intercom." } @@ -8415,20 +8685,20 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/ticket_types/{id}", + "raw": "https://api.intercom.io/ticket_types/{ticket_type_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "ticket_types", - "{id}" + "{ticket_type_id}" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "ticket_type_id", + "value": "ticket_type_id", "disabled": false, "description": "The unique identifier for the ticket type which is given by Intercom." } @@ -8491,22 +8761,22 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/{id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "tickets", - "{id}" + "{ticket_id}" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "ticket_id", + "value": "ticket_id", "disabled": false, - "description": "The unique identifier for the ticket which is given by Intercom." + "description": "The unique identifier for the ticket which is given by Intercom.\n{% admonition type=\"info\" name=\"Not the Inbox ticket ID\" %}\nThis is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.\n{% /admonition %}\n" } ] }, @@ -8553,21 +8823,21 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/{id}/reply", + "raw": "https://api.intercom.io/tickets/{ticket_id}/reply", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "tickets", - "{id}", + "{ticket_id}", "reply" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "ticket_id", + "value": "ticket_id", "disabled": false } ] @@ -8610,7 +8880,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"message_type\": \"comment\",\n \"type\": \"admin\",\n \"body\": \"Hello there!\",\n \"created_at\": 1590000000,\n \"attachment_urls\": \"\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"admin_id\": \"3156780\"\n}", + "raw": "{\n \"message_type\": \"comment\",\n \"type\": \"admin\",\n \"body\": \"Hello there!\",\n \"created_at\": 1590000000,\n \"attachment_urls\": \"\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"admin_id\": \"3156780\",\n \"cross_post\": true\n}", "urlencoded": [], "formdata": [] } @@ -8784,7 +9054,7 @@ ] }, "method": "POST", - "description": "You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`.\n\nThis will accept a query object in the body which will define your filters.\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiples there can be:\n- There's a limit of max 2 nested filters\n- There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foobar\"`).\nThe `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `\"I need support\"` body - the query should contain a `=` operator with the value `\"support\"` for such conversation to be returned. A query with a `=` operator and a `\"need support\"` value will not yield a result.\n\n| Field | Type |\n| :---------------------------------------- | :--------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| _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", + "description": "You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`.\n\nThis will accept a query object in the body which will define your filters.\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiples there can be:\n- There's a limit of max 2 nested filters\n- There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foobar\"`).\nThe `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `\"I need support\"` body - the query should contain a `=` operator with the value `\"support\"` for such conversation to be returned. A query with a `=` operator and a `\"need support\"` value will not yield a result.\n\n| Field | Type |\n| :---------------------------------------- | :--------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| title | String |\n| description | String |\n| category | String |\n| ticket_type_id | String |\n| contact_ids | String |\n| teammate_ids | String |\n| admin_assignee_id | String |\n| team_assignee_id | String |\n| open | Boolean |\n| state | String |\n| snoozed_until | Date (UNIX timestamp) |\n| ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |\n\n{% admonition type=\"info\" name=\"Searching by Category\" %}\nWhen searching for tickets by the **`category`** field, specific terms must be used instead of the category names:\n* For **Customer** category tickets, use the term `request`.\n* For **Back-office** category tickets, use the term `task`.\n* For **Tracker** category tickets, use the term `tracker`.\n{% /admonition %}\n\n### Accepted Operators\n\n{% admonition type=\"info\" name=\"Searching based on `created_at`\" %}\n You may use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", "header": [ { "key": "Intercom-Version", @@ -8815,22 +9085,22 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/{id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "tickets", - "{id}" + "{ticket_id}" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "ticket_id", + "value": "ticket_id", "disabled": false, - "description": "The unique identifier for the ticket which is given by Intercom" + "description": "The unique identifier for the ticket which is given by Intercom.\n{% admonition type=\"info\" name=\"Not the Inbox ticket ID\" %}\nThis is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.\n{% /admonition %}\n" } ] }, @@ -8886,20 +9156,20 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/tickets/{id}", + "raw": "https://api.intercom.io/tickets/{ticket_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "tickets", - "{id}" + "{ticket_id}" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "ticket_id", + "value": "ticket_id", "disabled": false, "description": "The unique identifier for the ticket which is given by Intercom." } @@ -8926,7 +9196,7 @@ ] }, "method": "DELETE", - "description": "You can delete a ticket using the Intercom provided ID.", + "description": "{% admonition type=\"warning\" name=\"Irreversible operation\" %}\nDeleting a ticket is permanent and cannot be reversed.\n{% /admonition %}\n\nDeleting a ticket permanently removes it from the inbox. All sensitive data is deleted, including admin and user replies, ticket attributes, uploads, and related content. The ticket will still appear in reporting, though some data may be incomplete due to the deletion.\n", "header": [ { "key": "Intercom-Version", @@ -9313,6 +9583,7 @@ ] }, "method": "GET", + "description": "Download the data from a completed reporting data export job.\n\n> Octet header required\n>\n> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.\n", "header": [ { "key": "Intercom-Version", @@ -9320,7 +9591,12 @@ }, { "key": "Accept", - "value": "application/octet-stream" + "value": "Accept", + "description": "Required header for downloading the export file" + }, + { + "key": "Accept", + "value": "application/json" } ], "body": null @@ -9468,20 +9744,20 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/calls/{id}", + "raw": "https://api.intercom.io/calls/{call_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "calls", - "{id}" + "{call_id}" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "call_id", + "value": "call_id", "disabled": false, "description": "The id of the call to retrieve" } @@ -9530,21 +9806,21 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/calls/{id}/recording", + "raw": "https://api.intercom.io/calls/{call_id}/recording", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "calls", - "{id}", + "{call_id}", "recording" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "call_id", + "value": "call_id", "disabled": false, "description": "The id of the call" } @@ -9593,21 +9869,21 @@ ], "request": { "url": { - "raw": "https://api.intercom.io/calls/{id}/transcript", + "raw": "https://api.intercom.io/calls/{call_id}/transcript", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "calls", - "{id}", + "{call_id}", "transcript" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "call_id", + "value": "call_id", "disabled": false, "description": "The id of the call" } @@ -9719,7 +9995,7 @@ "event": [], "variable": [ { - "id": "8993cc23-9e5e-434f-b0e5-f274e5cef4d4", + "id": "38080ce0-0706-4920-b580-206339f59b50", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string", diff --git a/postman/2.15/README.md b/postman/2.15/README.md new file mode 100644 index 0000000..e472fb8 --- /dev/null +++ b/postman/2.15/README.md @@ -0,0 +1,15 @@ +# Intercom API 2.15 Postman Collection + +This directory contains the Postman collection for Intercom API version 2.15. + +## 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: 2026-04-16T09:25:37.788Z diff --git a/postman/2.15/environment.json b/postman/2.15/environment.json new file mode 100644 index 0000000..ddc6a90 --- /dev/null +++ b/postman/2.15/environment.json @@ -0,0 +1,18 @@ +{ + "id": "intercom-api-2.15-environment", + "name": "Intercom API 2.15 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.15/intercom-api.postman_collection.json b/postman/2.15/intercom-api.postman_collection.json new file mode 100644 index 0000000..5415883 --- /dev/null +++ b/postman/2.15/intercom-api.postman_collection.json @@ -0,0 +1,10695 @@ +{ + "info": { + "name": "Intercom API - 2.15", + "description": "The intercom API reference.", + "version": "2.15", + "contact": { + "name": "Intercom Developer Hub", + "url": "https://developers.intercom.com" + }, + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "updatedAt": "2026-04-16T09:25:37.786Z" + }, + "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.15" + }, + { + "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/{source_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ai", + "content_import_sources", + "{source_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.15" + }, + { + "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.15" + }, + { + "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/{page_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ai", + "external_pages", + "{page_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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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/{source_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ai", + "content_import_sources", + "{source_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.15" + }, + { + "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/{page_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ai", + "external_pages", + "{page_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.15" + }, + { + "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/{source_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ai", + "content_import_sources", + "{source_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.15" + }, + { + "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/{page_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ai", + "external_pages", + "{page_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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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": [ + { + "key": "display_avatar", + "value": "true", + "description": "If set to true, the response will include the admin's avatar object containing the image URL. Defaults to false." + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of admins for a given workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve an admin", + "tags": [ + "Admins" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/admins/{admin_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "admins", + "{admin_id}" + ], + "query": [], + "variable": [ + { + "key": "admin_id", + "value": "123", + "disabled": false, + "description": "The unique identifier of a given admin" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can retrieve the details of a single admin.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Set an admin to away", + "tags": [ + "Admins" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/admins/{admin_id}/away", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "admins", + "{admin_id}", + "away" + ], + "query": [], + "variable": [ + { + "key": "admin_id", + "value": "admin_id", + "disabled": false, + "description": "The unique identifier of a given admin" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "You can set an Admin as away for the Inbox.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve an article", + "tags": [ + "Articles" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/articles/{article_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "articles", + "{article_id}" + ], + "query": [], + "variable": [ + { + "key": "article_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "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.15" + }, + { + "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`.\n\n> 📘 Tags cannot be managed via the Articles API\n>\n> Article tags are read-only in responses. To create, update, or delete tags, use the Intercom UI or the Tags API endpoints.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "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/{article_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "articles", + "{article_id}" + ], + "query": [], + "variable": [ + { + "key": "article_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.\n\n> 📘 Tags cannot be managed via the Articles API\n>\n> Article tags are read-only in responses. To create, update, or delete tags, use the Intercom UI or the Tags API endpoints.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "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/{article_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "articles", + "{article_id}" + ], + "query": [], + "variable": [ + { + "key": "article_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "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.15" + }, + { + "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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "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": "2.15" + }, + { + "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": "2.15" + }, + { + "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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a company by ID", + "tags": [ + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/companies/{company_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "{company_id}" + ], + "query": [], + "variable": [ + { + "key": "company_id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a single company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List attached contacts", + "tags": [ + "Companies", + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/companies/{company_id}/contacts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "{company_id}", + "contacts" + ], + "query": [], + "variable": [ + { + "key": "company_id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all contacts that belong to a company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List attached segments for companies", + "tags": [ + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/companies/{company_id}/segments", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "{company_id}", + "segments" + ], + "query": [], + "variable": [ + { + "key": "company_id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of all segments that belong to a company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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/{contact_id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{contact_id}", + "companies" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "contact_id", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } + ] + }, + "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.15" + }, + { + "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/{company_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "{company_id}" + ], + "query": [], + "variable": [ + { + "key": "company_id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "You can update a single company using the Intercom provisioned `id`.\n\n{% admonition type=\"warning\" name=\"Using `company_id`\" %}\n When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Intercom\",\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 \"monthly_spend\": 1000\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete a company", + "tags": [ + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/companies/{company_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "{company_id}" + ], + "query": [], + "variable": [ + { + "key": "company_id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "You can delete a single company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "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/{company_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{contact_id}", + "companies", + "{company_id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "58a430d35458202d41b1e65b", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "company_id", + "value": "58a430d35458202d41b1e65b", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } + ] + }, + "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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Contacts", + "item": [ + { + "name": "List attached companies for contact", + "tags": [ + "Contacts", + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{contact_id}/companies", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{contact_id}", + "companies" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of companies that are associated to a contact.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Get a contact", + "tags": [ + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{contact_id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "contact_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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"role\": \"user\",\n \"external_id\": \"625e90fc55ab113b6d92175f\",\n \"email\": \"jdoe@example.com\",\n \"phone\": \"+353871234567\",\n \"name\": \"John Doe\",\n \"avatar\": \"https://www.example.com/avatar_image.jpg\",\n \"signed_up_at\": 1571672154,\n \"last_seen_at\": 1571672154,\n \"owner_id\": 123,\n \"unsubscribed_from_emails\": true,\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 1\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Archive contact", + "tags": [ + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{contact_id}/archive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{contact_id}", + "archive" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "contact_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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Unarchive contact", + "tags": [ + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{contact_id}/unarchive", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{contact_id}", + "unarchive" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "contact_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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Block contact", + "tags": [ + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{contact_id}/block", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{contact_id}", + "block" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "contact_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.15" + }, + { + "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/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{contact_id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "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.15" + }, + { + "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/{contact_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{contact_id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "contact_id", + "disabled": false, + "description": "contact_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.15" + }, + { + "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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{conversation_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{conversation_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": "conversation_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.15" + }, + { + "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.15" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"from\": {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n \"body\": \"Hello\",\n \"subject\": \"Thanks for everything\",\n \"attachment_urls\": \"\",\n \"created_at\": 1671028894\n}", + "urlencoded": [], + "formdata": [] + } + }, + "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.15" + }, + { + "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/{conversation_id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{conversation_id}", + "reply" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "123 or \"last\"", + "disabled": false, + "description": "The Intercom provisioned identifier for the conversation or the string \"last\" to reply to the last part of the conversation" + } + ] + }, + "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.15" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"message_type\": \"comment\",\n \"type\": \"admin\",\n \"body\": \"Hello there!\",\n \"created_at\": 1590000000,\n \"attachment_urls\": \"\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"admin_id\": \"3156780\",\n \"attachment_files\": [\n {\n \"content_type\": \"application/json\",\n \"data\": \"ewogICJ0ZXN0IjogMQp9\",\n \"name\": \"test.json\"\n }\n ],\n \"skip_notifications\": true\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Manage a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{conversation_id}/parts", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{conversation_id}", + "parts" + ], + "query": [], + "variable": [ + { + "key": "conversation_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.15" + }, + { + "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/{conversation_id}/customers", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{conversation_id}", + "customers" + ], + "query": [], + "variable": [ + { + "key": "conversation_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.15" + }, + { + "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.15" + }, + { + "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/{conversation_id}/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{conversation_id}", + "convert" + ], + "query": [], + "variable": [ + { + "key": "conversation_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.15" + }, + { + "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/{conversation_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{conversation_id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "variable": [ + { + "key": "conversation_id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } + ] + }, + "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.15" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"read\": true,\n \"title\": \"Conversation Title\",\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 9,\n \"start_date_iso8601\": \"2023-03-04T09:46:14Z\",\n \"end_date_timestamp\": 1677923174,\n \"CX Score rating\": 4,\n \"CX Score explanation\": \"The conversation was resolved quickly and the customer expressed satisfaction with the outcome.\"\n },\n \"company_id\": \"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{conversation_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{conversation_id}" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "conversation_id", + "disabled": false, + "description": "id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "{% admonition type=\"warning\" name=\"Irreversible operation\" %}\nDeleting a conversation is permanent and cannot be reversed.\n{% /admonition %}\n\nDeleting a conversation permanently removes it from the inbox. All sensitive data is deleted, including admin and user replies, conversation attributes, uploads, and related content. The conversation will still appear in reporting, though some data may be incomplete due to the deletion.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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}/{custom_object_instance_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}", + "{custom_object_instance_id}" + ], + "query": [], + "variable": [ + { + "key": "custom_object_instance_id", + "value": "custom_object_instance_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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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}/{custom_object_instance_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}", + "{custom_object_instance_id}" + ], + "query": [], + "variable": [ + { + "key": "custom_object_instance_id", + "value": "custom_object_instance_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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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/{data_attribute_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_attributes", + "{data_attribute_id}" + ], + "query": [], + "variable": [ + { + "key": "data_attribute_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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Emails", + "item": [ + { + "name": "List all email settings", + "tags": [ + "Emails" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/emails", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "emails" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Lists all sender email address settings for the workspace", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "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": "2.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Fin Agent", + "item": [ + { + "name": "Start a conversation with Fin", + "tags": [ + "Fin Agent" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin/start", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin", + "start" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Initialize Fin by passing it the user's message along with conversation history and user details.\n\nThese additional pieces of context will be used by Fin to provide a better and more contextual answer to the user.\n\n{% admonition type=\"warning\" %}\nPlease reach out to your accounts team to discuss access.\n{% /admonition %}\n\nOnce Fin is initialized, it progresses through a series of statuses such as *thinking*, *awaiting_user_reply*, or *resolved* before ending with a status of *complete*.\n\nDuring this workflow, the client should allow Fin to continue uninterrupted until a final *complete* status is returned via webhook, at which point control of the conversation passes back to the client.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"conversation_id\": \"ext-123\",\n \"message\": {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n },\n \"user\": {\n \"id\": \"123456\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"attributes\": {\n \"plan_type\": \"Pro\",\n \"subscription_status\": \"active\"\n }\n },\n \"attachments\": [\n {\n \"type\": \"url\",\n \"url\": \"https://example.com/document.pdf\",\n \"name\": \"screenshot.png\",\n \"content_type\": \"image/png\",\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk...\"\n }\n ],\n \"conversation_metadata\": {\n \"history\": [\n {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n }\n ],\n \"attributes\": {\n \"priority_level\": \"high\",\n \"department\": \"sales\"\n }\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Reply to Fin", + "tags": [ + "Fin Agent" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin", + "reply" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Once Fin has returned a response to a user's message, its status will be `awaiting_user_reply`.\n\nIf a user replies, use this endpoint to send this response to Fin.\n\n{% admonition type=\"warning\" %}\nPlease reach out to your accounts team to discuss access.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"conversation_id\": \"123456\",\n \"message\": {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n },\n \"user\": {\n \"id\": \"123456\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"attributes\": {\n \"plan_type\": \"Pro\",\n \"subscription_status\": \"active\"\n }\n },\n \"attachments\": [\n {\n \"type\": \"url\",\n \"url\": \"https://example.com/document.pdf\",\n \"name\": \"screenshot.png\",\n \"content_type\": \"image/png\",\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk...\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } + }, + "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.15" + }, + { + "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/{collection_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "collections", + "{collection_id}" + ], + "query": [], + "variable": [ + { + "key": "collection_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } + ] + }, + "auth": { + "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.15" + }, + { + "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/{help_center_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "help_centers", + "{help_center_id}" + ], + "query": [], + "variable": [ + { + "key": "help_center_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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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/{collection_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "collections", + "{collection_id}" + ], + "query": [], + "variable": [ + { + "key": "collection_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } + ] + }, + "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.15" + }, + { + "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/{collection_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "help_center", + "collections", + "{collection_id}" + ], + "query": [], + "variable": [ + { + "key": "collection_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the collection which is given by Intercom." + } + ] + }, + "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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "IP Allowlist", + "item": [ + { + "name": "Get IP allowlist settings", + "tags": [ + "IP Allowlist" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/ip_allowlist", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ip_allowlist" + ], + "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": "Retrieve the current IP allowlist configuration for the workspace.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Update IP allowlist settings", + "tags": [ + "IP Allowlist" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/ip_allowlist", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ip_allowlist" + ], + "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": "Update the IP allowlist configuration for the workspace.\n\n{% admonition type=\"warning\" name=\"Lockout Protection\" %}\n The API will reject updates that would lock out the caller's IP address. Ensure your current IP is included in the allowlist when enabling the feature.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"ip_allowlist\",\n \"enabled\": true,\n \"ip_allowlist\": [\n \"192.168.1.0/24\",\n \"10.0.0.1\"\n ]\n}", + "urlencoded": [], + "formdata": [] + } + }, + "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.15" + }, + { + "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/{internal_article_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "internal_articles", + "{internal_article_id}" + ], + "query": [], + "variable": [ + { + "key": "internal_article_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the article which is given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch the details of a single internal article by making a GET request to `https://api.intercom.io/internal_articles/`.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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/{internal_article_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "internal_articles", + "{internal_article_id}" + ], + "query": [], + "variable": [ + { + "key": "internal_article_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.15" + }, + { + "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/{internal_article_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "internal_articles", + "{internal_article_id}" + ], + "query": [], + "variable": [ + { + "key": "internal_article_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.15" + }, + { + "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/{job_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "jobs", + "status", + "{job_id}" + ], + "query": [], + "variable": [ + { + "key": "job_id", + "value": "job_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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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/{news_item_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "news", + "news_items", + "{news_item_id}" + ], + "query": [], + "variable": [ + { + "key": "news_item_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } + ] + }, + "auth": { + "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.15" + }, + { + "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/{newsfeed_id}/items", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "news", + "newsfeeds", + "{newsfeed_id}", + "items" + ], + "query": [], + "variable": [ + { + "key": "newsfeed_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } + ] + }, + "auth": { + "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.15" + }, + { + "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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a newsfeed", + "tags": [ + "News" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/news/newsfeeds/{newsfeed_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "news", + "newsfeeds", + "{newsfeed_id}" + ], + "query": [], + "variable": [ + { + "key": "newsfeed_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news feed item which is given by Intercom." + } + ] + }, + "auth": { + "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.15" + }, + { + "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.15" + }, + { + "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/{news_item_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "news", + "news_items", + "{news_item_id}" + ], + "query": [], + "variable": [ + { + "key": "news_item_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } + ] + }, + "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.15" + }, + { + "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/{news_item_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "news", + "news_items", + "{news_item_id}" + ], + "query": [], + "variable": [ + { + "key": "news_item_id", + "value": "123", + "disabled": false, + "description": "The unique identifier for the news item which is given by Intercom." + } + ] + }, + "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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Notes", + "item": [ + { + "name": "List all company notes", + "tags": [ + "Notes", + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/companies/{company_id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "{company_id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "company_id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of notes that are associated to a company.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List all notes", + "tags": [ + "Notes", + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{contact_id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{contact_id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "contact_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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a note", + "tags": [ + "Notes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/notes/{note_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "notes", + "{note_id}" + ], + "query": [], + "variable": [ + { + "key": "note_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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create a note", + "tags": [ + "Notes", + "Contacts" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/contacts/{contact_id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{contact_id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "contact_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.15" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"body\": \"New note\",\n \"admin_id\": \"123\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "Segments", + "item": [ + { + "name": "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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a segment", + "tags": [ + "Segments" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/segments/{segment_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "segments", + "{segment_id}" + ], + "query": [], + "variable": [ + { + "key": "segment_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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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/{subscription_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{contact_id}", + "subscriptions", + "{subscription_id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "subscription_id", + "value": "37846", + "disabled": false, + "description": "The unique identifier for the subscription type which is given by Intercom" + } + ] + }, + "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.15" + }, + { + "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.15" + }, + { + "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 \"CX Score rating\": 4,\n \"CX Score explanation\": \"The conversation was resolved quickly and the customer expressed satisfaction with the outcome.\"\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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Find a specific tag", + "tags": [ + "Tags" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tags/{tag_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "tags", + "{tag_id}" + ], + "query": [], + "variable": [ + { + "key": "tag_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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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/{tag_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "contacts", + "{contact_id}", + "tags", + "{tag_id}" + ], + "query": [], + "variable": [ + { + "key": "contact_id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "tag_id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier for the tag which is given by Intercom" + } + ] + }, + "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.15" + }, + { + "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/{tag_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{conversation_id}", + "tags", + "{tag_id}" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "64619700005694", + "disabled": false, + "description": "conversation_id" + }, + { + "key": "tag_id", + "value": "7522907", + "disabled": false, + "description": "tag_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.15" + }, + { + "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/{tag_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "tags", + "{tag_id}" + ], + "query": [], + "variable": [ + { + "key": "tag_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.15" + }, + { + "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/{tag_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "tickets", + "{ticket_id}", + "tags", + "{tag_id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "64619700005694", + "disabled": false, + "description": "ticket_id" + }, + { + "key": "tag_id", + "value": "7522907", + "disabled": false, + "description": "The unique identifier for the tag which is given by Intercom" + } + ] + }, + "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.15" + }, + { + "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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Retrieve a team", + "tags": [ + "Teams" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/teams/{team_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "teams", + "{team_id}" + ], + "query": [], + "variable": [ + { + "key": "team_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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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/{attribute_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ticket_types", + "{ticket_type_id}", + "attributes", + "{attribute_id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + }, + { + "key": "attribute_id", + "value": "attribute_id", + "disabled": false, + "description": "The unique identifier for the ticket type attribute which is given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "You can update an existing attribute for a ticket type.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "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.15" + }, + { + "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/{ticket_type_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ticket_types", + "{ticket_type_id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } + ] + }, + "auth": { + "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.15" + }, + { + "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.15" + }, + { + "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/{ticket_type_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "ticket_types", + "{ticket_type_id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_type_id", + "value": "ticket_type_id", + "disabled": false, + "description": "The unique identifier for the ticket type which is given by Intercom." + } + ] + }, + "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.15" + }, + { + "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/{ticket_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "tickets", + "{ticket_id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "ticket_id", + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom.\n{% admonition type=\"info\" name=\"Not the Inbox ticket ID\" %}\nThis is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.\n{% /admonition %}\n" + } + ] + }, + "auth": { + "type": "bearer", + "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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Reply to a ticket", + "tags": [ + "Tickets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tickets/{ticket_id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "tickets", + "{ticket_id}", + "reply" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "ticket_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.15" + }, + { + "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 \"cross_post\": true\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Create a ticket", + "tags": [ + "Tickets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tickets", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "tickets" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can create a new ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "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.15" + }, + { + "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| title | String |\n| description | String |\n| category | String |\n| ticket_type_id | String |\n| contact_ids | String |\n| teammate_ids | String |\n| admin_assignee_id | String |\n| team_assignee_id | String |\n| open | Boolean |\n| state | String |\n| snoozed_until | Date (UNIX timestamp) |\n| ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |\n\n{% admonition type=\"info\" name=\"Searching by Category\" %}\nWhen searching for tickets by the **`category`** field, specific terms must be used instead of the category names:\n* For **Customer** category tickets, use the term `request`.\n* For **Back-office** category tickets, use the term `task`.\n* For **Tracker** category tickets, use the term `tracker`.\n{% /admonition %}\n\n### Accepted Operators\n\n{% admonition type=\"info\" name=\"Searching based on `created_at`\" %}\n You may use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "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/{ticket_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "tickets", + "{ticket_id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "ticket_id", + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom.\n{% admonition type=\"info\" name=\"Not the Inbox ticket ID\" %}\nThis is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.\n{% /admonition %}\n" + } + ] + }, + "auth": { + "type": "bearer", + "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.15" + }, + { + "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/{ticket_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "tickets", + "{ticket_id}" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "ticket_id", + "disabled": false, + "description": "The unique identifier for the ticket which is given by Intercom.\n{% admonition type=\"info\" name=\"Not the Inbox ticket ID\" %}\nThis is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.\n{% /admonition %}\n" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "{% admonition type=\"warning\" name=\"Irreversible operation\" %}\nDeleting a ticket is permanent and cannot be reversed.\n{% /admonition %}\n\nDeleting a ticket permanently removes it from the inbox. All sensitive data is deleted, including admin and user replies, ticket attributes, uploads, and related content. The ticket will still appear in reporting, though some data may be incomplete due to the deletion.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "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": "Workflows", + "item": [ + { + "name": "Export a workflow", + "tags": [ + "Workflows" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/export/workflows/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "export", + "workflows", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the workflow" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Export a workflow configuration by its ID. This endpoint returns the complete workflow definition including its steps, targeting rules, and attributes.\n\nThis endpoint is designed for EU Data Act compliance, allowing customers to export their workflow configurations.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "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.15" + }, + { + "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.15" + }, + { + "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", + "description": "Download the data from a completed reporting data export job.\n\n> Octet header required\n>\n> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "2.15" + }, + { + "key": "Accept", + "value": "Accept", + "description": "Required header for downloading the export file" + }, + { + "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.15" + }, + { + "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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Get a call", + "tags": [ + "Calls" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/calls/{call_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "calls", + "{call_id}" + ], + "query": [], + "variable": [ + { + "key": "call_id", + "value": "call_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.15" + }, + { + "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/{call_id}/recording", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "calls", + "{call_id}", + "recording" + ], + "query": [], + "variable": [ + { + "key": "call_id", + "value": "call_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.15" + }, + { + "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/{call_id}/transcript", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "calls", + "{call_id}", + "transcript" + ], + "query": [], + "variable": [ + { + "key": "call_id", + "value": "call_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.15" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Collect Fin Voice call by ID", + "tags": [ + "Calls" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin_voice/collect/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin_voice", + "collect", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The external reference ID" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Retrieve information about a Fin Voice call using the external reference ID.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Collect Fin Voice call by external ID", + "tags": [ + "Calls" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin_voice/external_id/{external_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin_voice", + "external_id", + "{external_id}" + ], + "query": [], + "variable": [ + { + "key": "external_id", + "value": "external_id", + "disabled": false, + "description": "The external call identifier from the call provider" + } + ] + }, + "auth": { + "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 information about a Fin Voice call using the external call identifier.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Collect Fin Voice call by phone number", + "tags": [ + "Calls" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin_voice/phone_number/{phone_number}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin_voice", + "phone_number", + "{phone_number}" + ], + "query": [], + "variable": [ + { + "key": "phone_number", + "value": "phone_number", + "disabled": false, + "description": "Phone number in E.164 format" + } + ] + }, + "auth": { + "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 information about a Fin Voice call using the phone number.\n\nReturns the most recent matched call for the given phone number, ordered by creation date.\n", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Collect Fin Voice calls by conversation ID", + "tags": [ + "Calls" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin_voice/conversation/{conversation_id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin_voice", + "conversation", + "{conversation_id}" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "conversation_id", + "disabled": false, + "description": "The Intercom conversation 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": "Retrieve information about Fin Voice calls associated with a conversation.\n\nReturns all matched calls for the given conversation ID. A conversation may have multiple associated calls.\n", + "header": [ + { + "key": "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.15" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"conversation_ids\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Register a Fin Voice call", + "tags": [ + "Calls" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin_voice/register", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin_voice", + "register" + ], + "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": "Register a Fin Voice call with Intercom. This endpoint creates an external reference\nthat links an external call identifier to an Intercom call and conversation.\n\nThe call can be from different sources:\n- AWS Connect (default)\n- Five9\n- Zoom Phone\n", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"phone_number\": \"+1234567890\",\n \"call_id\": \"call-123-abc\",\n \"source\": \"aws_connect\",\n \"data\": {\n \"key\": \"value\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + } + ], + "event": [], + "variable": [ + { + "id": "b950e8ea-4770-4da3-8a02-4362a40f2ff5", + "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/Preview/README.md b/postman/Preview/README.md index b843c53..f2e4cc3 100644 --- a/postman/Preview/README.md +++ b/postman/Preview/README.md @@ -12,4 +12,4 @@ This directory contains the Postman collection for Intercom API version Preview. 3. Set your access token in the environment variables 4. Start making API calls! -Last updated: 2025-08-27T09:13:41.711Z +Last updated: 2026-04-16T09:25:36.792Z diff --git a/postman/Preview/intercom-api.postman_collection.json b/postman/Preview/intercom-api.postman_collection.json index 69dec35..4ca3dfe 100644 --- a/postman/Preview/intercom-api.postman_collection.json +++ b/postman/Preview/intercom-api.postman_collection.json @@ -8,7 +8,7 @@ "url": "https://developers.intercom.com" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "updatedAt": "2025-08-27T09:13:41.708Z" + "updatedAt": "2026-04-16T09:25:36.789Z" }, "item": [ { @@ -730,6 +730,61 @@ }, "response": [] }, + { + "name": "List all activity log event types", + "tags": [ + "Admins" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/admins/activity_log_event_types", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "admins", + "activity_log_event_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 activity log event types. This is useful for discovering valid values to use with the `event_types` filter on the List all activity logs endpoint.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, { "name": "List all admins", "tags": [ @@ -745,7 +800,13 @@ "path": [ "admins" ], - "query": [], + "query": [ + { + "key": "display_avatar", + "value": "true", + "description": "If set to true, the response will include the admin's avatar object containing the image URL. Defaults to false." + } + ], "variable": [] }, "auth": { @@ -846,6 +907,71 @@ }, "response": [] }, + { + "name": "Search activity logs", + "tags": [ + "Admins" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/admins/activity_logs/search", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "admins", + "activity_logs", + "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": "Search and filter admin activity logs using a POST request with event type filter in the request body. You can find more details about the available event types in the List all activity log event types endpoint.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"created_at_after\": \"1677253093\",\n \"created_at_before\": \"1677861493\",\n \"event_types\": [\n \"app_name_change\",\n \"message_state_change\"\n ],\n \"page\": 1,\n \"per_page\": 20\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, { "name": "Set an admin to away", "tags": [ @@ -1154,7 +1280,7 @@ ] }, "method": "POST", - "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", + "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.\n\n> 📘 Tags cannot be managed via the Articles API\n>\n> Article tags are read-only in responses. To create, update, or delete tags, use the Intercom UI or the Tags API endpoints.\n", "header": [ { "key": "Intercom-Version", @@ -1171,7 +1297,7 @@ ], "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}", + "raw": "{\n \"title\": \"Thanks for everything\",\n \"description\": \"Description of the Article\",\n \"body\": \"

This is the body in html

\",\n \"author_id\": 1295,\n \"state\": \"draft\",\n \"parent_id\": 18,\n \"parent_type\": \"collection\",\n \"translated_content\": {\n \"type\": \"article_translated_content\",\n \"ar\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"bg\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"bs\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ca\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"cs\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"da\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"de\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"el\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"en\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"es\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"et\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"fi\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"fr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"he\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"hr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"hu\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"id\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"it\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ja\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ko\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"lt\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"lv\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"mn\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"nb\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"nl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"pl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"pt\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ro\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ru\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"sl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"sr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"sv\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"tr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"vi\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"pt-BR\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"zh-CN\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"zh-TW\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n }\n },\n \"folder_id\": 6\n}", "urlencoded": [], "formdata": [] } @@ -1225,7 +1351,7 @@ ] }, "method": "PUT", - "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", + "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.\n\n> 📘 Tags cannot be managed via the Articles API\n>\n> Article tags are read-only in responses. To create, update, or delete tags, use the Intercom UI or the Tags API endpoints.\n", "header": [ { "key": "Intercom-Version", @@ -1242,7 +1368,7 @@ ], "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}", + "raw": "{\n \"title\": \"Thanks for everything\",\n \"description\": \"Description of the Article\",\n \"body\": \"

This is the body in html

\",\n \"author_id\": 1295,\n \"state\": \"draft\",\n \"parent_id\": \"18\",\n \"parent_type\": \"collection\",\n \"translated_content\": {\n \"type\": \"article_translated_content\",\n \"ar\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"bg\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"bs\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ca\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"cs\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"da\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"de\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"el\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"en\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"es\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"et\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"fi\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"fr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"he\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"hr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"hu\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"id\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"it\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ja\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ko\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"lt\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"lv\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"mn\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"nb\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"nl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"pl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"pt\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ro\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"ru\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"sl\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"sr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"sv\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"tr\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"vi\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"pt-BR\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"zh-CN\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n },\n \"zh-TW\": {\n \"type\": \"article_content\",\n \"title\": \"How to create a new article\",\n \"description\": \"This article will show you how to create a new article.\",\n \"body\": \"This is the body of the article.\",\n \"author_id\": \"5017691\",\n \"state\": \"draft\",\n \"created_at\": 1663597223,\n \"updated_at\": 1663597260,\n \"url\": \"http://intercom.test/help/en/articles/3-default-language\"\n }\n },\n \"folder_id\": 6\n}", "urlencoded": [], "formdata": [] } @@ -1414,7 +1540,7 @@ ] }, "method": "GET", - "description": "Retrieves all brands for the workspace, including the default brand.\nThe default brand id always matches the workspace \n", + "description": "Retrieves all brands for the workspace, including the default brand.\nThe default brand id always matches the workspace\n", "header": [ { "key": "Intercom-Version", @@ -1494,44 +1620,24 @@ ] }, { - "name": "Companies", + "name": "Calls", "item": [ { - "name": "Retrieve companies", + "name": "List all calls", "tags": [ - "Companies" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/companies", + "raw": "https://api.intercom.io/calls", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies" + "calls" ], "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", @@ -1539,8 +1645,8 @@ }, { "key": "per_page", - "value": "15", - "description": "How many results to display per page. Defaults to 15" + "value": "25", + "description": "How many results to display per page. Defaults to 25. Max 25." } ], "variable": [] @@ -1566,7 +1672,7 @@ ] }, "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", + "description": "Retrieve a paginated list of calls.\n", "header": [ { "key": "Intercom-Version", @@ -1582,28 +1688,28 @@ "response": [] }, { - "name": "Retrieve a company by ID", + "name": "Get a call", "tags": [ - "Companies" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{id}", + "raw": "https://api.intercom.io/calls/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", + "calls", "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "value": "id", "disabled": false, - "description": "The unique identifier for the company which is given by Intercom" + "description": "The id of the call to retrieve" } ] }, @@ -1628,7 +1734,7 @@ ] }, "method": "GET", - "description": "You can fetch a single company.", + "description": "Retrieve a single call by id.", "header": [ { "key": "Intercom-Version", @@ -1644,30 +1750,29 @@ "response": [] }, { - "name": "List attached contacts", + "name": "Get call recording by call id", "tags": [ - "Companies", - "Contacts" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{id}/contacts", + "raw": "https://api.intercom.io/calls/{id}/recording", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", + "calls", "{id}", - "contacts" + "recording" ], "query": [], "variable": [ { "key": "id", - "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "value": "id", "disabled": false, - "description": "The unique identifier for the company which is given by Intercom" + "description": "The id of the call" } ] }, @@ -1692,7 +1797,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of all contacts that belong to a company.", + "description": "Redirects to a signed URL for the call's recording if it exists.", "header": [ { "key": "Intercom-Version", @@ -1708,29 +1813,29 @@ "response": [] }, { - "name": "List attached segments for companies", + "name": "Get call transcript by call id", "tags": [ - "Companies" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{id}/segments", + "raw": "https://api.intercom.io/calls/{id}/transcript", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", + "calls", "{id}", - "segments" + "transcript" ], "query": [], "variable": [ { "key": "id", - "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "value": "id", "disabled": false, - "description": "The unique identifier for the company which is given by Intercom" + "description": "The id of the call" } ] }, @@ -1755,7 +1860,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of all segments that belong to a company.", + "description": "Returns the transcript for the specified call as a downloadable text file.\n", "header": [ { "key": "Intercom-Version", @@ -1771,29 +1876,31 @@ "response": [] }, { - "name": "Scroll over all companies", + "name": "Collect Fin Voice call by ID", "tags": [ - "Companies" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/scroll", + "raw": "https://api.intercom.io/fin_voice/collect/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", - "scroll" + "fin_voice", + "collect", + "{id}" ], - "query": [ + "query": [], + "variable": [ { - "key": "scroll_param", - "value": "scroll_param", - "description": "" + "key": "id", + "value": "id", + "disabled": false, + "description": "The external reference ID" } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -1816,12 +1923,8 @@ ] }, "method": "GET", - "description": " The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset.\n\n- Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.\n- If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail\n- If the end of the scroll is reached, \"companies\" will be empty and the scroll parameter will expire\n\n{% admonition type=\"info\" name=\"Scroll Parameter\" %}\n You can get the first page of companies by simply sending a GET request to the scroll endpoint.\n For subsequent requests you will need to use the scroll parameter from the response.\n{% /admonition %}\n{% admonition type=\"danger\" name=\"Scroll network timeouts\" %}\n Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message:\n \"Request failed due to an internal network error. Please restart the scroll operation.\"\n If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll.\n{% /admonition %}\n", + "description": "Retrieve information about a Fin Voice call using the external reference ID.", "header": [ - { - "key": "Intercom-Version", - "value": "Preview" - }, { "key": "Accept", "value": "application/json" @@ -1832,22 +1935,31 @@ "response": [] }, { - "name": "Create or Update a company", + "name": "Collect Fin Voice call by external ID", "tags": [ - "Companies" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/companies", + "raw": "https://api.intercom.io/fin_voice/external_id/{external_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies" + "fin_voice", + "external_id", + "{external_id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "external_id", + "value": "external_id", + "disabled": false, + "description": "The external call identifier from the call provider" + } + ] }, "auth": { "type": "bearer", @@ -1869,65 +1981,44 @@ } ] }, - "method": "POST", - "description": "You can create or update a company.\n\nCompanies will be only visible in Intercom when there is at least one associated user.\n\nCompanies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated.\n\n{% admonition type=\"warning\" name=\"Using `company_id`\" %}\n You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company.\n{% /admonition %}\n", + "method": "GET", + "description": "Retrieve information about a Fin Voice call using the external call identifier.", "header": [ - { - "key": "Intercom-Version", - "value": "Preview" - }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Intercom\",\n \"company_id\": \"625e90fc55ab113b6d92175f\",\n \"plan\": \"Enterprise\",\n \"size\": \"100\",\n \"website\": \"https://www.example.com\",\n \"industry\": \"Manufacturing\",\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 9\n },\n \"remote_created_at\": 1394531169,\n \"monthly_spend\": 1000\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "List all companies", + "name": "Collect Fin Voice call by phone number", "tags": [ - "Companies" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/list", + "raw": "https://api.intercom.io/fin_voice/phone_number/{phone_number}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", - "list" + "fin_voice", + "phone_number", + "{phone_number}" ], - "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" - }, + "query": [], + "variable": [ { - "key": "order", - "value": "desc", - "description": "`asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc" + "key": "phone_number", + "value": "phone_number", + "disabled": false, + "description": "Phone number in E.164 format" } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -1949,13 +2040,9 @@ } ] }, - "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", + "method": "GET", + "description": "Retrieve information about a Fin Voice call using the phone number.\n\nReturns the most recent matched call for the given phone number, ordered by creation date.\n", "header": [ - { - "key": "Intercom-Version", - "value": "Preview" - }, { "key": "Accept", "value": "application/json" @@ -1966,30 +2053,29 @@ "response": [] }, { - "name": "Attach a Contact to a Company", + "name": "Collect Fin Voice calls by conversation ID", "tags": [ - "Companies", - "Contacts" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/companies", + "raw": "https://api.intercom.io/fin_voice/conversation/{conversation_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{id}", - "companies" + "fin_voice", + "conversation", + "{conversation_id}" ], "query": [], "variable": [ { - "key": "id", - "value": "id", + "key": "conversation_id", + "value": "conversation_id", "disabled": false, - "description": "The unique identifier for the contact which is given by Intercom" + "description": "The Intercom conversation identifier" } ] }, @@ -2013,56 +2099,36 @@ } ] }, - "method": "POST", - "description": "You can attach a company to a single contact.", + "method": "GET", + "description": "Retrieve information about Fin Voice calls associated with a conversation.\n\nReturns all matched calls for the given conversation ID. A conversation may have multiple associated calls.\n", "header": [ - { - "key": "Intercom-Version", - "value": "Preview" - }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"58a430d35458202d41b1e65b\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Update a company", + "name": "List calls with transcripts", "tags": [ - "Companies" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{id}", + "raw": "https://api.intercom.io/calls/search", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", - "{id}" + "calls", + "search" ], "query": [], - "variable": [ - { - "key": "id", - "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", - "disabled": false, - "description": "The unique identifier for the company which is given by Intercom" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -2084,47 +2150,49 @@ } ] }, - "method": "PUT", - "description": "You can update a single company using the Intercom provisioned `id`.\n\n{% admonition type=\"warning\" name=\"Using `company_id`\" %}\n When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company.\n{% /admonition %}\n", + "method": "POST", + "description": "Retrieve calls by a list of conversation ids and include transcripts when available.\nA maximum of 20 `conversation_ids` can be provided. If none are provided or more than 20 are provided, a 400 error is returned.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"conversation_ids\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Delete a company", + "name": "Register a Fin Voice call", "tags": [ - "Companies" + "Calls" ], "request": { "url": { - "raw": "https://api.intercom.io/companies/{id}", + "raw": "https://api.intercom.io/fin_voice/register", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "companies", - "{id}" + "fin_voice", + "register" ], "query": [], - "variable": [ - { - "key": "id", - "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", - "disabled": false, - "description": "The unique identifier for the company which is given by Intercom" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -2146,56 +2214,80 @@ } ] }, - "method": "DELETE", - "description": "You can delete a single company.", + "method": "POST", + "description": "Register a Fin Voice call with Intercom. This endpoint creates an external reference\nthat links an external call identifier to an Intercom call and conversation.\n\nThe call can be from different sources:\n- AWS Connect (default)\n- Five9\n- Zoom Phone\n", "header": [ { - "key": "Intercom-Version", - "value": "Preview" + "key": "Content-Type", + "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"phone_number\": \"+1234567890\",\n \"call_id\": \"call-123-abc\",\n \"source\": \"aws_connect\",\n \"data\": {\n \"key\": \"value\"\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Companies", + "item": [ { - "name": "Detach a contact from a company", + "name": "Retrieve companies", "tags": [ - "Companies", - "Contacts" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{contact_id}/companies/{id}", + "raw": "https://api.intercom.io/companies", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{contact_id}", - "companies", - "{id}" + "companies" ], - "query": [], - "variable": [ + "query": [ { - "key": "contact_id", - "value": "58a430d35458202d41b1e65b", - "disabled": false, - "description": "The unique identifier for the contact which is given by Intercom" + "key": "name", + "value": "my company", + "description": "The `name` of the company to filter by." }, { - "key": "id", - "value": "58a430d35458202d41b1e65b", - "disabled": false, - "description": "The unique identifier for the company which is given by Intercom" + "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", @@ -2217,8 +2309,8 @@ } ] }, - "method": "DELETE", - "description": "You can detach a company from a single contact.", + "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", @@ -2232,37 +2324,30 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Contacts", - "item": [ + }, { - "name": "List attached companies for contact", + "name": "Retrieve a company by ID", "tags": [ - "Contacts", "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/companies", + "raw": "https://api.intercom.io/companies/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{id}", - "companies" + "companies", + "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "63a07ddf05a32042dffac965", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", "disabled": false, - "description": "The unique identifier for the contact which is given by Intercom" + "description": "The unique identifier for the company which is given by Intercom" } ] }, @@ -2287,7 +2372,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of companies that are associated to a contact.", + "description": "You can fetch a single company.", "header": [ { "key": "Intercom-Version", @@ -2303,30 +2388,30 @@ "response": [] }, { - "name": "List attached segments for contact", + "name": "List attached contacts", "tags": [ - "Contacts", - "Segments" + "Companies", + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{contact_id}/segments", + "raw": "https://api.intercom.io/companies/{id}/contacts", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{contact_id}", - "segments" + "companies", + "{id}", + "contacts" ], "query": [], "variable": [ { - "key": "contact_id", - "value": "63a07ddf05a32042dffac965", + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", "disabled": false, - "description": "The unique identifier for the contact which is given by Intercom" + "description": "The unique identifier for the company which is given by Intercom" } ] }, @@ -2351,7 +2436,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of segments that are associated to a contact.", + "description": "You can fetch a list of all contacts that belong to a company.", "header": [ { "key": "Intercom-Version", @@ -2367,30 +2452,29 @@ "response": [] }, { - "name": "List subscriptions for a contact", + "name": "List attached segments for companies", "tags": [ - "Contacts", - "Subscription Types" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", + "raw": "https://api.intercom.io/companies/{id}/segments", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{contact_id}", - "subscriptions" + "companies", + "{id}", + "segments" ], "query": [], "variable": [ { - "key": "contact_id", - "value": "63a07ddf05a32042dffac965", + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", "disabled": false, - "description": "The unique identifier for the contact which is given by Intercom" + "description": "The unique identifier for the company which is given by Intercom" } ] }, @@ -2415,7 +2499,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type.\nThis will return a list of Subscription Type objects that the contact is associated with.\n\nThe data property will show a combined list of:\n\n 1.Opt-out subscription types that the user has opted-out from.\n 2.Opt-in subscription types that the user has opted-in to receiving.\n", + "description": "You can fetch a list of all segments that belong to a company.", "header": [ { "key": "Intercom-Version", @@ -2431,32 +2515,29 @@ "response": [] }, { - "name": "List tags attached to a contact", + "name": "Scroll over all companies", "tags": [ - "Contacts", - "Tags" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{contact_id}/tags", + "raw": "https://api.intercom.io/companies/scroll", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{contact_id}", - "tags" + "companies", + "scroll" ], - "query": [], - "variable": [ + "query": [ { - "key": "contact_id", - "value": "63a07ddf05a32042dffac965", - "disabled": false, - "description": "The unique identifier for the contact which is given by Intercom" + "key": "scroll_param", + "value": "scroll_param", + "description": "" } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -2479,7 +2560,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of all tags that are attached to a specific contact.", + "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", @@ -2495,30 +2576,22 @@ "response": [] }, { - "name": "Get a contact", + "name": "Create or Update a company", "tags": [ - "Contacts" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}", + "raw": "https://api.intercom.io/companies", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "{id}" + "companies" ], "query": [], - "variable": [ - { - "key": "id", - "value": "63a07ddf05a32042dffac965", - "disabled": false, - "description": "id" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -2540,38 +2613,64 @@ } ] }, - "method": "GET", - "description": "You can fetch the details of a single contact.", + "method": "POST", + "description": "You can create or update a company.\n\nCompanies will be only visible in Intercom when there is at least one associated user.\n\nCompanies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated.\n\n{% admonition type=\"warning\" name=\"Using `company_id`\" %}\n You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Intercom\",\n \"company_id\": \"625e90fc55ab113b6d92175f\",\n \"plan\": \"Enterprise\",\n \"size\": \"100\",\n \"website\": \"https://www.example.com\",\n \"industry\": \"Manufacturing\",\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 9\n },\n \"remote_created_at\": 1394531169,\n \"monthly_spend\": 1000,\n \"update_last_request_at\": true\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List all contacts", + "name": "List all companies", "tags": [ - "Contacts" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts", + "raw": "https://api.intercom.io/companies/list", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts" + "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" + } ], - "query": [], "variable": [] }, "auth": { @@ -2594,8 +2693,8 @@ } ] }, - "method": "GET", - "description": "You can fetch a list of all contacts (ie. users or leads) in your workspace.\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `50` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", + "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", @@ -2611,29 +2710,30 @@ "response": [] }, { - "name": "Get a contact by External ID", + "name": "Attach a Contact to a Company", "tags": [ + "Companies", "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/find_by_external_id/{external_id}", + "raw": "https://api.intercom.io/contacts/{id}/companies", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "contacts", - "find_by_external_id", - "{external_id}" + "{id}", + "companies" ], "query": [], "variable": [ { - "key": "external_id", - "value": "cdd29344-5e0c-4ef0-ac56-f9ba2979bc27", + "key": "id", + "value": "id", "disabled": false, - "description": "The external ID of the user that you want to retrieve" + "description": "The unique identifier for the contact which is given by Intercom" } ] }, @@ -2657,40 +2757,56 @@ } ] }, - "method": "GET", - "description": "You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads.", + "method": "POST", + "description": "You can attach a company to a single contact.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"58a430d35458202d41b1e65b\"\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Merge a lead and a user", + "name": "Update a company", "tags": [ - "Contacts" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/merge", + "raw": "https://api.intercom.io/companies/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "merge" + "companies", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } + ] }, "auth": { "type": "bearer", @@ -2712,49 +2828,47 @@ } ] }, - "method": "POST", - "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", + "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": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"from\": \"5d70dd30de4efd54f42fd526\",\n \"into\": \"5ba682d23d7cf92bef87bfd4\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Search contacts", + "name": "Delete a company", "tags": [ - "Contacts" + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/search", + "raw": "https://api.intercom.io/companies/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts", - "search" + "companies", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } + ] }, "auth": { "type": "bearer", @@ -2776,48 +2890,56 @@ } ] }, - "method": "POST", - "description": "You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want.\n\nTo search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`.\n\nThis will accept a query object in the body which will define your filters in order to search for contacts.\n\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `50` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n### Contact Creation Delay\n\nIf a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiple's there can be:\n* There's a limit of max 2 nested filters\n* There's a limit of max 15 filters for each AND or OR group\n\n### Searching for Timestamp Fields\n\nAll timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second.\nFor example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards.\nIf you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM).\nThis behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly.\n\n### Accepted Fields\n\nMost key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foorbar\"`).\n\n| Field | Type |\n| ---------------------------------- | ------------------------------ |\n| id | String |\n| role | String
Accepts user or lead |\n| name | String |\n| avatar | String |\n| owner_id | Integer |\n| email | String |\n| email_domain | String |\n| phone | String |\n| formatted_phone | String |\n| external_id | String |\n| created_at | Date (UNIX Timestamp) |\n| signed_up_at | Date (UNIX Timestamp) |\n| updated_at | Date (UNIX Timestamp) |\n| last_seen_at | Date (UNIX Timestamp) |\n| last_contacted_at | Date (UNIX Timestamp) |\n| last_replied_at | Date (UNIX Timestamp) |\n| last_email_opened_at | Date (UNIX Timestamp) |\n| last_email_clicked_at | Date (UNIX Timestamp) |\n| language_override | String |\n| browser | String |\n| browser_language | String |\n| os | String |\n| location.country | String |\n| location.region | String |\n| location.city | String |\n| unsubscribed_from_emails | Boolean |\n| marked_email_as_spam | Boolean |\n| has_hard_bounced | Boolean |\n| ios_last_seen_at | Date (UNIX Timestamp) |\n| ios_app_version | String |\n| ios_device | String |\n| ios_app_device | String |\n| ios_os_version | String |\n| ios_app_name | String |\n| ios_sdk_version | String |\n| android_last_seen_at | Date (UNIX Timestamp) |\n| android_app_version | String |\n| android_device | String |\n| android_app_name | String |\n| andoid_sdk_version | String |\n| segment_id | String |\n| tag_id | String |\n| custom_attributes.{attribute_name} | String |\n\n### Accepted Operators\n\n{% admonition type=\"warning\" name=\"Searching based on `created_at`\" %}\n You cannot use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :------------------------------- | :--------------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In
Shortcut for `OR` queries
Values must be in Array |\n| NIN | All | Not In
Shortcut for `OR !` queries
Values must be in Array |\n| > | Integer
Date (UNIX Timestamp) | Greater than |\n| < | Integer
Date (UNIX Timestamp) | Lower than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "method": "DELETE", + "description": "You can delete a single company.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"query\": {\n \"field\": \"created_at\",\n \"operator\": \"AND\",\n \"value\": \"73732934\"\n },\n \"pagination\": {\n \"per_page\": 2,\n \"starting_after\": \"your-cursor-from-response\"\n }\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Create contact", + "name": "Detach a contact from a company", "tags": [ + "Companies", "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts", + "raw": "https://api.intercom.io/contacts/{contact_id}/companies/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "contacts" + "contacts", + "{contact_id}", + "companies", + "{id}" ], "query": [], - "variable": [] + "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", @@ -2839,39 +2961,36 @@ } ] }, - "method": "POST", - "description": "You can create a new contact (ie. user or lead).", + "method": "DELETE", + "description": "You can detach a company from a single contact.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"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": [] - } + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Contacts", + "item": [ { - "name": "Archive contact", + "name": "List attached companies for contact", "tags": [ - "Contacts" + "Contacts", + "Companies" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/archive", + "raw": "https://api.intercom.io/contacts/{id}/companies", "protocol": "https", "host": [ "api.intercom.io" @@ -2879,7 +2998,7 @@ "path": [ "contacts", "{id}", - "archive" + "companies" ], "query": [], "variable": [ @@ -2887,7 +3006,7 @@ "key": "id", "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "id" + "description": "The unique identifier for the contact which is given by Intercom" } ] }, @@ -2911,8 +3030,8 @@ } ] }, - "method": "POST", - "description": "You can archive a single contact.", + "method": "GET", + "description": "You can fetch a list of companies that are associated to a contact.", "header": [ { "key": "Intercom-Version", @@ -2928,29 +3047,30 @@ "response": [] }, { - "name": "Unarchive contact", + "name": "List attached segments for contact", "tags": [ - "Contacts" + "Contacts", + "Segments" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/unarchive", + "raw": "https://api.intercom.io/contacts/{contact_id}/segments", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "contacts", - "{id}", - "unarchive" + "{contact_id}", + "segments" ], "query": [], "variable": [ { - "key": "id", + "key": "contact_id", "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "id" + "description": "The unique identifier for the contact which is given by Intercom" } ] }, @@ -2974,8 +3094,8 @@ } ] }, - "method": "POST", - "description": "You can unarchive a single contact.", + "method": "GET", + "description": "You can fetch a list of segments that are associated to a contact.", "header": [ { "key": "Intercom-Version", @@ -2991,29 +3111,30 @@ "response": [] }, { - "name": "Block contact", + "name": "List subscriptions for a contact", "tags": [ - "Contacts" + "Contacts", + "Subscription Types" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}/block", + "raw": "https://api.intercom.io/contacts/{contact_id}/subscriptions", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "contacts", - "{id}", - "block" + "{contact_id}", + "subscriptions" ], "query": [], "variable": [ { - "key": "id", + "key": "contact_id", "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "id" + "description": "The unique identifier for the contact which is given by Intercom" } ] }, @@ -3037,8 +3158,8 @@ } ] }, - "method": "POST", - "description": "Block a single contact.
**Note:** conversations of the contact will also be archived during the process.
More details in [FAQ How do I block Inbox spam?](https://www.intercom.com/help/en/articles/8838656-inbox-faqs)", + "method": "GET", + "description": "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", @@ -3054,29 +3175,30 @@ "response": [] }, { - "name": "Update a contact", + "name": "List tags attached to a contact", "tags": [ "Contacts", - "Custom Object Instances" + "Tags" ], "request": { "url": { - "raw": "https://api.intercom.io/contacts/{id}", + "raw": "https://api.intercom.io/contacts/{contact_id}/tags", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "contacts", - "{id}" + "{contact_id}", + "tags" ], "query": [], "variable": [ { - "key": "id", + "key": "contact_id", "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "id" + "description": "The unique identifier for the contact which is given by Intercom" } ] }, @@ -3100,33 +3222,24 @@ } ] }, - "method": "PUT", - "description": "You can update an existing contact (ie. user or lead).\n\n{% admonition type=\"info\" %}\n This endpoint handles both **contact updates** and **custom object associations**.\n\n See _`update a contact with an association to a custom object instance`_ in the request/response examples to see the custom object association format.\n{% /admonition %}\n", + "method": "GET", + "description": "You can fetch a list of all tags that are attached to a specific contact.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"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": [] - } + "body": null }, "response": [] }, { - "name": "Delete a contact", + "name": "Get a contact", "tags": [ "Contacts" ], @@ -3145,7 +3258,7 @@ "variable": [ { "key": "id", - "value": "id", + "value": "63a07ddf05a32042dffac965", "disabled": false, "description": "id" } @@ -3171,8 +3284,8 @@ } ] }, - "method": "DELETE", - "description": "You can delete a single contact.", + "method": "GET", + "description": "You can fetch the details of a single contact.", "header": [ { "key": "Intercom-Version", @@ -3186,39 +3299,23 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Conversations", - "item": [ + }, { - "name": "List all conversations", + "name": "List all contacts", "tags": [ - "Conversations" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations", + "raw": "https://api.intercom.io/contacts", "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." - } + "contacts" ], + "query": [], "variable": [] }, "auth": { @@ -3242,7 +3339,7 @@ ] }, "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", + "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", @@ -3258,39 +3355,29 @@ "response": [] }, { - "name": "Retrieve a conversation", + "name": "Get a contact by External ID", "tags": [ - "Conversations" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}", + "raw": "https://api.intercom.io/contacts/find_by_external_id/{external_id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{id}" - ], - "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." - } + "contacts", + "find_by_external_id", + "{external_id}" ], + "query": [], "variable": [ { - "key": "id", - "value": "123", + "key": "external_id", + "value": "cdd29344-5e0c-4ef0-ac56-f9ba2979bc27", "disabled": false, - "description": "The id of the conversation to target" + "description": "The external ID of the user that you want to retrieve" } ] }, @@ -3315,7 +3402,7 @@ ] }, "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", + "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", @@ -3331,19 +3418,20 @@ "response": [] }, { - "name": "Creates a conversation", + "name": "Merge a lead and a user", "tags": [ - "Conversations" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations", + "raw": "https://api.intercom.io/contacts/merge", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations" + "contacts", + "merge" ], "query": [], "variable": [] @@ -3369,7 +3457,7 @@ ] }, "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", + "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", "header": [ { "key": "Intercom-Version", @@ -3386,7 +3474,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"from\": {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n \"body\": \"Hello\",\n \"created_at\": 1671028894\n}", + "raw": "{\n \"from\": \"5d70dd30de4efd54f42fd526\",\n \"into\": \"5ba682d23d7cf92bef87bfd4\"\n}", "urlencoded": [], "formdata": [] } @@ -3394,19 +3482,19 @@ "response": [] }, { - "name": "Search conversations", + "name": "Search contacts", "tags": [ - "Conversations" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/search", + "raw": "https://api.intercom.io/contacts/search", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", + "contacts", "search" ], "query": [], @@ -3433,7 +3521,7 @@ ] }, "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", + "description": "You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want.\n\nTo search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`.\n\nThis will accept a query object in the body which will define your filters in order to search for contacts.\n\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `50` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n### Contact Creation Delay\n\nIf a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiple's there can be:\n* There's a limit of max 2 nested filters\n* There's a limit of max 15 filters for each AND or OR group\n\n### Searching for Timestamp Fields\n\nAll timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second.\nFor example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards.\nIf you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM).\nThis behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly.\n\n### Accepted Fields\n\nMost key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foorbar\"`).\n\n| Field | Type |\n| ---------------------------------- | ------------------------------ |\n| id | String |\n| role | String
Accepts user or lead |\n| name | String |\n| avatar | String |\n| owner_id | Integer |\n| email | String |\n| email_domain | String |\n| phone | String |\n| formatted_phone | String |\n| external_id | String |\n| created_at | Date (UNIX Timestamp) |\n| signed_up_at | Date (UNIX Timestamp) |\n| updated_at | Date (UNIX Timestamp) |\n| last_seen_at | Date (UNIX Timestamp) |\n| last_contacted_at | Date (UNIX Timestamp) |\n| last_replied_at | Date (UNIX Timestamp) |\n| last_email_opened_at | Date (UNIX Timestamp) |\n| last_email_clicked_at | Date (UNIX Timestamp) |\n| language_override | String |\n| browser | String |\n| browser_language | String |\n| os | String |\n| location.country | String |\n| location.region | String |\n| location.city | String |\n| unsubscribed_from_emails | Boolean |\n| marked_email_as_spam | Boolean |\n| has_hard_bounced | Boolean |\n| ios_last_seen_at | Date (UNIX Timestamp) |\n| ios_app_version | String |\n| ios_device | String |\n| ios_app_device | String |\n| ios_os_version | String |\n| ios_app_name | String |\n| ios_sdk_version | String |\n| android_last_seen_at | Date (UNIX Timestamp) |\n| android_app_version | String |\n| android_device | String |\n| android_app_name | String |\n| andoid_sdk_version | String |\n| segment_id | String |\n| tag_id | String |\n| custom_attributes.{attribute_name} | String |\n\n### Accepted Operators\n\n{% admonition type=\"warning\" name=\"Searching based on `created_at`\" %}\n You cannot use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :------------------------------- | :--------------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In
Shortcut for `OR` queries
Values must be in Array |\n| NIN | All | Not In
Shortcut for `OR !` queries
Values must be in Array |\n| > | Integer
Date (UNIX Timestamp) | Greater than |\n| < | Integer
Date (UNIX Timestamp) | Lower than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", "header": [ { "key": "Intercom-Version", @@ -3458,31 +3546,22 @@ "response": [] }, { - "name": "Reply to a conversation", + "name": "Create contact", "tags": [ - "Conversations" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}/reply", + "raw": "https://api.intercom.io/contacts", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{id}", - "reply" + "contacts" ], "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" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -3505,7 +3584,7 @@ ] }, "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.", + "description": "You can create a new contact (ie. user or lead).", "header": [ { "key": "Intercom-Version", @@ -3522,7 +3601,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"message_type\": \"comment\",\n \"type\": \"admin\",\n \"body\": \"Hello there!\",\n \"created_at\": 1590000000,\n \"attachment_urls\": \"\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"admin_id\": \"3156780\",\n \"attachment_files\": [\n {\n \"content_type\": \"application/json\",\n \"data\": \"ewogICJ0ZXN0IjogMQp9\",\n \"name\": \"test.json\"\n }\n ]\n}", + "raw": "{\n \"role\": \"user\",\n \"external_id\": \"625e90fc55ab113b6d92175f\",\n \"email\": \"jdoe@example.com\",\n \"phone\": \"+353871234567\",\n \"name\": \"John Doe\",\n \"avatar\": \"https://www.example.com/avatar_image.jpg\",\n \"signed_up_at\": 1571672154,\n \"last_seen_at\": 1571672154,\n \"owner_id\": 123,\n \"unsubscribed_from_emails\": true,\n \"language_override\": \"en\",\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 1\n }\n}", "urlencoded": [], "formdata": [] } @@ -3530,29 +3609,29 @@ "response": [] }, { - "name": "Manage a conversation", + "name": "Archive contact", "tags": [ - "Conversations" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}/parts", + "raw": "https://api.intercom.io/contacts/{id}/archive", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", + "contacts", "{id}", - "parts" + "archive" ], "query": [], "variable": [ { "key": "id", - "value": "123", + "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "The identifier for the conversation as given by Intercom." + "description": "id" } ] }, @@ -3577,54 +3656,45 @@ ] }, "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", + "description": "You can archive a single contact.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"message_type\": \"assignment\",\n \"type\": \"admin\",\n \"admin_id\": \"12345\",\n \"body\": \"Let me pass you over to one of my colleagues.\",\n \"snoozed_until\": 1673609604,\n \"assignee_id\": \"4324241\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Attach a contact to a conversation", + "name": "Unarchive contact", "tags": [ - "Conversations" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}/customers", + "raw": "https://api.intercom.io/contacts/{id}/unarchive", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", + "contacts", "{id}", - "customers" + "unarchive" ], "query": [], "variable": [ { "key": "id", - "value": "123", + "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "The identifier for the conversation as given by Intercom." + "description": "id" } ] }, @@ -3649,48 +3719,47 @@ ] }, "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", + "description": "You can unarchive a single contact.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"admin_id\": \"12345\",\n \"customer\": {\n \"intercom_user_id\": \"6329bd9ffe4e2e91dac76188\",\n \"customer\": {\n \"intercom_user_id\": \"6329bd9ffe4e2e91dac76188\",\n \"user_id\": \"2e91dac761886329bd9ffe4e\",\n \"email\": \"sam.sung@example.com\"\n },\n \"user_id\": \"6329bd9ffe4e2e91dac76188\",\n \"email\": \"winstonsmith@truth.org\"\n }\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Redact a conversation part", + "name": "Block contact", "tags": [ - "Conversations" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/redact", + "raw": "https://api.intercom.io/contacts/{id}/block", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "redact" + "contacts", + "{id}", + "block" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "63a07ddf05a32042dffac965", + "disabled": false, + "description": "id" + } + ] }, "auth": { "type": "bearer", @@ -3713,54 +3782,45 @@ ] }, "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", + "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": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"source\",\n \"conversation_id\": \"19894788788\",\n \"conversation_part_id\": \"19381789428\",\n \"source_id\": \"19894781231\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] }, { - "name": "Convert a conversation to a ticket", + "name": "Update a contact", "tags": [ - "Conversations" + "Contacts", + "Custom Object Instances" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}/convert", + "raw": "https://api.intercom.io/contacts/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{id}", - "convert" + "contacts", + "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "123", + "value": "63a07ddf05a32042dffac965", "disabled": false, - "description": "The id of the conversation to target" + "description": "id" } ] }, @@ -3784,8 +3844,8 @@ } ] }, - "method": "POST", - "description": "You can convert a conversation to a ticket.", + "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", @@ -3802,7 +3862,7 @@ ], "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}", + "raw": "{\n \"role\": \"\",\n \"external_id\": \"\",\n \"email\": \"jdoe@example.com\",\n \"phone\": \"+353871234567\",\n \"name\": \"John Doe\",\n \"avatar\": \"https://www.example.com/avatar_image.jpg\",\n \"signed_up_at\": 1571672154,\n \"last_seen_at\": 1571672154,\n \"owner_id\": 123,\n \"unsubscribed_from_emails\": true,\n \"language_override\": \"en\",\n \"custom_attributes\": \"\"\n}", "urlencoded": [], "formdata": [] } @@ -3810,35 +3870,28 @@ "response": [] }, { - "name": "Update a conversation", + "name": "Delete a contact", "tags": [ - "Conversations", - "Custom Object Instances" + "Contacts" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}", + "raw": "https://api.intercom.io/contacts/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", + "contacts", "{id}" ], - "query": [ - { - "key": "display_as", - "value": "plaintext", - "description": "Set to plaintext to retrieve conversation messages in plain text." - } - ], + "query": [], "variable": [ { "key": "id", - "value": "123", + "value": "id", "disabled": false, - "description": "The id of the conversation to target" + "description": "id" } ] }, @@ -3862,56 +3915,55 @@ } ] }, - "method": "PUT", - "description": "\nYou can update an existing conversation.\n\n{% admonition type=\"info\" name=\"Replying and other actions\" %}\nIf you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints.\n{% /admonition %}\n\n{% admonition type=\"info\" %}\n This endpoint handles both **conversation updates** and **custom object associations**.\n\n See _`update a conversation with an association to a custom object instance`_ in the request/response examples to see the custom object association format.\n{% /admonition %}\n\n", + "method": "DELETE", + "description": "You can delete a single contact.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"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": [] - } + "body": null }, "response": [] - }, + } + ] + }, + { + "name": "Content Snippets", + "item": [ { - "name": "Delete a conversation", + "name": "List all content snippets", "tags": [ - "Conversations" + "Content Snippets" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{id}", + "raw": "https://api.intercom.io/content_snippets", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{id}" + "content_snippets" ], - "query": [], - "variable": [ + "query": [ { - "key": "id", - "value": "id", - "disabled": false, - "description": "id" + "key": "page", + "value": "page", + "description": "The page of results to fetch." + }, + { + "key": "per_page", + "value": "per_page", + "description": "The number of results to return per page. Max value of 50." } - ] + ], + "variable": [] }, "auth": { "type": "bearer", @@ -3933,8 +3985,8 @@ } ] }, - "method": "DELETE", - "description": "You can delete a single conversation.", + "method": "GET", + "description": "You can fetch a list of all content snippets for a workspace.", "header": [ { "key": "Intercom-Version", @@ -3950,36 +4002,28 @@ "response": [] }, { - "name": "Detach a contact from a group conversation", + "name": "Retrieve a content snippet", "tags": [ - "Conversations" + "Content Snippets" ], "request": { "url": { - "raw": "https://api.intercom.io/conversations/{conversation_id}/customers/{contact_id}", + "raw": "https://api.intercom.io/content_snippets/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "conversations", - "{conversation_id}", - "customers", - "{contact_id}" + "content_snippets", + "{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", + "key": "id", + "value": "id", "disabled": false, - "description": "The identifier for the contact as given by Intercom." + "description": "The unique identifier for the content snippet." } ] }, @@ -4003,51 +4047,36 @@ } ] }, - "method": "DELETE", - "description": "You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.\n\n{% admonition type=\"warning\" name=\"Contacts without an email\" %}\nIf you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`.\n{% /admonition %}\n\n", + "method": "GET", + "description": "You can fetch a single content snippet by its id.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"admin_id\": \"5017690\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] - } - ] - }, - { - "name": "Custom Channel Events", - "item": [ + }, { - "name": "Notify Intercom of a new conversation created in a custom channel", + "name": "Create a content snippet", "tags": [ - "Custom Channel Events" + "Content Snippets" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_channel_events/notify_new_conversation", + "raw": "https://api.intercom.io/content_snippets", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_channel_events", - "notify_new_conversation" + "content_snippets" ], "query": [], "variable": [] @@ -4073,7 +4102,7 @@ ] }, "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", + "description": "You can create a new content snippet.", "header": [ { "key": "Intercom-Version", @@ -4090,7 +4119,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"event_id\": \"\",\n \"external_conversation_id\": \"\",\n \"contact\": {\n \"type\": \"user\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n}", + "raw": "{\n \"title\": \"How to reset your password\",\n \"json_blocks\": [\n {\n \"type\": \"paragraph\",\n \"text\": \"Navigate to Settings > Security > Reset password.\"\n }\n ],\n \"locale\": \"en\"\n}", "urlencoded": [], "formdata": [] } @@ -4098,23 +4127,30 @@ "response": [] }, { - "name": "Notify Intercom of a new message in a custom channel conversation", + "name": "Update a content snippet", "tags": [ - "Custom Channel Events" + "Content Snippets" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_channel_events/notify_new_message", + "raw": "https://api.intercom.io/content_snippets/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_channel_events", - "notify_new_message" + "content_snippets", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the content snippet." + } + ] }, "auth": { "type": "bearer", @@ -4136,8 +4172,8 @@ } ] }, - "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", + "method": "PUT", + "description": "You can update an existing content snippet.", "header": [ { "key": "Intercom-Version", @@ -4154,30 +4190,45 @@ ], "body": { "mode": "raw", - "raw": "{\n \"event_id\": \"\",\n \"external_conversation_id\": \"\",\n \"contact\": {\n \"type\": \"user\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"body\": \"\"\n}", + "raw": "{\n \"title\": \"How to reset your password\",\n \"json_blocks\": [\n {\n \"type\": \"paragraph\",\n \"text\": \"Navigate to Settings > Security > Reset password.\"\n }\n ],\n \"locale\": \"en\"\n}", "urlencoded": [], "formdata": [] } }, "response": [] - }, + } + ] + }, + { + "name": "Conversations", + "item": [ { - "name": "Notify Intercom of a quick reply response in a custom channel conversation", + "name": "List all conversations", "tags": [ - "Custom Channel Events" + "Conversations" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_channel_events/notify_quick_reply_selected", + "raw": "https://api.intercom.io/conversations", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_channel_events", - "notify_quick_reply_selected" + "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." + } ], - "query": [], "variable": [] }, "auth": { @@ -4200,49 +4251,63 @@ } ] }, - "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", + "method": "GET", + "description": "You can fetch a list of all conversations.\n\nYou can optionally request the result page size and the cursor to start after to fetch the result.\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "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": [] - } + "body": null }, "response": [] }, { - "name": "Notify Intercom of an attribute collector response in a custom channel conversation", + "name": "Retrieve a conversation", "tags": [ - "Custom Channel Events" + "Conversations" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_channel_events/notify_attribute_collected", + "raw": "https://api.intercom.io/conversations/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_channel_events", - "notify_attribute_collected" + "conversations", + "{id}" ], - "query": [], - "variable": [] + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text. This affects both the body and subject fields." + }, + { + "key": "include_translations", + "value": "true", + "description": "If set to true, conversation parts will be translated to the detected language of the conversation." + }, + { + "key": "include_email_history", + "value": "true", + "description": "If set to true, the source of the conversation will include the email history." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } + ] }, "auth": { "type": "bearer", @@ -4264,53 +4329,1483 @@ } ] }, - "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", + "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": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"event_id\": \"\",\n \"external_conversation_id\": \"\",\n \"contact\": {\n \"type\": \"user\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attribute\": {\n \"id\": \"\",\n \"value\": \"\"\n }\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] - } - ] - }, - { - "name": "Custom Object Instances", - "item": [ + }, { - "name": "Get Custom Object Instance by External ID", + "name": "List handling events", "tags": [ - "Custom Object Instances" + "Conversations" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "raw": "https://api.intercom.io/conversations/{id}/handling_events", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}" + "conversations", + "{id}", + "handling_events" ], - "query": [ + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "List all pause/resume events for a conversation. These events track when teammates paused or resumed handling a conversation.\n\nRequires the `read_conversations` OAuth scope.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List side conversations", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/side_conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "side_conversations" + ], + "query": [ + { + "key": "page", + "value": "page", + "description": "The page number of results to return (starting from 1)." + }, + { + "key": "per_page", + "value": "per_page", + "description": "The number of side conversations to return per page (max 50)." + } + ], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "List side conversations for a given conversation. Side conversations are internal threads created by teammates from within a conversation.\n\nEach side conversation includes its conversation parts (messages). Results are paginated.\n\nRequires the `read_conversations` OAuth scope.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List all deleted conversation IDs", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/deleted", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "deleted" + ], + "query": [ + { + "key": "page", + "value": "1", + "description": "The page of results to fetch. Defaults to first page" + }, + { + "key": "per_page", + "value": "per_page", + "description": "How many results per page" + }, + { + "key": "order", + "value": "desc", + "description": "`asc` or `desc`. Returns the conversation IDs in ascending or descending order. Defaults to desc" + } + ], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "List all deleted conversation IDs.\n\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `20` results per page. You can navigate to next pages using the `page` param.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Creates a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can create a conversation that has been initiated by a contact (ie. user or lead).\nThe conversation can be an in-app message only.\n\n{% admonition type=\"info\" name=\"Sending for visitors\" %}\nYou can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`.\nThis visitor will be automatically converted to a contact with a lead role once the conversation is created.\n{% /admonition %}\n\nThis will return the Message model that has been created.\n\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"from\": {\n \"type\": \"user\",\n \"id\": \"536e564f316c83104c000020\"\n },\n \"body\": \"Hello\",\n \"subject\": \"Thanks for everything\",\n \"attachment_urls\": \"\",\n \"created_at\": 1671028894\n}", + "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": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": {\n \"field\": \"created_at\",\n \"operator\": \"AND\",\n \"value\": \"73732934\"\n },\n \"pagination\": {\n \"per_page\": 2,\n \"starting_after\": \"your-cursor-from-response\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Reply to a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "reply" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123 or \"last\"", + "disabled": false, + "description": "The Intercom provisioned identifier for the conversation or the string \"last\" to reply to the last part of the conversation" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"message_type\": \"comment\",\n \"type\": \"admin\",\n \"body\": \"Hello there!\",\n \"created_at\": 1590000000,\n \"attachment_urls\": \"\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"admin_id\": \"3156780\",\n \"attachment_files\": [\n {\n \"content_type\": \"application/json\",\n \"data\": \"ewogICJ0ZXN0IjogMQp9\",\n \"name\": \"test.json\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } + }, + "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": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"message_type\": \"assignment\",\n \"type\": \"admin\",\n \"admin_id\": \"12345\",\n \"body\": \"Let me pass you over to one of my colleagues.\",\n \"snoozed_until\": 1673609604,\n \"assignee_id\": \"4324241\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "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": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"12345\",\n \"customer\": {\n \"intercom_user_id\": \"6329bd9ffe4e2e91dac76188\",\n \"customer\": {\n \"intercom_user_id\": \"6329bd9ffe4e2e91dac76188\",\n \"user_id\": \"2e91dac761886329bd9ffe4e\",\n \"email\": \"sam.sung@example.com\"\n },\n \"user_id\": \"6329bd9ffe4e2e91dac76188\",\n \"email\": \"winstonsmith@truth.org\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "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": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"source\",\n \"conversation_id\": \"19894788788\",\n \"conversation_part_id\": \"19381789428\",\n \"source_id\": \"19894781231\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Convert a conversation to a ticket", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}/convert", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}", + "convert" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The id of the conversation to target" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can convert a conversation to a ticket.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ticket_type_id\": \"1234\",\n \"ticket_state_id\": \"123\",\n \"attributes\": {\n \"_default_title_\": \"Found a bug\",\n \"_default_description_\": \"The button is not working\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Update a conversation", + "tags": [ + "Conversations", + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}" + ], + "query": [ + { + "key": "display_as", + "value": "plaintext", + "description": "Set to plaintext to retrieve conversation messages in plain text. This affects both the body and subject fields." + } + ], + "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": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"read\": true,\n \"title\": \"Conversation Title\",\n \"custom_attributes\": {\n \"paid_subscriber\": true,\n \"monthly_spend\": 155.5,\n \"team_mates\": 9,\n \"start_date_iso8601\": \"2023-03-04T09:46:14Z\",\n \"end_date_timestamp\": 1677923174,\n \"CX Score rating\": 4,\n \"CX Score explanation\": \"The conversation was resolved quickly and the customer expressed satisfaction with the outcome.\"\n },\n \"company_id\": \"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Update a conversation part", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{conversation_id}/conversation_parts/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{conversation_id}", + "conversation_parts", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "conversation_id", + "value": "123", + "disabled": false, + "description": "The identifier for the conversation as given by Intercom." + }, + { + "key": "id", + "value": "456", + "disabled": false, + "description": "The identifier for the conversation part." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "PUT", + "description": "You can update properties of a conversation part. Currently supports updating the send state of an external reply or marking a part as seen by an admin.\n\n{% admonition type=\"warning\" name=\"Experimental\" %}\n This is an experimental endpoint. It requires a valid HMAC secret for authentication in addition to the standard bearer token.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"send_state\": \"sent\",\n \"info_message\": \"Message delivered successfully\",\n \"seen\": true,\n \"admin_id\": \"991267694\",\n \"experimental\": true,\n \"secret\": \"hmac_secret_value\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete a conversation", + "tags": [ + "Conversations" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/conversations/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "conversations", + "{id}" + ], + "query": [ + { + "key": "retain_metrics", + "value": "true", + "description": "If true (default), deletes the conversation while retaining reporting data. If false, deletes the conversation and all associated reporting data. Setting to false requires the `delete_conversations_and_metrics` OAuth scope." + } + ], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "id" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "{% admonition type=\"warning\" name=\"Irreversible operation\" %}\nDeleting a conversation is permanent and cannot be reversed.\n{% /admonition %}\n\nYou can delete a single conversation. The behavior depends on the `retain_metrics` parameter:\n\n- **With `retain_metrics=true` (default)**: Deletes the conversation while retaining reporting data. The conversation will still appear in reporting, though some data may be incomplete due to the deletion.\n\n- **With `retain_metrics=false`**: Deletes the conversation and all associated reporting data. The conversation will be completely removed from both the inbox and all reporting.\n\n{% admonition type=\"info\" name=\"Required scope for retain_metrics=false\" %}\nUsing `retain_metrics=false` requires the `delete_conversations_and_metrics` OAuth scope.\n{% /admonition %}\n\nFor more info, see [this help center article](https://www.intercom.com/help/en/articles/13885146-deleting-a-conversation).\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "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": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"admin_id\": \"5017690\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, + { + "name": "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": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"event_id\": \"\",\n \"external_conversation_id\": \"\",\n \"contact\": {\n \"type\": \"user\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "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": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"event_id\": \"\",\n \"external_conversation_id\": \"\",\n \"contact\": {\n \"type\": \"user\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"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": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"event_id\": \"\",\n \"external_conversation_id\": \"\",\n \"contact\": {\n \"type\": \"user\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"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": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"event_id\": \"\",\n \"external_conversation_id\": \"\",\n \"contact\": {\n \"type\": \"user\",\n \"external_id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"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": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Get Custom Object Instance by ID", + "tags": [ + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The id or external_id of the custom object instance" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Fetch a Custom Object Instance by id.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Create or Update a Custom Object Instance", + "tags": [ + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Create or update a custom object instance", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"external_id\": \"\",\n \"external_created_at\": 1571672154,\n \"external_updated_at\": 1571672154,\n \"custom_attributes\": \"\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Delete a Custom Object Instance by External ID", + "tags": [ + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}" + ], + "query": [ { "key": "external_id", "value": "external_id" @@ -4338,8 +5833,141 @@ } ] }, + "method": "DELETE", + "description": "Delete a single Custom Object instance by external_id.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "Delete a Custom Object Instance by ID", + "tags": [ + "Custom Object Instances" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "custom_object_instances", + "{custom_object_type_identifier}", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The Intercom defined id of the custom object instance" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "DELETE", + "description": "Delete a single Custom Object instance using the Intercom defined id.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Data Attributes", + "item": [ + { + "name": "List all data attributes", + "tags": [ + "Data Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/data_attributes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_attributes" + ], + "query": [ + { + "key": "model", + "value": "company", + "description": "Specify the data attribute model to return." + }, + { + "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": "Fetch a Custom Object Instance by external_id.", + "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", "header": [ { "key": "Intercom-Version", @@ -4355,29 +5983,91 @@ "response": [] }, { - "name": "Get Custom Object Instance by ID", + "name": "Create a data attribute", "tags": [ - "Custom Object Instances" + "Data Attributes" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "raw": "https://api.intercom.io/data_attributes", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}", + "data_attributes" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can create a data attributes for a `contact` or a `company`.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data_type\": \"\",\n \"options\": [\n {\n \"value\": \"1-10\"\n },\n {\n \"value\": \"11-50\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Update a data attribute", + "tags": [ + "Data Attributes" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/data_attributes/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_attributes", "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "id", + "value": "1", "disabled": false, - "description": "The id or external_id of the custom object instance" + "description": "The data attribute id" } ] }, @@ -4401,40 +6091,61 @@ } ] }, - "method": "GET", - "description": "Fetch a Custom Object Instance by id.", + "method": "PUT", + "description": "\nYou can update a data attribute.\n\n> 🚧 Updating the data type is not possible\n>\n> It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"options\": [\n {\n \"value\": \"1-10\"\n },\n {\n \"value\": \"11-50\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] - }, + } + ] + }, + { + "name": "Data Connectors", + "item": [ { - "name": "Create or Update a Custom Object Instance", + "name": "Update a data connector", "tags": [ - "Custom Object Instances" + "Data Connectors" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "raw": "https://api.intercom.io/data_connectors/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}" + "data_connectors", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "12345", + "disabled": false, + "description": "The unique identifier of the data connector." + } + ] }, "auth": { "type": "bearer", @@ -4456,8 +6167,8 @@ } ] }, - "method": "POST", - "description": "Create or update a custom object instance", + "method": "PATCH", + "description": "Update an existing data connector. Only provided fields are changed. Set `state` to `live` or `draft` to change the connector's state.\n", "header": [ { "key": "Intercom-Version", @@ -4474,7 +6185,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"external_id\": \"\",\n \"external_created_at\": 1571672154,\n \"external_updated_at\": 1571672154,\n \"custom_attributes\": \"\"\n}", + "raw": "{\n \"name\": \"Updated Connector Name\",\n \"description\": \"Updated description\",\n \"state\": \"draft\",\n \"http_method\": \"post\",\n \"url\": \"https://api.example.com/orders/{{order_id}}/status\",\n \"body\": \"\",\n \"direct_fin_usage\": false,\n \"audiences\": [\n \"leads\",\n \"users\"\n ],\n \"headers\": [\n {\n \"name\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"data_inputs\": [\n {\n \"name\": \"order_id\",\n \"type\": \"string\",\n \"description\": \"The order ID to look up\",\n \"required\": true,\n \"default_value\": \"\"\n }\n ],\n \"customer_authentication\": false,\n \"bypass_authentication\": false,\n \"validate_missing_attributes\": true,\n \"mock_response\": {\n \"order\": {\n \"id\": 12345,\n \"status\": \"shipped\"\n }\n },\n \"token_ids\": [\n \"1234\",\n \"5678\"\n ]\n}", "urlencoded": [], "formdata": [] } @@ -4482,25 +6193,30 @@ "response": [] }, { - "name": "Delete a Custom Object Instance by External ID", + "name": "List all data connectors", "tags": [ - "Custom Object Instances" + "Data Connectors" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}", + "raw": "https://api.intercom.io/data_connectors", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}" + "data_connectors" ], "query": [ { - "key": "external_id", - "value": "external_id" + "key": "per_page", + "value": "per_page", + "description": "The number of results to return per page. Defaults to 20, minimum 1, maximum 50." + }, + { + "key": "starting_after", + "value": "starting_after", + "description": "The cursor value from `pages.next.starting_after` in a previous response. Used to paginate through results." } ], "variable": [] @@ -4525,8 +6241,8 @@ } ] }, - "method": "DELETE", - "description": "Delete a single Custom Object instance by external_id.", + "method": "GET", + "description": "Returns a paginated list of all data connectors for the workspace, ordered by most recently updated first. Data connectors allow workflows and AI agents to make HTTP requests to external APIs.\n", "header": [ { "key": "Intercom-Version", @@ -4542,29 +6258,138 @@ "response": [] }, { - "name": "Delete a Custom Object Instance by ID", + "name": "Retrieve a data connector", "tags": [ - "Custom Object Instances" + "Data Connectors" ], "request": { "url": { - "raw": "https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}", + "raw": "https://api.intercom.io/data_connectors/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "custom_object_instances", - "{custom_object_type_identifier}", + "data_connectors", "{id}" ], - "query": [], + "query": [ + { + "key": "state_version", + "value": "state_version", + "description": "Which version of the data connector to return. Defaults to live." + } + ], + "variable": [ + { + "key": "id", + "value": "12345", + "disabled": false, + "description": "The unique identifier of the data connector." + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can retrieve the full detail of a single data connector by its ID.\n\nThe response includes configuration, data inputs, response fields, and object mappings.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List execution results for a data connector", + "tags": [ + "Data Connectors" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/data_connectors/{data_connector_id}/execution_results", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "data_connectors", + "{data_connector_id}", + "execution_results" + ], + "query": [ + { + "key": "per_page", + "value": "per_page", + "description": "The number of results per page (1-30, default 10)." + }, + { + "key": "starting_after", + "value": "starting_after", + "description": "Cursor for pagination. Use the value from `pages.next.starting_after` in a previous response." + }, + { + "key": "success", + "value": "success", + "description": "Filter by success status. Use `true`, `false`, or omit for all." + }, + { + "key": "error_type", + "value": "error_type", + "description": "Filter by error type." + }, + { + "key": "start_ts", + "value": "start_ts", + "description": "Unix timestamp for start of time range (default 1 hour ago)." + }, + { + "key": "end_ts", + "value": "end_ts", + "description": "Unix timestamp for end of time range (default now)." + }, + { + "key": "include_bodies", + "value": "include_bodies", + "description": "Include request/response bodies in the response (default false)." + }, + { + "key": "include_request_url", + "value": "include_request_url", + "description": "Include the request URL in the response (default false)." + } + ], "variable": [ { - "key": "id", - "value": "id", + "key": "data_connector_id", + "value": "data_connector_id", "disabled": false, - "description": "The Intercom defined id of the custom object instance" + "description": "The unique identifier for the data connector." } ] }, @@ -4588,8 +6413,8 @@ } ] }, - "method": "DELETE", - "description": "Delete a single Custom Object instance using the Intercom defined id.", + "method": "GET", + "description": "Retrieve paginated execution logs for a specific data connector.\nResults from the last hour are returned by default. Use `start_ts` and `end_ts` to customize the time range.\n\nRequest/response bodies and request URL are excluded by default.\nUse `include_bodies=true` to include bodies.\nUse `include_request_url=true` to include the sanitised request URL.\n", "header": [ { "key": "Intercom-Version", @@ -4603,40 +6428,40 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Data Attributes", - "item": [ + }, { - "name": "List all data attributes", + "name": "Retrieve an execution result", "tags": [ - "Data Attributes" + "Data Connectors" ], "request": { "url": { - "raw": "https://api.intercom.io/data_attributes", + "raw": "https://api.intercom.io/data_connectors/{data_connector_id}/execution_results/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "data_attributes" + "data_connectors", + "{data_connector_id}", + "execution_results", + "{id}" ], - "query": [ + "query": [], + "variable": [ { - "key": "model", - "value": "company", - "description": "Specify the data attribute model to return." + "key": "data_connector_id", + "value": "data_connector_id", + "disabled": false, + "description": "The unique identifier for the data connector." }, { - "key": "include_archived", - "value": "include_archived", - "description": "Include archived attributes in the list. By default we return only non archived data attributes." + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the execution result." } - ], - "variable": [] + ] }, "auth": { "type": "bearer", @@ -4659,7 +6484,7 @@ ] }, "method": "GET", - "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "description": "Retrieve details for a specific data connector execution result.\nAlways includes request/response bodies and the sanitised request URL.\n", "header": [ { "key": "Intercom-Version", @@ -4675,19 +6500,19 @@ "response": [] }, { - "name": "Create a data attribute", + "name": "Create a data connector", "tags": [ - "Data Attributes" + "Data Connectors" ], "request": { "url": { - "raw": "https://api.intercom.io/data_attributes", + "raw": "https://api.intercom.io/data_connectors", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "data_attributes" + "data_connectors" ], "query": [], "variable": [] @@ -4713,7 +6538,7 @@ ] }, "method": "POST", - "description": "You can create a data attributes for a `contact` or a `company`.", + "description": "Create a new data connector. The connector is created in `draft` state. Configure its URL, headers, data inputs, and other settings, then set it to `live` when ready.\n", "header": [ { "key": "Intercom-Version", @@ -4730,7 +6555,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"data_type\": \"\",\n \"options\": [\n {\n \"value\": \"1-10\"\n },\n {\n \"value\": \"11-50\"\n }\n ]\n}", + "raw": "{\n \"name\": \"Get Order Status\",\n \"description\": \"Looks up order status from an external service\",\n \"http_method\": \"get\",\n \"url\": \"https://api.example.com/orders/{{order_id}}/status\",\n \"body\": \"\",\n \"direct_fin_usage\": false,\n \"audiences\": [\n \"leads\",\n \"visitors\"\n ],\n \"headers\": [\n {\n \"name\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"data_inputs\": [\n {\n \"name\": \"order_id\",\n \"type\": \"string\",\n \"description\": \"The order ID to look up\",\n \"required\": true,\n \"default_value\": \"\"\n }\n ],\n \"customer_authentication\": false,\n \"bypass_authentication\": false,\n \"validate_missing_attributes\": false,\n \"mock_response\": {\n \"order\": {\n \"id\": 12345,\n \"status\": \"shipped\"\n }\n },\n \"token_ids\": [\n \"1234\",\n \"5678\"\n ]\n}", "urlencoded": [], "formdata": [] } @@ -4738,28 +6563,28 @@ "response": [] }, { - "name": "Update a data attribute", + "name": "Delete a data connector", "tags": [ - "Data Attributes" + "Data Connectors" ], "request": { "url": { - "raw": "https://api.intercom.io/data_attributes/{id}", + "raw": "https://api.intercom.io/data_connectors/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "data_attributes", + "data_connectors", "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "1", + "value": "12345", "disabled": false, - "description": "The data attribute id" + "description": "The unique identifier of the data connector" } ] }, @@ -4783,28 +6608,19 @@ } ] }, - "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", + "method": "DELETE", + "description": "Delete an existing data connector. The connector must be in `draft` state and must not be in use by any workflows or AI agents.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "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": [] - } + "body": null }, "response": [] } @@ -5393,6 +7209,139 @@ } ] }, + { + "name": "Fin Agent", + "item": [ + { + "name": "Start a conversation with Fin", + "tags": [ + "Fin Agent" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin/start", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin", + "start" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Initialize Fin by passing it the user's message along with conversation history and user details.\n\nThese additional pieces of context will be used by Fin to provide a better and more contextual answer to the user.\n\n{% admonition type=\"warning\" %}\nPlease reach out to your accounts team to discuss access.\n{% /admonition %}\n\nOnce Fin is initialized, it progresses through a series of statuses such as *thinking*, *replying*, *awaiting_user_reply*, or *resolved* before ending with a status of *complete*.\n\nDuring this workflow, the client should allow Fin to continue uninterrupted until a final *complete* status is returned, at which point control of the conversation passes back to the client.\n\nEvents can be received via webhooks or Server-Sent Events (SSE) using the `sse_subscription_url` in the response.\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"conversation_id\": \"ext-123\",\n \"message\": {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n },\n \"user\": {\n \"id\": \"123456\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"attributes\": {\n \"plan_type\": \"Pro\",\n \"subscription_status\": \"active\"\n }\n },\n \"attachments\": [\n {\n \"type\": \"url\",\n \"url\": \"https://example.com/document.pdf\",\n \"name\": \"screenshot.png\",\n \"content_type\": \"image/png\",\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk...\"\n }\n ],\n \"conversation_metadata\": {\n \"history\": [\n {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n }\n ],\n \"attributes\": {\n \"priority_level\": \"high\",\n \"department\": \"sales\"\n }\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, + { + "name": "Reply to Fin", + "tags": [ + "Fin Agent" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/fin/reply", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "fin", + "reply" + ], + "query": [], + "variable": [] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "Once Fin has returned a response to a user's message, its status will be `awaiting_user_reply`.\n\nIf a user replies, use this endpoint to send this response to Fin.\n\n{% admonition type=\"warning\" %}\nPlease reach out to your accounts team to discuss access.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"conversation_id\": \"123456\",\n \"message\": {\n \"author\": \"user\",\n \"body\": \"How can I see my account details?\",\n \"timestamp\": \"2025-01-24T10:01:20.000Z\",\n \"timestamp_ms\": \"2025-01-24T10:01:20.456Z\"\n },\n \"user\": {\n \"id\": \"123456\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"attributes\": {\n \"plan_type\": \"Pro\",\n \"subscription_status\": \"active\"\n }\n },\n \"attachments\": [\n {\n \"type\": \"url\",\n \"url\": \"https://example.com/document.pdf\",\n \"name\": \"screenshot.png\",\n \"content_type\": \"image/png\",\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk...\"\n }\n ]\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + } + ] + }, { "name": "Help Center", "item": [ @@ -5972,7 +7921,7 @@ { "key": "folder_id", "value": "123", - "description": "The ID of the folder to search in." + "description": "The ID of the folder to search in. Results will include articles from this folder and all its descendant folders." } ], "variable": [] @@ -6069,7 +8018,7 @@ ], "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}", + "raw": "{\n \"title\": \"Thanks for everything\",\n \"body\": \"

This is the body in html

\",\n \"author_id\": 1295,\n \"owner_id\": 1295,\n \"folder_id\": 6\n}", "urlencoded": [], "formdata": [] } @@ -6140,7 +8089,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"title\": \"Thanks for everything\",\n \"body\": \"\",\n \"author_id\": 1295,\n \"owner_id\": 1295\n}", + "raw": "{\n \"title\": \"Thanks for everything\",\n \"body\": \"\",\n \"author_id\": 1295,\n \"owner_id\": 1295,\n \"folder_id\": 6\n}", "urlencoded": [], "formdata": [] } @@ -6365,18 +8314,95 @@ "api.intercom.io" ], "path": [ - "macros", - "{id}" + "macros", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "123", + "disabled": false, + "description": "The unique identifier of the macro" + } + ] + }, + "auth": { + "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 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", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, + { + "name": "Messages", + "item": [ + { + "name": "Get statuses of all messages sent based on the specified ruleset_id", + "tags": [ + "Messages", + "WhatsApp" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/messages/status", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "messages", + "status" ], - "query": [], - "variable": [ + "query": [ { - "key": "id", - "value": "123", - "disabled": false, - "description": "The unique identifier of the macro" + "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", @@ -6399,7 +8425,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": "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", @@ -6413,44 +8439,30 @@ "body": null }, "response": [] - } - ] - }, - { - "name": "Messages", - "item": [ + }, { - "name": "Get statuses of all messages sent based on the specified ruleset_id", + "name": "Retrieve WhatsApp message delivery status", "tags": [ "Messages", "WhatsApp" ], "request": { "url": { - "raw": "https://api.intercom.io/messages/status", + "raw": "https://api.intercom.io/messages/whatsapp/status", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ "messages", + "whatsapp", "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" + "key": "message_id", + "value": "message_id", + "description": "The WhatsApp message ID to check status for" } ], "variable": [] @@ -6476,7 +8488,7 @@ ] }, "method": "GET", - "description": "Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages.\n\n\nThis endpoint returns paginated status events for WhatsApp messages sent via the Outbound module, providing\ninformation about delivery state and related message details.\n", + "description": "Retrieves the delivery status of a specific WhatsApp message by its message ID.\n\n\nReturns the current status, conversation details, and any error information if the message failed to deliver.\n", "header": [ { "key": "Intercom-Version", @@ -7063,7 +9075,71 @@ "name": "Notes", "item": [ { - "name": "List all notes", + "name": "List all company notes", + "tags": [ + "Notes", + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/companies/{company_id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "{company_id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "company_id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "You can fetch a list of notes that are associated to a company.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + }, + { + "name": "List all contact notes", "tags": [ "Notes", "Contacts" @@ -7188,6 +9264,79 @@ }, "response": [] }, + { + "name": "Create a company note", + "tags": [ + "Notes", + "Companies" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/companies/{company_id}/notes", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "companies", + "{company_id}", + "notes" + ], + "query": [], + "variable": [ + { + "key": "company_id", + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "disabled": false, + "description": "The unique identifier for the company which is given by Intercom" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "POST", + "description": "You can add a note to a single company.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"body\": \"New note\",\n \"admin_id\": \"991267583\"\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, { "name": "Create a note", "tags": [ @@ -7652,7 +9801,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 \"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 \"CX Score rating\": 4,\n \"CX Score explanation\": \"The conversation was resolved quickly and the customer expressed satisfaction with the outcome.\"\n }\n}", "urlencoded": [], "formdata": [] } @@ -8303,10 +10452,93 @@ "description": "ticket_id" }, { - "key": "id", - "value": "7522907", + "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": "Preview" + }, + { + "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": "Retrieve team metrics", + "tags": [ + "Teams" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/teams/{team_id}/metrics", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "teams", + "{team_id}", + "metrics" + ], + "query": [ + { + "key": "idle_threshold", + "value": "idle_threshold", + "description": "The number of seconds after which an open conversation is considered idle. Clamped to the range 1–86400. Defaults to 1800 (30 minutes)." + } + ], + "variable": [ + { + "key": "team_id", + "value": "42", "disabled": false, - "description": "The unique identifier for the tag which is given by Intercom" + "description": "The unique identifier of the team to retrieve metrics for. Use `GET /teams` to list available team IDs." } ] }, @@ -8330,36 +10562,22 @@ } ] }, - "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": "GET", + "description": "Returns real-time activity metrics for admins in the specified team. For each admin, the response includes counts of open, idle, and snoozed conversations.\n\nThis endpoint requires the `realtime_monitoring` feature to be enabled for your workspace.\n", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"admin_id\": \"123\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] - } - ] - }, - { - "name": "Teams", - "item": [ + }, { "name": "List all teams", "tags": [ @@ -8973,7 +11191,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.\n{% admonition type=\"info\" name=\"Not the Inbox ticket ID\" %}\nThis is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.\n{% /admonition %}\n" } ] }, @@ -9077,7 +11295,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"message_type\": \"comment\",\n \"type\": \"admin\",\n \"body\": \"Hello there!\",\n \"created_at\": 1590000000,\n \"attachment_urls\": \"\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"admin_id\": \"3156780\"\n}", + "raw": "{\n \"message_type\": \"comment\",\n \"type\": \"admin\",\n \"body\": \"Hello there!\",\n \"created_at\": 1590000000,\n \"attachment_urls\": \"\",\n \"reply_options\": [\n {\n \"text\": \"\",\n \"uuid\": \"\"\n }\n ],\n \"admin_id\": \"3156780\",\n \"cross_post\": true\n}", "urlencoded": [], "formdata": [] } @@ -9211,6 +11429,78 @@ }, "response": [] }, + { + "name": "Change ticket type", + "tags": [ + "Tickets" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/tickets/{ticket_id}/change_type", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "tickets", + "{ticket_id}", + "change_type" + ], + "query": [], + "variable": [ + { + "key": "ticket_id", + "value": "ticket_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": "POST", + "description": "You can change the type of a ticket. The new ticket type must be in the same category as the current type. Attributes matching by name and type are automatically transferred from the old type; values provided in ticket_attributes override transferred values.", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"ticket_type_id\": \"1234\",\n \"ticket_state_id\": \"5678\",\n \"ticket_attributes\": {\n \"_default_title_\": \"example\",\n \"_default_description_\": \"having a problem\"\n }\n}", + "urlencoded": [], + "formdata": [] + } + }, + "response": [] + }, { "name": "Search tickets", "tags": [ @@ -9251,7 +11541,7 @@ ] }, "method": "POST", - "description": "You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`.\n\nThis will accept a query object in the body which will define your filters.\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiples there can be:\n- There's a limit of max 2 nested filters\n- There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foobar\"`).\nThe `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `\"I need support\"` body - the query should contain a `=` operator with the value `\"support\"` for such conversation to be returned. A query with a `=` operator and a `\"need support\"` value will not yield a result.\n\n| Field | Type |\n| :---------------------------------------- | :--------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| _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", + "description": "You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`.\n\nThis will accept a query object in the body which will define your filters.\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiples there can be:\n- There's a limit of max 2 nested filters\n- There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foobar\"`).\nThe `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `\"I need support\"` body - the query should contain a `=` operator with the value `\"support\"` for such conversation to be returned. A query with a `=` operator and a `\"need support\"` value will not yield a result.\n\n| Field | Type |\n| :---------------------------------------- | :--------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| title | String |\n| description | String |\n| category | String |\n| ticket_type_id | String |\n| contact_ids | String |\n| teammate_ids | String |\n| admin_assignee_id | String |\n| team_assignee_id | String |\n| open | Boolean |\n| state | String |\n| snoozed_until | Date (UNIX timestamp) |\n| ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |\n\n{% admonition type=\"info\" name=\"Searching by Category\" %}\nWhen searching for tickets by the **`category`** field, specific terms must be used instead of the category names:\n* For **Customer** category tickets, use the term `request`.\n* For **Back-office** category tickets, use the term `task`.\n* For **Tracker** category tickets, use the term `tracker`.\n{% /admonition %}\n\n### Accepted Operators\n\n{% admonition type=\"info\" name=\"Searching based on `created_at`\" %}\n You may use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", "header": [ { "key": "Intercom-Version", @@ -9297,7 +11587,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.\n{% admonition type=\"info\" name=\"Not the Inbox ticket ID\" %}\nThis is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.\n{% /admonition %}\n" } ] }, @@ -9368,7 +11658,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.\n{% admonition type=\"info\" name=\"Not the Inbox ticket ID\" %}\nThis is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.\n{% /admonition %}\n" } ] }, @@ -9393,7 +11683,7 @@ ] }, "method": "DELETE", - "description": "You can delete a ticket using the Intercom provided ID.", + "description": "{% admonition type=\"warning\" name=\"Irreversible operation\" %}\nDeleting a ticket is permanent and cannot be reversed.\n{% /admonition %}\n\nDeleting a ticket permanently removes it from the inbox. All sensitive data is deleted, including admin and user replies, ticket attributes, uploads, and related content. The ticket will still appear in reporting, though some data may be incomplete due to the deletion.\n", "header": [ { "key": "Intercom-Version", @@ -9602,6 +11892,74 @@ } ] }, + { + "name": "Workflows", + "item": [ + { + "name": "Export a workflow", + "tags": [ + "Workflows" + ], + "request": { + "url": { + "raw": "https://api.intercom.io/export/workflows/{id}", + "protocol": "https", + "host": [ + "api.intercom.io" + ], + "path": [ + "export", + "workflows", + "{id}" + ], + "query": [], + "variable": [ + { + "key": "id", + "value": "id", + "disabled": false, + "description": "The unique identifier for the workflow" + } + ] + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "bearerToken", + "value": "{{bearerToken}}", + "type": "string" + }, + { + "key": "tokenType", + "value": "bearer", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "description": "Export a workflow configuration by its ID. This endpoint returns the complete workflow definition including its steps, targeting rules, and attributes.\n\nThis endpoint is designed for EU Data Act compliance, allowing customers to export their workflow configurations.\n\n{% admonition type=\"warning\" name=\"Preview API\" %}\n This API is currently in the Preview version. Its behavior may change in future releases.\n{% /admonition %}\n", + "header": [ + { + "key": "Intercom-Version", + "value": "Preview" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": null + }, + "response": [] + } + ] + }, { "name": "Export", "item": [ @@ -9780,6 +12138,7 @@ ] }, "method": "GET", + "description": "Download the data from a completed reporting data export job.\n\n> Octet header required\n>\n> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.\n", "header": [ { "key": "Intercom-Version", @@ -9787,7 +12146,12 @@ }, { "key": "Accept", - "value": "application/octet-stream" + "value": "Accept", + "description": "Required header for downloading the export file" + }, + { + "key": "Accept", + "value": "application/json" } ], "body": null @@ -9861,33 +12225,38 @@ ] }, { - "name": "Calls", + "name": "Folders", "item": [ { - "name": "List all calls", + "name": "List all folders", "tags": [ - "Calls" + "Folders" ], "request": { "url": { - "raw": "https://api.intercom.io/calls", + "raw": "https://api.intercom.io/folders", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "calls" + "folders" ], "query": [ { "key": "page", - "value": "1", - "description": "The page of results to fetch. Defaults to first page" + "value": "page", + "description": "The page number" }, { "key": "per_page", - "value": "25", - "description": "How many results to display per page. Defaults to 25. Max 25." + "value": "per_page", + "description": "Number of results per page" + }, + { + "key": "parent_folder_id", + "value": "1", + "description": "Filter folders by parent folder ID. Use this to list only direct children of a specific folder." } ], "variable": [] @@ -9913,7 +12282,7 @@ ] }, "method": "GET", - "description": "Retrieve a paginated list of calls.\n", + "description": "You can fetch a list of all folders for organizing content by making a GET request to `https://api.intercom.io/folders`.", "header": [ { "key": "Intercom-Version", @@ -9929,28 +12298,28 @@ "response": [] }, { - "name": "Get a call", + "name": "Retrieve a folder", "tags": [ - "Calls" + "Folders" ], "request": { "url": { - "raw": "https://api.intercom.io/calls/{id}", + "raw": "https://api.intercom.io/folders/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "calls", + "folders", "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "id", + "value": "6", "disabled": false, - "description": "The id of the call to retrieve" + "description": "The unique identifier for the folder" } ] }, @@ -9975,7 +12344,7 @@ ] }, "method": "GET", - "description": "Retrieve a single call by id.", + "description": "You can fetch the details of a single folder by making a GET request to `https://api.intercom.io/folders/`.", "header": [ { "key": "Intercom-Version", @@ -9991,31 +12360,22 @@ "response": [] }, { - "name": "Get call recording by call id", + "name": "Create a folder", "tags": [ - "Calls" + "Folders" ], "request": { "url": { - "raw": "https://api.intercom.io/calls/{id}/recording", + "raw": "https://api.intercom.io/folders", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "calls", - "{id}", - "recording" + "folders" ], "query": [], - "variable": [ - { - "key": "id", - "value": "id", - "disabled": false, - "description": "The id of the call" - } - ] + "variable": [] }, "auth": { "type": "bearer", @@ -10037,46 +12397,54 @@ } ] }, - "method": "GET", - "description": "Redirects to a signed URL for the call's recording if it exists.", + "method": "POST", + "description": "You can create a new folder for organizing content by making a POST request to `https://api.intercom.io/folders`.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"folder\": {\n \"name\": \"Product Documentation\",\n \"description\": \"Internal product documentation\",\n \"emoji\": \"📚\",\n \"parent_folder_id\": null\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "Get call transcript by call id", + "name": "Update a folder", "tags": [ - "Calls" + "Folders" ], "request": { "url": { - "raw": "https://api.intercom.io/calls/{id}/transcript", + "raw": "https://api.intercom.io/folders/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "calls", - "{id}", - "transcript" + "folders", + "{id}" ], "query": [], "variable": [ { "key": "id", - "value": "id", + "value": "6", "disabled": false, - "description": "The id of the call" + "description": "The unique identifier for the folder" } ] }, @@ -10100,40 +12468,56 @@ } ] }, - "method": "GET", - "description": "Returns the transcript for the specified call as a downloadable text file.\n", + "method": "PUT", + "description": "You can update a folder by making a PUT request to `https://api.intercom.io/folders/`.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "body": null + "body": { + "mode": "raw", + "raw": "{\n \"folder\": {\n \"name\": \"Updated Product Documentation\",\n \"description\": \"Updated internal product documentation\",\n \"emoji\": \"📖\",\n \"parent_folder_id\": null\n }\n}", + "urlencoded": [], + "formdata": [] + } }, "response": [] }, { - "name": "List calls with transcripts", + "name": "Delete a folder", "tags": [ - "Calls" + "Folders" ], "request": { "url": { - "raw": "https://api.intercom.io/calls/search", + "raw": "https://api.intercom.io/folders/{id}", "protocol": "https", "host": [ "api.intercom.io" ], "path": [ - "calls", - "search" + "folders", + "{id}" ], "query": [], - "variable": [] + "variable": [ + { + "key": "id", + "value": "6", + "disabled": false, + "description": "The unique identifier for the folder" + } + ] }, "auth": { "type": "bearer", @@ -10155,28 +12539,19 @@ } ] }, - "method": "POST", - "description": "Retrieve calls by a list of conversation ids and include transcripts when available.\nA maximum of 20 `conversation_ids` can be provided. If none are provided or more than 20 are provided, a 400 error is returned.\n", + "method": "DELETE", + "description": "You can delete a folder (if it contains no content) by making a DELETE request to `https://api.intercom.io/folders/`.", "header": [ { "key": "Intercom-Version", "value": "Preview" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"conversation_ids\": \"\"\n}", - "urlencoded": [], - "formdata": [] - } + "body": null }, "response": [] } @@ -10186,7 +12561,7 @@ "event": [], "variable": [ { - "id": "b3223a1f-c5b2-43f8-af0b-8ef7a1380110", + "id": "f6d918ee-961e-40a5-8308-deaa65c7c8da", "key": "bearerToken", "value": "{{bearerToken}}", "type": "string",