Body of the Article
", "author_id": 991266745, "state": "published", "created_at": 1717020993, "updated_at": 1717020993, "url": "http://help-center.test/myapp-37/en/articles/21-thanks-for-everything" } } }, "schema": { "$ref": "#/components/schemas/article" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Bad Request": { "value": { "type": "error.list", "request_id": "7f42533e-cfc8-466b-816c-3fbac2cb389d", "errors": [ { "code": "parameter_not_found", "message": "author_id must be in the main body or default locale translated_content object" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "7bf18f0b-9ca5-455a-8822-fd8495e77447", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_article_request" }, "examples": { "article_created": { "summary": "article created", "value": { "title": "Thanks for everything", "description": "Description of the Article", "body": "Body of the Article", "author_id": 991266745, "state": "published", "parent_id": 75, "parent_type": "collection", "translated_content": { "fr": { "title": "Merci pour tout", "description": "Description de l'article", "body": "Corps de l'article", "author_id": 991266745, "state": "published" } } } }, "bad_request": { "summary": "Bad Request", "value": { "title": "Thanks for everything", "description": "Description of the Article", "body": "Body of the Article", "state": "published" } } } } } } } }, "/articles/{id}": { "get": { "summary": "Retrieve an article", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The unique identifier for the article which is given by Intercom.", "example": 123, "schema": { "type": "integer" } } ], "tags": [ "Articles" ], "operationId": "retrieveArticle", "description": "You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/New gifts in store for the jolly season
", "author_id": 991266756, "state": "published", "created_at": 1717020997, "updated_at": 1717020997, "url": "http://help-center.test/myapp-49/en/articles/27-christmas-is-here" } } }, "schema": { "$ref": "#/components/schemas/article" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "8aef60ee-b9e4-408e-8f70-c75073c8b301", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Article Not Found", "content": { "application/json": { "examples": { "Article Not Found": { "value": { "type": "error.list", "request_id": "17339291-56a6-4aed-b7a4-3f3822e7aa6a", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_article_request" }, "examples": { "successful": { "summary": "successful", "value": { "title": "Christmas is here!", "body": "New gifts in store for the jolly season
" } }, "article_not_found": { "summary": "Article Not Found", "value": { "title": "Christmas is here!", "body": "New gifts in store for the jolly season
" } } } } } } }, "delete": { "summary": "Delete an article", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The unique identifier for the article which is given by Intercom.", "example": 123, "schema": { "type": "integer" } } ], "tags": [ "Articles" ], "operationId": "deleteArticle", "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/This is a note.
" }, { "type": "note", "id": "15", "created_at": 1716329847, "contact": { "type": "contact", "id": "6657a9776abd01639cc9e982" }, "author": { "type": "admin", "id": "991266838", "name": "Ciaran110 Lee", "email": "admin110@email.com", "away_mode_enabled": false, "away_mode_reassign": false }, "body": "This is a note.
" }, { "type": "note", "id": "14", "created_at": 1716329847, "contact": { "type": "contact", "id": "6657a9776abd01639cc9e982" }, "author": { "type": "admin", "id": "991266838", "name": "Ciaran110 Lee", "email": "admin110@email.com", "away_mode_enabled": false, "away_mode_reassign": false }, "body": "This is a note.
" } ], "total_count": 3, "pages": { "type": "pages", "next": null, "page": 1, "per_page": 50, "total_pages": 1 } } } }, "schema": { "$ref": "#/components/schemas/note_list" } } } }, "404": { "description": "Contact not found", "content": { "application/json": { "examples": { "Contact not found": { "value": { "type": "error.list", "request_id": "d98095f8-d3f7-4c03-97d4-cd3ac8d38323", "errors": [ { "code": "not_found", "message": "User Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } }, "post": { "summary": "Create a note", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The unique identifier of a given contact.", "example": "123", "schema": { "type": "integer" } } ], "tags": [ "Notes", "Contacts" ], "operationId": "createNote", "description": "You can add a note to a single contact.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "examples": { "Successful response": { "value": { "type": "note", "id": "21", "created_at": 1717021048, "contact": { "type": "contact", "id": "6657a9786abd01639cc9e984" }, "author": { "type": "admin", "id": "991266840", "name": "Ciaran112 Lee", "email": "admin112@email.com", "away_mode_enabled": false, "away_mode_reassign": false }, "body": "Hello
" } } }, "schema": { "$ref": "#/components/schemas/note" } } } }, "404": { "description": "Contact not found", "content": { "application/json": { "examples": { "Admin not found": { "value": { "type": "error.list", "request_id": "84aaa3ff-8930-45c6-8e18-c11b4b16c3f6", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } }, "Contact not found": { "value": { "type": "error.list", "request_id": "6153cf8b-2d43-4ec9-8635-e1ca8e5a307a", "errors": [ { "code": "not_found", "message": "User Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "body" ], "properties": { "body": { "type": "string", "description": "The text of the note.", "example": "New note" }, "contact_id": { "type": "string", "description": "The unique identifier of a given contact.", "example": "123" }, "admin_id": { "type": "string", "description": "The unique identifier of a given admin.", "example": "123" } } }, "examples": { "successful_response": { "summary": "Successful response", "value": { "contact_id": "6657a9786abd01639cc9e984", "admin_id": 991266840, "body": "Hello" } }, "admin_not_found": { "summary": "Admin not found", "value": { "contact_id": "6657a9796abd01639cc9e985", "admin_id": 123, "body": "Hello" } }, "contact_not_found": { "summary": "Contact not found", "value": { "contact_id": 123, "admin_id": 991266842, "body": "Hello" } } } } } } } }, "/contacts/{contact_id}/segments": { "get": { "summary": "List attached segments for contact", "parameters": [ { "name": "contact_id", "in": "path", "description": "The unique identifier for the contact which is given by Intercom", "example": "63a07ddf05a32042dffac965", "required": true, "schema": { "type": "string" } }, { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Contacts", "Segments" ], "operationId": "listSegmentsForAContact", "description": "You can fetch a list of segments that are associated to a contact.", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "list", "data": [ { "type": "segment", "id": "6657a97a6abd01639cc9e987", "name": "segment", "created_at": 1717021050, "updated_at": 1717021050, "person_type": "user" } ] } } }, "schema": { "$ref": "#/components/schemas/contact_segments" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "54cbc4d5-a7d2-4f9e-83f9-9e81e24cddf9", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Contact not found", "content": { "application/json": { "examples": { "Contact not found": { "value": { "type": "error.list", "request_id": "6f126ac1-ec32-46b3-9211-2e149d7fc53d", "errors": [ { "code": "not_found", "message": "User Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/contacts/{contact_id}/subscriptions": { "get": { "summary": "List subscriptions for a contact", "parameters": [ { "name": "contact_id", "in": "path", "description": "The unique identifier for the contact which is given by Intercom", "example": "63a07ddf05a32042dffac965", "required": true, "schema": { "type": "string" } }, { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Contacts", "Subscription Types" ], "operationId": "listSubscriptionsForAContact", "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", "responses": { "200": { "description": "Successful", "content": { "application/json": { "examples": { "Successful": { "value": { "type": "list", "data": [ { "type": "subscription", "id": "47", "state": "live", "consent_type": "opt_out", "default_translation": { "name": "Newsletters", "description": "Lorem ipsum dolor sit amet", "locale": "en" }, "translations": [ { "name": "Newsletters", "description": "Lorem ipsum dolor sit amet", "locale": "en" } ], "content_types": [ "email" ] }, { "type": "subscription", "id": "49", "state": "live", "consent_type": "opt_in", "default_translation": { "name": "Newsletters", "description": "Lorem ipsum dolor sit amet", "locale": "en" }, "translations": [ { "name": "Newsletters", "description": "Lorem ipsum dolor sit amet", "locale": "en" } ], "content_types": [ "sms_message" ] } ] } } }, "schema": { "$ref": "#/components/schemas/subscription_type_list" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "7583e322-0146-4c46-a610-542298cb760a", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Contact not found", "content": { "application/json": { "examples": { "Contact not found": { "value": { "type": "error.list", "request_id": "815a69e1-1db5-452d-96ca-2ce8068d9652", "errors": [ { "code": "not_found", "message": "User Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } }, "post": { "summary": "Add subscription to a contact", "tags": [ "Subscription Types", "Contacts" ], "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "contact_id", "in": "path", "description": "The unique identifier for the contact which is given by Intercom", "example": "63a07ddf05a32042dffac965", "required": true, "schema": { "type": "string" } } ], "operationId": "attachSubscriptionTypeToContact", "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", "responses": { "200": { "description": "Successful", "content": { "application/json": { "examples": { "Successful": { "value": { "type": "subscription", "id": "62", "state": "live", "consent_type": "opt_in", "default_translation": { "name": "Newsletters", "description": "Lorem ipsum dolor sit amet", "locale": "en" }, "translations": [ { "name": "Newsletters", "description": "Lorem ipsum dolor sit amet", "locale": "en" } ], "content_types": [ "sms_message" ] } } }, "schema": { "$ref": "#/components/schemas/subscription_type" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "b0e5dbe4-34a0-4096-b920-696d8d149770", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "examples": { "Contact not found": { "value": { "type": "error.list", "request_id": "1a51b4c8-1a22-4b39-aadc-6449d07790d9", "errors": [ { "code": "not_found", "message": "User Not Found" } ] } }, "Resource not found": { "value": { "type": "error.list", "request_id": "3bc5ad54-c5b7-4eb7-99b3-f85f6a6cc446", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "consent_type" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the subscription which is given by Intercom", "example": "37846" }, "consent_type": { "type": "string", "description": "The consent_type of a subscription, opt_out or opt_in.", "example": "opt_in" } } }, "examples": { "successful": { "summary": "Successful", "value": { "id": 62, "consent_type": "opt_in" } }, "contact_not_found": { "summary": "Contact not found", "value": { "id": 66, "consent_type": "opt_in" } }, "resource_not_found": { "summary": "Resource not found", "value": { "id": "invalid_id", "consent_type": "opt_in" } } } } } } } }, "/contacts/{contact_id}/subscriptions/{id}": { "delete": { "summary": "Remove subscription from a contact", "tags": [ "Subscription Types", "Contacts" ], "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "contact_id", "in": "path", "description": "The unique identifier for the contact which is given by Intercom", "example": "63a07ddf05a32042dffac965", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the subscription type which is given by Intercom", "example": "37846", "required": true, "schema": { "type": "string" } } ], "operationId": "detachSubscriptionTypeToContact", "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.", "responses": { "200": { "description": "Successful", "content": { "application/json": { "examples": { "Successful": { "value": { "type": "subscription", "id": "78", "state": "live", "consent_type": "opt_in", "default_translation": { "name": "Newsletters", "description": "Lorem ipsum dolor sit amet", "locale": "en" }, "translations": [ { "name": "Newsletters", "description": "Lorem ipsum dolor sit amet", "locale": "en" } ], "content_types": [ "sms_message" ] } } }, "schema": { "$ref": "#/components/schemas/subscription_type" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "29f4bb2b-0e6e-427a-b6e0-82121944507b", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "examples": { "Contact not found": { "value": { "type": "error.list", "request_id": "add17f5f-72e4-476d-bd4c-e2b518e929d4", "errors": [ { "code": "not_found", "message": "User Not Found" } ] } }, "Resource not found": { "value": { "type": "error.list", "request_id": "014dce41-2412-4fc9-933a-1787b9a8711a", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/contacts/{contact_id}/tags": { "get": { "summary": "List tags attached to a contact", "tags": [ "Contacts", "Tags" ], "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "contact_id", "in": "path", "description": "The unique identifier for the contact which is given by Intercom", "example": "63a07ddf05a32042dffac965", "required": true, "schema": { "type": "string" } } ], "operationId": "listTagsForAContact", "description": "You can fetch a list of all tags that are attached to a specific contact.", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "list", "data": [ { "type": "tag", "id": "42", "name": "Manual tag", "applied_at": 1663597223, "applied_by": { "type": "admin", "id": "456" } } ] } } }, "schema": { "$ref": "#/components/schemas/tag_list" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "f5cb5609-3400-428c-b4aa-a555c5cd0494", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Contact not found", "content": { "application/json": { "examples": { "Contact not found": { "value": { "type": "error.list", "request_id": "3f4fa0c2-6332-4285-8a1f-5ef04348a137", "errors": [ { "code": "not_found", "message": "User Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } }, "post": { "summary": "Add tag to a contact", "tags": [ "Tags", "Contacts" ], "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "contact_id", "in": "path", "description": "The unique identifier for the contact which is given by Intercom", "example": "63a07ddf05a32042dffac965", "required": true, "schema": { "type": "string" } } ], "operationId": "attachTagToContact", "description": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "tag", "id": "43", "name": "Manual tag", "applied_at": 1663597223, "applied_by": { "type": "admin", "id": "456" } } } }, "schema": { "$ref": "#/components/schemas/tag" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "cc549346-66df-4fb8-ba5a-86af6d7a86b4", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Tag not found", "content": { "application/json": { "examples": { "Contact not found": { "value": { "type": "error.list", "request_id": "7bf96e76-a4b5-4f6b-8574-41fa2f062187", "errors": [ { "code": "not_found", "message": "User Not Found" } ] } }, "Tag not found": { "value": { "type": "error.list", "request_id": "c6a28db0-794c-4333-af15-33bdaf76779a", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the tag which is given by Intercom", "example": "7522907" } } }, "examples": { "successful": { "summary": "successful", "value": { "id": 43 } }, "contact_not_found": { "summary": "Contact not found", "value": { "id": 44 } }, "tag_not_found": { "summary": "Tag not found", "value": { "id": "123" } } } } } } } }, "/contacts/{contact_id}/tags/{id}": { "delete": { "summary": "Remove tag from a contact", "tags": [ "Tags", "Contacts" ], "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "contact_id", "in": "path", "description": "The unique identifier for the contact which is given by Intercom", "example": "63a07ddf05a32042dffac965", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier for the tag which is given by Intercom", "example": "7522907", "required": true, "schema": { "type": "string" } } ], "operationId": "detachTagFromContact", "description": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "tag", "id": "46", "name": "Manual tag", "applied_at": 1663597223, "applied_by": { "type": "admin", "id": "456" } } } }, "schema": { "$ref": "#/components/schemas/tag" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "f1e16f17-154e-422b-9541-e7ff7116ee55", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Tag not found", "content": { "application/json": { "examples": { "Contact not found": { "value": { "type": "error.list", "request_id": "5c90cab2-2d4b-4dc1-b7a3-c9a1ecacb110", "errors": [ { "code": "not_found", "message": "User Not Found" } ] } }, "Tag not found": { "value": { "type": "error.list", "request_id": "70ecb850-2f9e-43cf-8020-9bdd1e898a81", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/contacts/{id}": { "put": { "summary": "Update a contact", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "description": "id", "example": "63a07ddf05a32042dffac965", "required": true, "schema": { "type": "string" } } ], "tags": [ "Contacts" ], "operationId": "UpdateContact", "description": "You can update an existing contact (ie. user or lead).", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "contact", "id": "6657a9896abd01639cc9e99e", "workspace_id": "this_is_an_id259_that_should_be_at_least_", "external_id": "70", "role": "user", "email": "joebloggs@intercom.io", "phone": null, "name": "joe bloggs", "avatar": null, "owner_id": null, "social_profiles": { "type": "list", "data": [] }, "has_hard_bounced": false, "marked_email_as_spam": false, "unsubscribed_from_emails": false, "created_at": 1717021065, "updated_at": 1717021065, "signed_up_at": 1717021065, "last_seen_at": null, "last_replied_at": null, "last_contacted_at": null, "last_email_opened_at": null, "last_email_clicked_at": null, "language_override": null, "browser": null, "browser_version": null, "browser_language": null, "os": null, "location": { "type": "location", "country": null, "region": null, "city": null, "country_code": null, "continent_code": null }, "android_app_name": null, "android_app_version": null, "android_device": null, "android_os_version": null, "android_sdk_version": null, "android_last_seen_at": null, "ios_app_name": null, "ios_app_version": null, "ios_device": null, "ios_os_version": null, "ios_sdk_version": null, "ios_last_seen_at": null, "custom_attributes": {}, "tags": { "type": "list", "data": [], "url": "/contacts/6657a9896abd01639cc9e99e/tags", "total_count": 0, "has_more": false }, "notes": { "type": "list", "data": [], "url": "/contacts/6657a9896abd01639cc9e99e/notes", "total_count": 0, "has_more": false }, "companies": { "type": "list", "data": [], "url": "/contacts/6657a9896abd01639cc9e99e/companies", "total_count": 0, "has_more": false }, "opted_out_subscription_types": { "type": "list", "data": [], "url": "/contacts/6657a9896abd01639cc9e99e/subscriptions", "total_count": 0, "has_more": false }, "opted_in_subscription_types": { "type": "list", "data": [], "url": "/contacts/6657a9896abd01639cc9e99e/subscriptions", "total_count": 0, "has_more": false }, "utm_campaign": null, "utm_content": null, "utm_medium": null, "utm_source": null, "utm_term": null, "referrer": null } } }, "schema": { "$ref": "#/components/schemas/contact" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "8acee353-12d9-4585-a170-9957f1793326", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/update_contact_request" } ] }, "examples": { "successful": { "summary": "successful", "value": { "email": "joebloggs@intercom.io", "name": "joe bloggs" } } } } } } }, "get": { "summary": "Get a contact", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "description": "id", "example": "63a07ddf05a32042dffac965", "required": true, "schema": { "type": "string" } } ], "tags": [ "Contacts" ], "operationId": "ShowContact", "description": "You can fetch the details of a single contact.\n\n{% admonition type=\"warning\" name=\"Merged contacts\" %}\n If a contact has been merged into another contact via the Merge endpoint (POST /contacts/merge), requesting it by its original ID will return a `404 Not Found` error. Use the merged-into contact's ID instead.\n{% /admonition %}\n", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "contact", "id": "6657a98a6abd01639cc9e99f", "workspace_id": "this_is_an_id263_that_should_be_at_least_", "external_id": "70", "role": "user", "email": "joe@bloggs.com", "phone": null, "name": "Joe Bloggs", "avatar": null, "owner_id": null, "social_profiles": { "type": "list", "data": [] }, "has_hard_bounced": false, "marked_email_as_spam": false, "unsubscribed_from_emails": false, "created_at": 1717021066, "updated_at": 1717021066, "signed_up_at": 1717021066, "last_seen_at": null, "last_replied_at": null, "last_contacted_at": null, "last_email_opened_at": null, "last_email_clicked_at": null, "language_override": null, "browser": null, "browser_version": null, "browser_language": null, "os": null, "location": { "type": "location", "country": null, "region": null, "city": null, "country_code": null, "continent_code": null }, "android_app_name": null, "android_app_version": null, "android_device": null, "android_os_version": null, "android_sdk_version": null, "android_last_seen_at": null, "ios_app_name": null, "ios_app_version": null, "ios_device": null, "ios_os_version": null, "ios_sdk_version": null, "ios_last_seen_at": null, "custom_attributes": {}, "tags": { "type": "list", "data": [], "url": "/contacts/6657a98a6abd01639cc9e99f/tags", "total_count": 0, "has_more": false }, "notes": { "type": "list", "data": [], "url": "/contacts/6657a98a6abd01639cc9e99f/notes", "total_count": 0, "has_more": false }, "companies": { "type": "list", "data": [], "url": "/contacts/6657a98a6abd01639cc9e99f/companies", "total_count": 0, "has_more": false }, "opted_out_subscription_types": { "type": "list", "data": [], "url": "/contacts/6657a98a6abd01639cc9e99f/subscriptions", "total_count": 0, "has_more": false }, "opted_in_subscription_types": { "type": "list", "data": [], "url": "/contacts/6657a98a6abd01639cc9e99f/subscriptions", "total_count": 0, "has_more": false }, "utm_campaign": null, "utm_content": null, "utm_medium": null, "utm_source": null, "utm_term": null, "referrer": null } } }, "schema": { "$ref": "#/components/schemas/contact" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "5850c309-dc55-4a8e-ae7d-7369e72f2650", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } }, "delete": { "summary": "Delete a contact", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "string" } } ], "tags": [ "Contacts" ], "operationId": "DeleteContact", "description": "You can delete a single contact.", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "id": "6657a98c6abd01639cc9e9a0", "object": "contact", "deleted": true } } }, "schema": { "$ref": "#/components/schemas/contact_deleted" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "02750de9-617e-453c-a23e-480b6d480688", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/contacts/merge": { "post": { "summary": "Merge a lead and a user", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Contacts" ], "operationId": "MergeContact", "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.\n\n{% admonition type=\"warning\" name=\"Merged contacts are not retrievable via the API\" %}\n Once a merge is completed, the source contact (`from`) is permanently removed from the active contact list. This means:\n - **GET /contacts/{id}** — Requesting the source contact by its original ID will return a `404 Not Found` error.\n - **POST /contacts/search** — The source contact will not appear in search results, including queries filtered by `updated_at`.\n - **GET /contacts** — The source contact will not appear in list results.\n\n Only the target contact (`into`) remains accessible. If your application stores contact IDs, update them to use the target contact's ID after a merge.\n{% /admonition %}\n", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "contact", "id": "6657a98d6abd01639cc9e9a2", "workspace_id": "this_is_an_id271_that_should_be_at_least_", "external_id": "70", "role": "user", "email": "joe@bloggs.com", "phone": null, "name": "Joe Bloggs", "avatar": null, "owner_id": null, "social_profiles": { "type": "list", "data": [] }, "has_hard_bounced": false, "marked_email_as_spam": false, "unsubscribed_from_emails": false, "created_at": 1717021069, "updated_at": 1717021070, "signed_up_at": 1717021069, "last_seen_at": null, "last_replied_at": null, "last_contacted_at": null, "last_email_opened_at": null, "last_email_clicked_at": null, "language_override": null, "browser": null, "browser_version": null, "browser_language": null, "os": null, "location": { "type": "location", "country": null, "region": null, "city": null, "country_code": null, "continent_code": null }, "android_app_name": null, "android_app_version": null, "android_device": null, "android_os_version": null, "android_sdk_version": null, "android_last_seen_at": null, "ios_app_name": null, "ios_app_version": null, "ios_device": null, "ios_os_version": null, "ios_sdk_version": null, "ios_last_seen_at": null, "custom_attributes": {}, "tags": { "type": "list", "data": [], "url": "/contacts/6657a98d6abd01639cc9e9a2/tags", "total_count": 0, "has_more": false }, "notes": { "type": "list", "data": [], "url": "/contacts/6657a98d6abd01639cc9e9a2/notes", "total_count": 0, "has_more": false }, "companies": { "type": "list", "data": [], "url": "/contacts/6657a98d6abd01639cc9e9a2/companies", "total_count": 0, "has_more": false }, "opted_out_subscription_types": { "type": "list", "data": [], "url": "/contacts/6657a98d6abd01639cc9e9a2/subscriptions", "total_count": 0, "has_more": false }, "opted_in_subscription_types": { "type": "list", "data": [], "url": "/contacts/6657a98d6abd01639cc9e9a2/subscriptions", "total_count": 0, "has_more": false }, "utm_campaign": null, "utm_content": null, "utm_medium": null, "utm_source": null, "utm_term": null, "referrer": null } } }, "schema": { "$ref": "#/components/schemas/contact" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "e84382a7-bfda-4ab9-9ff8-8f7ab962f7e5", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/merge_contacts_request" }, "examples": { "successful": { "summary": "successful", "value": { "from": "6657a98d6abd01639cc9e9a1", "into": "6657a98d6abd01639cc9e9a2" } } } } } } } }, "/contacts/search": { "post": { "summary": "Search contacts", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Contacts" ], "operationId": "SearchContacts", "description": "You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want.\n\nTo search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`.\n\nThis will accept a query object in the body which will define your filters in order to search for contacts.\n\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `50` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n### Merged Contacts\n\nContacts that have been merged (via POST /contacts/merge) are excluded from search results. If a contact was recently merged into another, it will no longer appear in queries filtered by `updated_at` or any other field. Only the target contact from the merge remains searchable.\n\n### Contact Creation Delay\n\nIf a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiple's there can be:\n* There's a limit of max 2 nested filters\n* There's a limit of max 15 filters for each AND or OR group\n\n### Searching for Timestamp Fields\n\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 | Stringthis is the message body
", "author": { "type": "admin", "id": "991266883", "name": "Ciaran152 Lee", "email": "admin152@email.com" }, "attachments": [], "url": null, "redacted": false }, "contacts": { "type": "contact.list", "contacts": [ { "type": "contact", "id": "6657a99e6abd01639cc9e9ab" } ] }, "first_contact_reply": null, "admin_assignee_id": 991267715, "team_assignee_id": 5017691, "open": false, "state": "closed", "read": false, "tags": { "type": "tag.list", "tags": [] }, "priority": "not_priority", "sla_applied": null, "statistics": null, "conversation_rating": null, "teammates": null, "title": null, "topics": {} } ] } } }, "schema": { "$ref": "#/components/schemas/conversation_list" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "a8f8a86b-5c9b-474a-b693-770211f2bf69", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "API plan restricted", "content": { "application/json": { "examples": { "API plan restricted": { "value": { "type": "error.list", "request_id": "c406b799-fcc3-4e99-b0d7-659925189f5e", "errors": [ { "code": "api_plan_restricted", "message": "Active subscription needed." } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } }, "post": { "summary": "Creates a conversation", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Conversations" ], "operationId": "createConversation", "description": "You can create a conversation that has been initiated by a contact (ie. user or lead).\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", "responses": { "200": { "description": "conversation created", "content": { "application/json": { "examples": { "conversation created": { "value": { "type": "user_message", "id": "403918156", "created_at": 1717021110, "body": "Hello there", "message_type": "inapp", "conversation_id": "181" } } }, "schema": { "$ref": "#/components/schemas/message" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "412bd03a-ef8f-46da-90a4-7ce2119b8e6d", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "API plan restricted", "content": { "application/json": { "examples": { "API plan restricted": { "value": { "type": "error.list", "request_id": "362ec109-eb07-4735-9f5c-1defaa60d28d", "errors": [ { "code": "api_plan_restricted", "message": "Active subscription needed." } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Contact Not Found", "content": { "application/json": { "examples": { "Contact Not Found": { "value": { "type": "error.list", "request_id": "fc18e33b-906d-45e2-b7f9-1e03f3afee4b", "errors": [ { "code": "not_found", "message": "User Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_conversation_request" }, "examples": { "conversation_created": { "summary": "conversation created", "value": { "from": { "type": "user", "id": "6657a9b56abd01639cc9e9c3" }, "body": "Hello there" } }, "contact_not_found": { "summary": "Contact Not Found", "value": { "from": { "type": "user", "id": "123_doesnt_exist" }, "body": "Hello there" } } } } } } } }, "/conversations/{id}": { "get": { "summary": "Retrieve a conversation", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The id of the conversation to target", "example": 123, "schema": { "type": "integer" } }, { "name": "display_as", "in": "query", "required": false, "description": "Set to plaintext to retrieve conversation messages in plain text.", "example": "plaintext", "schema": { "type": "string" } } ], "tags": [ "Conversations" ], "operationId": "retrieveConversation", "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", "responses": { "200": { "description": "conversation found", "content": { "application/json": { "examples": { "conversation found": { "value": { "type": "conversation", "id": "185", "created_at": 1717021115, "updated_at": 1717021115, "waiting_since": null, "snoozed_until": null, "source": { "type": "conversation", "id": "403918160", "delivered_as": "admin_initiated", "subject": "", "body": "this is the message body
", "author": { "type": "admin", "id": "991266900", "name": "Ciaran162 Lee", "email": "admin162@email.com" }, "attachments": [], "url": null, "redacted": false }, "contacts": { "type": "contact.list", "contacts": [ { "type": "contact", "id": "6657a9bb6abd01639cc9e9c7" } ] }, "first_contact_reply": null, "admin_assignee_id": 991267715, "team_assignee_id": 5017691, "open": false, "state": "closed", "read": false, "tags": { "type": "tag.list", "tags": [] }, "priority": "not_priority", "sla_applied": null, "statistics": null, "conversation_rating": null, "teammates": null, "title": null, "topics": {}, "conversation_parts": { "type": "conversation_part.list", "conversation_parts": [], "total_count": 0 } } } }, "schema": { "$ref": "#/components/schemas/conversation" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "e58f12d6-3b9c-4a8a-9f0a-de6bba64a19d", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "API plan restricted", "content": { "application/json": { "examples": { "API plan restricted": { "value": { "type": "error.list", "request_id": "ea4816ca-a5ba-4a4a-9011-a3f46bfb22e6", "errors": [ { "code": "api_plan_restricted", "message": "Active subscription needed." } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "examples": { "Not found": { "value": { "type": "error.list", "request_id": "eb22363e-569c-4fe7-8c10-322cdf81f4d3", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } }, "put": { "summary": "Update a conversation", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The id of the conversation to target", "example": 123, "schema": { "type": "integer" } }, { "name": "display_as", "in": "query", "required": false, "description": "Set to plaintext to retrieve conversation messages in plain text.", "example": "plaintext", "schema": { "type": "string" } } ], "tags": [ "Conversations" ], "operationId": "updateConversation", "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", "responses": { "200": { "description": "conversation found", "content": { "application/json": { "examples": { "conversation found": { "value": { "type": "conversation", "id": "189", "created_at": 1717021121, "updated_at": 1717021122, "waiting_since": null, "snoozed_until": null, "source": { "type": "conversation", "id": "403918164", "delivered_as": "admin_initiated", "subject": "", "body": "this is the message body
", "author": { "type": "admin", "id": "991266908", "name": "Ciaran166 Lee", "email": "admin166@email.com" }, "attachments": [], "url": null, "redacted": false }, "contacts": { "type": "contact.list", "contacts": [ { "type": "contact", "id": "6657a9c16abd01639cc9e9cb" } ] }, "first_contact_reply": null, "admin_assignee_id": 991267715, "team_assignee_id": 5017691, "open": false, "state": "closed", "read": true, "tags": { "type": "tag.list", "tags": [] }, "priority": "not_priority", "sla_applied": null, "statistics": null, "conversation_rating": null, "teammates": null, "title": null, "topics": {}, "conversation_parts": { "type": "conversation_part.list", "conversation_parts": [ { "type": "conversation_part", "id": "36", "part_type": "conversation_attribute_updated_by_admin", "body": null, "created_at": 1717021122, "updated_at": 1717021122, "notified_at": 1717021122, "assigned_to": null, "author": { "id": "991266909", "type": "bot", "name": "Operator", "email": "operator+this_is_an_id332_that_should_be_at_least_@intercom.io" }, "attachments": [], "external_id": null, "redacted": false }, { "type": "conversation_part", "id": "37", "part_type": "conversation_attribute_updated_by_admin", "body": null, "created_at": 1717021122, "updated_at": 1717021122, "notified_at": 1717021122, "assigned_to": null, "author": { "id": "991266909", "type": "bot", "name": "Operator", "email": "operator+this_is_an_id332_that_should_be_at_least_@intercom.io" }, "attachments": [], "external_id": null, "redacted": false } ], "total_count": 2 } } } }, "schema": { "$ref": "#/components/schemas/conversation" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "8ea511ae-882f-42de-b715-c8022291461a", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "API plan restricted", "content": { "application/json": { "examples": { "API plan restricted": { "value": { "type": "error.list", "request_id": "41742b3c-bbbe-48df-a59a-78186820a30c", "errors": [ { "code": "api_plan_restricted", "message": "Active subscription needed." } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "examples": { "Not found": { "value": { "type": "error.list", "request_id": "6225dcc5-6f41-4e82-9db5-c99143b8b746", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_conversation_request" }, "examples": { "conversation_found": { "summary": "conversation found", "value": { "read": true } }, "not_found": { "summary": "Not found", "value": { "read": true } } } } } } } }, "/conversations/search": { "post": { "summary": "Search conversations", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Conversations" ], "operationId": "searchConversations", "description": "You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`.\n\nThis will accept a query object in the body which will define your filters in order to search for conversations.\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiple's there can be:\n- There's a limit of max 2 nested filters\n- There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed as part of the conversation model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foorbar\"`).\nThe `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `\"I need support\"` body - the query should contain a `=` operator with the value `\"support\"` for such conversation to be returned. A query with a `=` operator and a `\"need support\"` value will not yield a result.\n\n| Field | Type |\n| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| source.type | Stringthis is the message body
", "author": { "type": "admin", "id": "991266938", "name": "Ciaran189 Lee", "email": "admin189@email.com" }, "attachments": [], "url": null, "redacted": false }, "contacts": { "type": "contact.list", "contacts": [ { "type": "contact", "id": "6657a9cc6abd01639cc9e9d2" } ] }, "first_contact_reply": null, "admin_assignee_id": 991267715, "team_assignee_id": 5017691, "open": false, "state": "closed", "read": false, "tags": { "type": "tag.list", "tags": [] }, "priority": "not_priority", "sla_applied": null, "statistics": null, "conversation_rating": null, "teammates": null, "title": null, "topics": {} } ] } } }, "schema": { "$ref": "#/components/schemas/conversation_list" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/search_request" }, "examples": { "successful": { "summary": "successful", "value": { "query": { "operator": "AND", "value": [ { "field": "created_at", "operator": ">", "value": "1306054154" } ] }, "pagination": { "per_page": 5 } } } } } } } } }, "/conversations/{id}/reply": { "post": { "summary": "Reply to a conversation", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The Intercom provisioned identifier for the conversation or the string \"last\" to reply to the last part of the conversation", "example": "123 or \"last\"", "schema": { "type": "string" } } ], "tags": [ "Conversations" ], "operationId": "replyConversation", "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.", "responses": { "200": { "description": "User last conversation reply", "content": { "application/json": { "examples": { "User reply": { "value": { "type": "conversation", "id": "205", "created_at": 1717021140, "updated_at": 1717021141, "waiting_since": 1717021140, "snoozed_until": null, "source": { "type": "conversation", "id": "403918174", "delivered_as": "admin_initiated", "subject": "", "body": "this is the message body
", "author": { "type": "admin", "id": "991266941", "name": "Ciaran191 Lee", "email": "admin191@email.com" }, "attachments": [], "url": null, "redacted": false }, "contacts": { "type": "contact.list", "contacts": [ { "type": "contact", "id": "6657a9d36abd01639cc9e9da" } ] }, "first_contact_reply": { "created_at": 1717021140, "type": "conversation", "url": null }, "admin_assignee_id": 991267715, "team_assignee_id": 5017691, "open": true, "state": "open", "read": false, "tags": { "type": "tag.list", "tags": [] }, "priority": "not_priority", "sla_applied": null, "statistics": null, "conversation_rating": null, "teammates": null, "title": null, "topics": {}, "conversation_parts": { "type": "conversation_part.list", "conversation_parts": [ { "type": "conversation_part", "id": "39", "part_type": "open", "body": "Thanks again :)
", "created_at": 1717021140, "updated_at": 1717021140, "notified_at": 1717021140, "assigned_to": null, "author": { "id": "6657a9d36abd01639cc9e9da", "type": "user", "name": "Joe Bloggs", "email": "joe@bloggs.com" }, "attachments": [], "external_id": null, "redacted": false }, { "type": "conversation_part", "id": "40", "part_type": "language_detection_details", "body": null, "created_at": 1717021141, "updated_at": 1717021141, "notified_at": 1717021141, "assigned_to": null, "author": { "id": "991266942", "type": "bot", "name": "Operator", "email": "operator+this_is_an_id346_that_should_be_at_least_@intercom.io" }, "attachments": [], "external_id": null, "redacted": false } ], "total_count": 2 } } }, "Admin note reply": { "value": { "type": "conversation", "id": "206", "created_at": 1717021142, "updated_at": 1717021143, "waiting_since": null, "snoozed_until": null, "source": { "type": "conversation", "id": "403918175", "delivered_as": "admin_initiated", "subject": "", "body": "this is the message body
", "author": { "type": "admin", "id": "991266943", "name": "Ciaran192 Lee", "email": "admin192@email.com" }, "attachments": [], "url": null, "redacted": false }, "contacts": { "type": "contact.list", "contacts": [ { "type": "contact", "id": "6657a9d66abd01639cc9e9db" } ] }, "first_contact_reply": null, "admin_assignee_id": 991267715, "team_assignee_id": 5017691, "open": false, "state": "closed", "read": false, "tags": { "type": "tag.list", "tags": [] }, "priority": "not_priority", "sla_applied": null, "statistics": null, "conversation_rating": null, "teammates": null, "title": null, "topics": {}, "conversation_parts": { "type": "conversation_part.list", "conversation_parts": [ { "type": "conversation_part", "id": "41", "part_type": "note", "body": "this is the message body
", "author": { "type": "admin", "id": "991266947", "name": "Ciaran194 Lee", "email": "admin194@email.com" }, "attachments": [], "url": null, "redacted": false }, "contacts": { "type": "contact.list", "contacts": [ { "type": "contact", "id": "6657a9d96abd01639cc9e9dd" } ] }, "first_contact_reply": { "created_at": 1717021146, "type": "conversation", "url": null }, "admin_assignee_id": 991267715, "team_assignee_id": 5017691, "open": true, "state": "open", "read": false, "tags": { "type": "tag.list", "tags": [] }, "priority": "not_priority", "sla_applied": null, "statistics": null, "conversation_rating": null, "teammates": null, "title": null, "topics": {}, "conversation_parts": { "type": "conversation_part.list", "conversation_parts": [ { "type": "conversation_part", "id": "42", "part_type": "open", "body": "Thanks again :)
", "created_at": 1717021146, "updated_at": 1717021146, "notified_at": 1717021146, "assigned_to": null, "author": { "id": "6657a9d96abd01639cc9e9dd", "type": "user", "name": "Joe Bloggs", "email": "joe@bloggs.com" }, "attachments": [], "external_id": null, "redacted": false }, { "type": "conversation_part", "id": "43", "part_type": "language_detection_details", "body": null, "created_at": 1717021146, "updated_at": 1717021146, "notified_at": 1717021146, "assigned_to": null, "author": { "id": "991266948", "type": "bot", "name": "Operator", "email": "operator+this_is_an_id352_that_should_be_at_least_@intercom.io" }, "attachments": [], "external_id": null, "redacted": false } ], "total_count": 2 } } } }, "schema": { "$ref": "#/components/schemas/conversation" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "540641fa-f3dd-4206-989b-2ada5a3593d8", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "API plan restricted", "content": { "application/json": { "examples": { "API plan restricted": { "value": { "type": "error.list", "request_id": "1f150a32-8326-4fa1-bcc9-203865b49366", "errors": [ { "code": "api_plan_restricted", "message": "Active subscription needed." } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "examples": { "Not found": { "value": { "type": "error.list", "request_id": "58920d2a-122f-44c6-b49f-03b66a4af259", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reply_conversation_request" }, "examples": { "user_reply": { "summary": "User reply", "value": { "message_type": "comment", "type": "user", "intercom_user_id": "6657a9d36abd01639cc9e9da", "body": "Thanks again :)" } }, "admin_note_reply": { "summary": "Admin note reply", "value": { "message_type": "note", "type": "admin", "admin_id": 991266943, "body": "this is the message body
", "author": { "type": "admin", "id": "991266955", "name": "Ciaran198 Lee", "email": "admin198@email.com" }, "attachments": [], "url": null, "redacted": false }, "contacts": { "type": "contact.list", "contacts": [ { "type": "contact", "id": "6657a9df6abd01639cc9e9e1" } ] }, "first_contact_reply": null, "admin_assignee_id": 991267715, "team_assignee_id": 5017691, "open": false, "state": "closed", "read": false, "tags": { "type": "tag.list", "tags": [] }, "priority": "not_priority", "sla_applied": null, "statistics": null, "conversation_rating": null, "teammates": null, "title": null, "topics": {}, "conversation_parts": { "type": "conversation_part.list", "conversation_parts": [ { "type": "conversation_part", "id": "44", "part_type": "close", "body": "Goodbye :)
", "created_at": 1717021152, "updated_at": 1717021152, "notified_at": 1717021152, "assigned_to": null, "author": { "id": "991266955", "type": "admin", "name": "Ciaran198 Lee", "email": "admin198@email.com" }, "attachments": [], "external_id": null, "redacted": false } ], "total_count": 1 } } }, "Snooze a conversation": { "value": { "type": "conversation", "id": "213", "created_at": 1717021153, "updated_at": 1717021154, "waiting_since": null, "snoozed_until": 1717024754, "source": { "type": "conversation", "id": "403918182", "delivered_as": "admin_initiated", "subject": "", "body": "this is the message body
", "author": { "type": "admin", "id": "991266957", "name": "Ciaran199 Lee", "email": "admin199@email.com" }, "attachments": [], "url": null, "redacted": false }, "contacts": { "type": "contact.list", "contacts": [ { "type": "contact", "id": "6657a9e16abd01639cc9e9e2" } ] }, "first_contact_reply": null, "admin_assignee_id": 991267715, "team_assignee_id": 5017691, "open": true, "state": "snoozed", "read": false, "tags": { "type": "tag.list", "tags": [] }, "priority": "not_priority", "sla_applied": null, "statistics": null, "conversation_rating": null, "teammates": null, "title": null, "topics": {}, "conversation_parts": { "type": "conversation_part.list", "conversation_parts": [ { "type": "conversation_part", "id": "45", "part_type": "snoozed", "body": null, "created_at": 1717021154, "updated_at": 1717021154, "notified_at": 1717021154, "assigned_to": null, "author": { "id": "991266957", "type": "admin", "name": "Ciaran199 Lee", "email": "admin199@email.com" }, "attachments": [], "external_id": null, "redacted": false } ], "total_count": 1 } } }, "Open a conversation": { "value": { "type": "conversation", "id": "218", "created_at": 1717021153, "updated_at": 1717021162, "waiting_since": null, "snoozed_until": null, "source": { "type": "conversation", "id": "403918183", "delivered_as": "admin_initiated", "subject": "", "body": "this is the message body
", "author": { "type": "admin", "id": "991266959", "name": "Ciaran200 Lee", "email": "admin200@email.com" }, "attachments": [], "url": null, "redacted": false }, "contacts": { "type": "contact.list", "contacts": [ { "type": "contact", "id": "6657a9e46abd01639cc9e9e7" } ] }, "first_contact_reply": null, "admin_assignee_id": 991267715, "team_assignee_id": 5017691, "open": true, "state": "open", "read": true, "tags": { "type": "tag.list", "tags": [] }, "priority": "not_priority", "sla_applied": null, "statistics": null, "conversation_rating": null, "teammates": null, "title": "", "topics": {}, "conversation_parts": { "type": "conversation_part.list", "conversation_parts": [ { "type": "conversation_part", "id": "47", "part_type": "open", "body": null, "created_at": 1717021162, "updated_at": 1717021162, "notified_at": 1717021162, "assigned_to": null, "author": { "id": "991266959", "type": "admin", "name": "Ciaran200 Lee", "email": "admin200@email.com" }, "attachments": [], "external_id": null, "redacted": false } ], "total_count": 1 } } }, "Assign a conversation": { "value": { "type": "conversation", "id": "223", "created_at": 1717021163, "updated_at": 1717021164, "waiting_since": null, "snoozed_until": null, "source": { "type": "conversation", "id": "403918186", "delivered_as": "admin_initiated", "subject": "", "body": "this is the message body
", "author": { "type": "admin", "id": "991266962", "name": "Ciaran202 Lee", "email": "admin202@email.com" }, "attachments": [], "url": null, "redacted": false }, "contacts": { "type": "contact.list", "contacts": [ { "type": "contact", "id": "6657a9eb6abd01639cc9e9eb" } ] }, "first_contact_reply": null, "admin_assignee_id": 991267715, "team_assignee_id": 5017691, "open": true, "state": "open", "read": false, "tags": { "type": "tag.list", "tags": [] }, "priority": "not_priority", "sla_applied": null, "statistics": null, "conversation_rating": null, "teammates": null, "title": null, "topics": {}, "conversation_parts": { "type": "conversation_part.list", "conversation_parts": [ { "type": "conversation_part", "id": "48", "part_type": "assign_and_reopen", "body": null, "created_at": 1717021164, "updated_at": 1717021164, "notified_at": 1717021164, "assigned_to": { "type": "admin", "id": "991266962" }, "author": { "id": "991266962", "type": "admin", "name": "Ciaran202 Lee", "email": "admin202@email.com" }, "attachments": [], "external_id": null, "redacted": false } ], "total_count": 1 } } } }, "schema": { "$ref": "#/components/schemas/conversation" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "ad8d03ab-16c7-49a9-be79-29cc49458014", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "API plan restricted", "content": { "application/json": { "examples": { "API plan restricted": { "value": { "type": "error.list", "request_id": "a1c2e4b6-15ef-4b9a-9602-9c099f8a2c3e", "errors": [ { "code": "api_plan_restricted", "message": "Active subscription needed." } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "examples": { "Not found": { "value": { "type": "error.list", "request_id": "fa54feb9-5eff-4e32-93b9-a1d0e8134484", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/close_conversation_request" }, { "$ref": "#/components/schemas/snooze_conversation_request" }, { "$ref": "#/components/schemas/open_conversation_request" }, { "$ref": "#/components/schemas/assign_conversation_request" } ] }, "examples": { "close_a_conversation": { "summary": "Close a conversation", "value": { "message_type": "close", "type": "admin", "admin_id": 991266955, "body": "Goodbye :)" } }, "snooze_a_conversation": { "summary": "Snooze a conversation", "value": { "message_type": "snoozed", "admin_id": 991266957, "snoozed_until": 1717024754 } }, "open_a_conversation": { "summary": "Open a conversation", "value": { "message_type": "open", "admin_id": 991266959 } }, "assign_a_conversation": { "summary": "Assign a conversation", "value": { "message_type": "assignment", "type": "admin", "admin_id": 991266962, "assignee_id": 991266962 } }, "not_found": { "summary": "Not found", "value": { "message_type": "close", "type": "admin", "admin_id": 991266964, "body": "Goodbye :)" } } } } } } } }, "/conversations/{id}/run_assignment_rules": { "post": { "summary": "Run Assignment Rules on a conversation", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The identifier for the conversation as given by Intercom.", "example": "123", "schema": { "type": "string" } } ], "tags": [ "Conversations" ], "operationId": "autoAssignConversation", "description": "{% admonition type=\"danger\" name=\"Deprecation of Run Assignment Rules\" %}\nRun assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail.\n{% /admonition %}\nYou can let a conversation be automatically assigned following assignment rules.\n{% admonition type=\"warning\" name=\"When using workflows\" %}\nIt is not possible to use this endpoint with Workflows.\n{% /admonition %}\n", "responses": { "200": { "description": "Assign a conversation using assignment rules", "content": { "application/json": { "examples": { "Assign a conversation using assignment rules": { "value": { "type": "conversation", "id": "227", "created_at": 1717021169, "updated_at": 1717021170, "waiting_since": null, "snoozed_until": null, "source": { "type": "conversation", "id": "403918190", "delivered_as": "admin_initiated", "subject": "", "body": "this is the message body
", "author": { "type": "admin", "id": "991266970", "name": "Ciaran206 Lee", "email": "admin206@email.com" }, "attachments": [], "url": null, "redacted": false }, "contacts": { "type": "contact.list", "contacts": [ { "type": "contact", "id": "6657a9f16abd01639cc9e9ef" } ] }, "first_contact_reply": null, "admin_assignee_id": 991267715, "team_assignee_id": 5017691, "open": false, "state": "closed", "read": false, "tags": { "type": "tag.list", "tags": [] }, "priority": "not_priority", "sla_applied": null, "statistics": null, "conversation_rating": null, "teammates": null, "title": null, "topics": {}, "conversation_parts": { "type": "conversation_part.list", "conversation_parts": [ { "type": "conversation_part", "id": "49", "part_type": "default_assignment", "body": null, "created_at": 1717021170, "updated_at": 1717021170, "notified_at": 1717021170, "assigned_to": { "type": "nobody_admin", "id": null }, "author": { "id": "991266971", "type": "bot", "name": "Operator", "email": "operator+this_is_an_id375_that_should_be_at_least_@intercom.io" }, "attachments": [], "external_id": null, "redacted": false } ], "total_count": 1 } } } }, "schema": { "$ref": "#/components/schemas/conversation" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "456ac814-18c3-4dd6-a6a4-f2f2a1c8338d", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "API plan restricted", "content": { "application/json": { "examples": { "API plan restricted": { "value": { "type": "error.list", "request_id": "cb9b6e4e-8a85-4acb-a3d5-be8e6a59aea7", "errors": [ { "code": "api_plan_restricted", "message": "Active subscription needed." } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "examples": { "Not found": { "value": { "type": "error.list", "request_id": "3b9c18ce-e500-4660-9b79-1bca9b02593b", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/conversations/{id}/customers": { "post": { "summary": "Attach a contact to a conversation", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The identifier for the conversation as given by Intercom.", "example": "123", "schema": { "type": "string" } } ], "tags": [ "Conversations" ], "operationId": "attachContactToConversation", "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", "responses": { "200": { "description": "Attach a contact to a conversation", "content": { "application/json": { "examples": { "Attach a contact to a conversation": { "value": { "customers": [ { "type": "user", "id": "6657a9f76abd01639cc9e9f3" } ] } } }, "schema": { "$ref": "#/components/schemas/conversation" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "d169e47b-a0e5-49a5-a1d0-744f6c331303", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "API plan restricted", "content": { "application/json": { "examples": { "API plan restricted": { "value": { "type": "error.list", "request_id": "c7459e2f-5b80-4a48-8a57-7c645a66fba7", "errors": [ { "code": "api_plan_restricted", "message": "Active subscription needed." } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "examples": { "Not found": { "value": { "type": "error.list", "request_id": "6961972f-5f9f-4e51-90a1-cbb68066c8a9", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attach_contact_to_conversation_request" }, "examples": { "attach_a_contact_to_a_conversation": { "summary": "Attach a contact to a conversation", "value": { "admin_id": 991266978, "customer": { "intercom_user_id": "6657a9f76abd01639cc9e9f3" } } }, "not_found": { "summary": "Not found", "value": { "admin_id": 991266980, "customer": { "intercom_user_id": "6657a9f86abd01639cc9e9f4" } } } } } } } } }, "/conversations/{conversation_id}/customers/{contact_id}": { "delete": { "summary": "Detach a contact from a group conversation", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "conversation_id", "in": "path", "required": true, "description": "The identifier for the conversation as given by Intercom.", "example": "123", "schema": { "type": "string" } }, { "name": "contact_id", "in": "path", "required": true, "description": "The identifier for the contact as given by Intercom.", "example": "123", "schema": { "type": "string" } } ], "tags": [ "Conversations" ], "operationId": "detachContactFromConversation", "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", "responses": { "200": { "description": "Detach a contact from a group conversation", "content": { "application/json": { "examples": { "Detach a contact from a group conversation": { "value": { "customers": [ { "type": "user", "id": "6657aa036abd01639cc9e9ff" } ] } } }, "schema": { "$ref": "#/components/schemas/conversation" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "1031d580-4adb-4fcc-bbfb-bf91b2118626", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "API plan restricted", "content": { "application/json": { "examples": { "API plan restricted": { "value": { "type": "error.list", "request_id": "edc33112-95f1-40de-97d0-c9c0cba98102", "errors": [ { "code": "api_plan_restricted", "message": "Active subscription needed." } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Contact not found", "content": { "application/json": { "examples": { "Conversation not found": { "value": { "type": "error.list", "request_id": "45df0d39-645d-495f-b414-fdd3be52b95b", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } }, "Contact not found": { "value": { "type": "error.list", "request_id": "3f59d6d0-3faf-4108-9a8f-97e3dd26b08f", "errors": [ { "code": "not_found", "message": "User Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "422": { "description": "Last customer", "content": { "application/json": { "examples": { "Last customer": { "value": { "type": "error.list", "request_id": "6b8c78c3-f5d4-4d9e-beb1-4c5f22f08980", "errors": [ { "code": "parameter_invalid", "message": "Removing the last customer is not allowed" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/detach_contact_from_conversation_request" }, "examples": { "detach_a_contact_from_a_group_conversation": { "summary": "Detach a contact from a group conversation", "value": { "admin_id": 991266986, "customer": { "intercom_user_id": "6657a9fc6abd01639cc9e9f7" } } }, "conversation_not_found": { "summary": "Conversation not found", "value": { "admin_id": 991266989, "customer": { "intercom_user_id": "6657aa046abd01639cc9ea00" } } }, "contact_not_found": { "summary": "Contact not found", "value": { "admin_id": 991266992, "customer": { "intercom_user_id": "6657aa0b6abd01639cc9ea08" } } }, "last_customer": { "summary": "Last customer", "value": { "admin_id": 991266995, "customer": { "intercom_user_id": "6657aa136abd01639cc9ea10" } } } } } } } } }, "/conversations/redact": { "post": { "summary": "Redact a conversation part", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Conversations" ], "operationId": "redactConversation", "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", "responses": { "200": { "description": "Redact a conversation part", "content": { "application/json": { "examples": { "Redact a conversation part": { "value": { "type": "conversation", "id": "289", "created_at": 1717021225, "updated_at": 1717021227, "waiting_since": 1717021225, "snoozed_until": null, "source": { "type": "conversation", "id": "403918216", "delivered_as": "admin_initiated", "subject": "", "body": "this is the message body
", "author": { "type": "admin", "id": "991267004", "name": "Ciaran226 Lee", "email": "admin226@email.com" }, "attachments": [], "url": null, "redacted": false }, "contacts": { "type": "contact.list", "contacts": [ { "type": "contact", "id": "6657aa286abd01639cc9ea28" } ] }, "first_contact_reply": { "created_at": 1717021225, "type": "conversation", "url": null }, "admin_assignee_id": 991267715, "team_assignee_id": 5017691, "open": true, "state": "open", "read": true, "tags": { "type": "tag.list", "tags": [] }, "priority": "not_priority", "sla_applied": null, "statistics": null, "conversation_rating": null, "teammates": null, "title": null, "topics": {}, "conversation_parts": { "type": "conversation_part.list", "conversation_parts": [ { "type": "conversation_part", "id": "57", "part_type": "open", "body": "This message was deleted
", "created_at": 1717021225, "updated_at": 1717021226, "notified_at": 1717021225, "assigned_to": null, "author": { "id": "6657aa286abd01639cc9ea28", "type": "user", "name": "Joe Bloggs", "email": "joe@bloggs.com" }, "attachments": [], "external_id": null, "redacted": true }, { "type": "conversation_part", "id": "58", "part_type": "language_detection_details", "body": null, "created_at": 1717021225, "updated_at": 1717021225, "notified_at": 1717021225, "assigned_to": null, "author": { "id": "991267005", "type": "bot", "name": "Operator", "email": "operator+this_is_an_id409_that_should_be_at_least_@intercom.io" }, "attachments": [], "external_id": null, "redacted": false } ], "total_count": 2 } } } }, "schema": { "$ref": "#/components/schemas/conversation" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "fb4c6552-ef50-46d9-98f6-52443a8603a8", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "examples": { "Not found": { "value": { "type": "error.list", "request_id": "25a879f9-63d1-4618-ae55-5d92ce3cbc43", "errors": [ { "code": "conversation_part_or_message_not_found", "message": "Conversation part or message not found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redact_conversation_request" }, "examples": { "redact_a_conversation_part": { "summary": "Redact a conversation part", "value": { "type": "conversation_part", "conversation_id": 289, "conversation_part_id": 57 } }, "not_found": { "summary": "Not found", "value": { "type": "conversation_part", "conversation_id": "really_123_doesnt_exist", "conversation_part_id": "really_123_doesnt_exist" } } } } } } } }, "/data_attributes": { "get": { "summary": "List all data attributes", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "model", "in": "query", "required": false, "description": "Specify the data attribute model to return.", "schema": { "type": "string", "enum": [ "contact", "company", "conversation" ] }, "example": "company" }, { "name": "include_archived", "in": "query", "required": false, "description": "Include archived attributes in the list. By default we return only non archived data attributes.", "example": false, "schema": { "type": "boolean" } } ], "tags": [ "Data Attributes" ], "operationId": "lisDataAttributes", "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "examples": { "Successful response": { "value": { "type": "list", "data": [ { "type": "data_attribute", "name": "name", "full_name": "name", "label": "Company name", "description": "The name of a company", "data_type": "string", "api_writable": true, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" }, { "type": "data_attribute", "name": "company_id", "full_name": "company_id", "label": "Company ID", "description": "A number identifying a company", "data_type": "string", "api_writable": false, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" }, { "type": "data_attribute", "name": "last_request_at", "full_name": "last_request_at", "label": "Company last seen", "description": "The last day anyone from a company visited your site or app", "data_type": "date", "api_writable": false, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" }, { "type": "data_attribute", "name": "remote_created_at", "full_name": "remote_created_at", "label": "Company created at", "description": "The day a company was added to Intercom", "data_type": "date", "api_writable": true, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" }, { "type": "data_attribute", "name": "user_count", "full_name": "user_count", "label": "People", "description": "The number of people in a company", "data_type": "integer", "api_writable": false, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" }, { "type": "data_attribute", "name": "session_count", "full_name": "session_count", "label": "Company web sessions", "description": "All visits from anyone in a company to your product's site or app", "data_type": "integer", "api_writable": false, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" }, { "type": "data_attribute", "name": "name", "full_name": "plan.name", "label": "Plan", "description": "A specific plan or level within your product that companies have signed up to", "data_type": "string", "api_writable": false, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" }, { "type": "data_attribute", "name": "monthly_spend", "full_name": "monthly_spend", "label": "Monthly Spend", "description": "The monthly revenue you receive from a company", "data_type": "float", "api_writable": true, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" }, { "type": "data_attribute", "name": "size", "full_name": "size", "label": "Company size", "description": "The number of people employed in this company, expressed as a single number", "data_type": "integer", "api_writable": true, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" }, { "type": "data_attribute", "name": "industry", "full_name": "industry", "label": "Company industry", "description": "The category or domain this company belongs to e.g. 'ecommerce' or 'SaaS'", "data_type": "string", "api_writable": true, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" }, { "type": "data_attribute", "name": "website", "full_name": "website", "label": "Company website", "description": "The web address for the company's primary marketing site", "data_type": "string", "api_writable": true, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" }, { "id": 18, "type": "data_attribute", "name": "The One Ring", "full_name": "custom_attributes.The One Ring", "label": "The One Ring", "description": "One ring to rule them all, one ring to find them, One ring to bring them all and in the darkness bind them.", "data_type": "string", "api_writable": true, "ui_writable": false, "messenger_writable": true, "custom": true, "archived": false, "admin_id": "991267029", "created_at": 1717021240, "updated_at": 1717021240, "model": "company" }, { "type": "data_attribute", "name": "id", "full_name": "id", "label": "ID", "description": "The Intercom defined id representing the company", "data_type": "string", "api_writable": false, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" }, { "type": "data_attribute", "name": "created_at", "full_name": "created_at", "label": "Created at", "description": "The time the company was added to Intercom", "data_type": "date", "api_writable": false, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" }, { "type": "data_attribute", "name": "updated_at", "full_name": "updated_at", "label": "Updated at", "description": "The last time the company was updated", "data_type": "date", "api_writable": false, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" }, { "type": "data_attribute", "name": "id", "full_name": "plan.id", "label": "Plan ID", "description": "The Intercom defined id representing the plan", "data_type": "string", "api_writable": false, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" }, { "type": "data_attribute", "name": "app_id", "full_name": "app_id", "label": "App ID", "description": "The Intercom defined id representing the app", "data_type": "string", "api_writable": false, "ui_writable": false, "messenger_writable": true, "custom": false, "archived": false, "model": "company" } ] } } }, "schema": { "$ref": "#/components/schemas/data_attribute_list" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "55f5900d-a0ee-44e8-a054-1782a802f64d", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } }, "post": { "summary": "Create a data attribute", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Data Attributes" ], "operationId": "createDataAttribute", "description": "You can create a data attributes for a `contact` or a `company`.", "responses": { "200": { "description": "Successful", "content": { "application/json": { "examples": { "Successful": { "value": { "id": 21, "type": "data_attribute", "name": "Mithril Shirt", "full_name": "custom_attributes.Mithril Shirt", "label": "Mithril Shirt", "data_type": "string", "api_writable": true, "ui_writable": false, "messenger_writable": true, "custom": true, "archived": false, "admin_id": "991267031", "created_at": 1717021242, "updated_at": 1717021242, "model": "company" } } }, "schema": { "$ref": "#/components/schemas/data_attribute" } } } }, "400": { "description": "Too few options for list", "content": { "application/json": { "examples": { "Same name already exists": { "value": { "type": "error.list", "request_id": "9241fa98-1011-4c03-b1c3-6b999e89380b", "errors": [ { "code": "parameter_invalid", "message": "You already have 'The One Ring' in your company data. To save this as new people data, use a different name." } ] } }, "Invalid name": { "value": { "type": "error.list", "request_id": "2f5fab38-02fe-479c-87d1-dc1eb17a1b05", "errors": [ { "code": "parameter_invalid", "message": "Your name for this attribute must only contain alphanumeric characters, currency symbols, and hyphens" } ] } }, "Attribute already exists": { "value": { "type": "error.list", "request_id": "fe3ad799-5654-41d1-99e1-55f396cd46d1", "errors": [ { "code": "parameter_invalid", "message": "You already have 'The One Ring' in your company data. To save this as new company data, use a different name." } ] } }, "Invalid Data Type": { "value": { "type": "error.list", "request_id": "3b97514c-0762-445e-bf6c-3d3e150bd09c", "errors": [ { "code": "parameter_invalid", "message": "Data Type isn't an option" } ] } }, "Too few options for list": { "value": { "type": "error.list", "request_id": "95720d8c-258a-409b-a76d-43d4f85f0835", "errors": [ { "code": "parameter_invalid", "message": "The Data Attribute model field must be either contact or company" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "b601be7d-9c9d-4c60-bf6a-02a34f2c7c34", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_data_attribute_request" }, "examples": { "successful": { "summary": "Successful", "value": { "name": "Mithril Shirt", "model": "company", "data_type": "string" } }, "same_name_already_exists": { "summary": "Same name already exists", "value": { "name": "The One Ring", "model": "contact", "data_type": "integer" } }, "invalid_name": { "summary": "Invalid name", "value": { "name": "!nv@l!d n@me", "model": "company", "data_type": "string" } }, "attribute_already_exists": { "summary": "Attribute already exists", "value": { "name": "The One Ring", "model": "company", "data_type": "string" } }, "invalid_data_type": { "summary": "Invalid Data Type", "value": { "name": "The Second Ring", "model": "company", "data_type": "mithril" } }, "too_few_options_for_list": { "summary": "Too few options for list", "value": { "description": "Just a plain old ring", "options": [ { "value": "1-10" } ], "archived": false } } } } } } } }, "/data_attributes/{id}": { "put": { "summary": "Update a data attribute", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The data attribute id", "example": 1, "schema": { "type": "integer" } } ], "tags": [ "Data Attributes" ], "operationId": "updateDataAttribute", "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", "responses": { "200": { "description": "Successful", "content": { "application/json": { "examples": { "Successful": { "value": { "id": 28, "type": "data_attribute", "name": "The One Ring", "full_name": "custom_attributes.The One Ring", "label": "The One Ring", "description": "Just a plain old ring", "data_type": "string", "options": [ "1-10", "11-20" ], "api_writable": true, "ui_writable": false, "messenger_writable": true, "custom": true, "archived": false, "admin_id": "991267038", "created_at": 1717021245, "updated_at": 1717021245, "model": "company" } } }, "schema": { "$ref": "#/components/schemas/data_attribute" } } } }, "400": { "description": "Too few options in list", "content": { "application/json": { "examples": { "Too few options in list": { "value": { "type": "error.list", "request_id": "d5fa8989-6795-47cd-b0ad-42367dac2cd0", "errors": [ { "code": "parameter_invalid", "message": "Options isn't an array" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "b8b9dba1-79eb-44d3-87d5-ec1f5ba02355", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Attribute Not Found", "content": { "application/json": { "examples": { "Attribute Not Found": { "value": { "type": "error.list", "request_id": "045ca1b1-7008-4702-ad69-392c13236629", "errors": [ { "code": "field_not_found", "message": "We couldn't find that data attribute to update" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "422": { "description": "Has Dependant Object", "content": { "application/json": { "examples": { "Has Dependant Object": { "value": { "type": "error.list", "request_id": "b099edc7-e0c4-473a-b17a-674123c0b911", "errors": [ { "code": "data_invalid", "message": "The Data Attribute you are trying to archive has a dependant object" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_data_attribute_request" }, "examples": { "successful": { "summary": "Successful", "value": { "description": "Just a plain old ring", "options": [ { "value": "1-10" }, { "value": "11-20" } ], "archived": false } }, "too_few_options_in_list": { "summary": "Too few options in list", "value": { "description": "Too few options", "options": { "value": "1-10" }, "archived": false } }, "attribute_not_found": { "summary": "Attribute Not Found", "value": { "description": "Just a plain old ring", "options": [ { "value": "1-10" }, { "value": "11-20" } ], "archived": false } }, "has_dependant_object": { "summary": "Has Dependant Object", "value": { "description": "Trying to archieve", "archived": true } } } } } } } }, "/events": { "post": { "summary": "Submit a data event", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Data Events" ], "operationId": "createDataEvent", "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", "responses": { "202": { "description": "successful" }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "c27e773d-cae4-434d-a648-51031d0a4a4c", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_data_event_request" } } } } }, "get": { "summary": "List all data events", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "in": "query", "name": "filter", "required": true, "style": "form", "explode": true, "schema": { "type": "object", "oneOf": [ { "title": "user_id query parameter", "properties": { "user_id": { "type": "string" } }, "required": [ "user_id" ], "additionalProperties": false }, { "title": "intercom_user_id query parameter", "properties": { "intercom_user_id": { "type": "string" } }, "required": [ "intercom_user_id" ], "additionalProperties": false }, { "title": "email query parameter", "properties": { "email": { "type": "string" } }, "required": [ "email" ], "additionalProperties": false } ] } }, { "name": "type", "in": "query", "required": true, "description": "The value must be user", "schema": { "type": "string" } }, { "name": "summary", "in": "query", "required": false, "description": "summary flag", "schema": { "type": "boolean" } } ], "tags": [ "Data Events" ], "operationId": "lisDataEvents", "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", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "examples": { "Successful response": { "value": { "type": "event.summary", "events": [], "pages": { "next": "http://api.intercom.test/events?next page" }, "email": "user26@email.com", "intercom_user_id": "6657aa426abd01639cc9ea31", "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3" } } }, "schema": { "$ref": "#/components/schemas/data_event_summary" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "0b05c5ee-334d-4df5-884c-2b7c734760fd", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/events/summaries": { "post": { "summary": "Create event summaries", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Data Events" ], "operationId": "dataEventSummaries", "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", "responses": { "200": { "description": "successful" }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "1758c1b5-aae6-4255-9f4f-64c5487aa562", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_data_event_summaries_request" } } } } } }, "/export/content/data": { "post": { "summary": "Create content data export", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Data Export" ], "operationId": "createDataExport", "description": "To create your export job, you need to send a `POST` request to the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis endpoint exports **message delivery and engagement data** for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported data includes who received each message, when they received it, and how they engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces). It does not export raw message or conversation content.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>🚧 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.\n\n>❗️ Updated_at not included\n>\n> It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.\n\n>📘 Date ranges are inclusive\n>\n> Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.\n", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "job_identifier": "3ap6n5xl71bvi7e4", "status": "pending", "download_url": "", "download_expires_at": "" } } }, "schema": { "$ref": "#/components/schemas/data_export" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_data_exports_request" }, "examples": { "successful": { "summary": "successful", "value": { "created_at_after": 1717003253, "created_at_before": 1717021253 } } } } } } } }, "/export/content/data/{job_identifier}": { "get": { "summary": "Show content data export", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "job_identifier", "in": "path", "description": "job_identifier", "required": true, "schema": { "type": "string" } } ], "tags": [ "Data Export" ], "operationId": "getDataExport", "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", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "job_identifier": "vh3nwj48jjipdlmv", "status": "pending", "download_url": "", "download_expires_at": "" } } }, "schema": { "$ref": "#/components/schemas/data_export" } } } } } } }, "/export/cancel/{job_identifier}": { "post": { "summary": "Cancel content data export", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "job_identifier", "in": "path", "description": "job_identifier", "required": true, "schema": { "type": "string" } } ], "tags": [ "Data Export" ], "operationId": "cancelDataExport", "description": "You can cancel your job", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "job_identifier": "dz9tfsoqzc4w1r56", "status": "canceled", "download_url": "", "download_expires_at": "" } } }, "schema": { "$ref": "#/components/schemas/data_export" } } } } } } }, "/download/content/data/{job_identifier}": { "get": { "summary": "Download content data export", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "job_identifier", "in": "path", "description": "job_identifier", "required": true, "schema": { "type": "string" } } ], "tags": [ "Data Export" ], "operationId": "downloadDataExport", "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", "responses": { "200": { "description": "successful" } } } }, "/messages": { "post": { "summary": "Create a message", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Messages" ], "operationId": "createMessage", "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", "responses": { "200": { "description": "admin message created", "content": { "application/json": { "examples": { "user message created": { "value": { "type": "user_message", "id": "403918221", "created_at": 1717021255, "body": "heyy", "message_type": "inapp", "conversation_id": "294" } }, "lead message created": { "value": { "type": "user_message", "id": "403918222", "created_at": 1717021257, "body": "heyy", "message_type": "inapp", "conversation_id": "295" } }, "admin message created": { "value": { "type": "admin_message", "id": "10", "created_at": 1717021258, "subject": "heyy", "body": "heyy", "message_type": "inapp", "owner": { "type": "admin", "id": "991267061", "name": "Ciaran276 Lee", "email": "admin276@email.com", "away_mode_enabled": false, "away_mode_reassign": false } } } }, "schema": { "$ref": "#/components/schemas/message" } } } }, "400": { "description": "No body supplied for email message", "content": { "application/json": { "examples": { "No body supplied for message": { "value": { "type": "error.list", "request_id": "c414bc21-229e-4305-abac-9c3dd8696fbe", "errors": [ { "code": "parameter_invalid", "message": "Body is required" } ] } }, "No body supplied for email message": { "value": { "type": "error.list", "request_id": "df156c75-8c4d-4190-be45-75dc84d6347c", "errors": [ { "code": "parameter_invalid", "message": "Body is required" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "759a6ff7-7166-46c6-aa09-a2bd2661579b", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "403": { "description": "API plan restricted", "content": { "application/json": { "examples": { "API plan restricted": { "value": { "type": "error.list", "request_id": "f4bfff49-72e7-420a-ba72-dc89409e4db2", "errors": [ { "code": "api_plan_restricted", "message": "Active subscription needed." } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "422": { "description": "No subject supplied for email message", "content": { "application/json": { "examples": { "No subject supplied for email message": { "value": { "type": "error.list", "request_id": "5f4aa93c-bd56-4d56-af22-1b280962ba16", "errors": [ { "code": "parameter_not_found", "message": "No subject supplied for email message" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_message_request" }, "examples": { "user_message_created": { "summary": "user message created", "value": { "from": { "type": "user", "id": "6657aa476abd01639cc9ea36" }, "body": "heyy", "referer": "https://twitter.com/bob" } }, "lead_message_created": { "summary": "lead message created", "value": { "from": { "type": "lead", "id": "6657aa496abd01639cc9ea37" }, "body": "heyy", "referer": "https://twitter.com/bob" } }, "admin_message_created": { "summary": "admin message created", "value": { "from": { "type": "admin", "id": "991267061" }, "to": { "type": "user", "id": "6657aa4a6abd01639cc9ea38" }, "message_type": "conversation", "body": "heyy" } }, "no_body_supplied_for_message": { "summary": "No body supplied for message", "value": { "from": { "type": "admin", "id": "991267063" }, "to": { "type": "user", "id": "6657aa4b6abd01639cc9ea39" }, "message_type": "inapp", "body": null, "subject": "heyy" } }, "no_subject_supplied_for_email_message": { "summary": "No subject supplied for email message", "value": { "from": { "type": "admin", "id": "991267064" }, "to": { "type": "user", "user_id": "70" }, "message_type": "email", "body": "hey there" } }, "no_body_supplied_for_email_message": { "summary": "No body supplied for email message", "value": { "from": { "type": "admin", "id": "991267065" }, "to": { "type": "user", "id": "6657aa4c6abd01639cc9ea3b" }, "message_type": "email", "body": null, "subject": "heyy" } } } } } } } }, "/news/news_items": { "get": { "summary": "List all news items", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "News" ], "operationId": "listNewsItems", "description": "You can fetch a list of all news items", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "list", "pages": { "page": 1, "per_page": 10, "total_pages": 1, "type": "pages" }, "data": [ { "id": "15", "type": "news-item", "workspace_id": "this_is_an_id503_that_should_be_at_least_", "title": "We have news", "body": "Hello there,
", "sender_id": 991267070, "state": "draft", "labels": [], "cover_image_url": null, "reactions": [ null, null, null, null ], "deliver_silently": false, "created_at": 1717021262, "updated_at": 1717021262, "newsfeed_assignments": [] }, { "id": "16", "type": "news-item", "workspace_id": "this_is_an_id503_that_should_be_at_least_", "title": "We have news", "body": "Hello there,
", "sender_id": 991267072, "state": "draft", "labels": [], "cover_image_url": null, "reactions": [ null, null, null, null ], "deliver_silently": false, "created_at": 1717021262, "updated_at": 1717021262, "newsfeed_assignments": [] } ], "total_count": 2 } } }, "schema": { "$ref": "#/components/schemas/paginated_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "8254c030-c9b6-499e-88a3-19eaa35efc45", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } }, "post": { "summary": "Create a news item", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "News" ], "operationId": "createNewsItem", "description": "You can create a news item", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "id": "19", "type": "news-item", "workspace_id": "this_is_an_id507_that_should_be_at_least_", "title": "Halloween is here!", "body": "New costumes in store for this spooky season
", "sender_id": 991267079, "state": "live", "labels": [ "New", "Product", "Update" ], "cover_image_url": null, "reactions": [ "😆", "😅" ], "deliver_silently": true, "created_at": 1717021264, "updated_at": 1717021264, "newsfeed_assignments": [ { "newsfeed_id": 28, "published_at": 1664638214 } ] } } }, "schema": { "$ref": "#/components/schemas/news_item" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "59041e4c-b1cc-4cfb-9132-018c1974fd15", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/news_item_request" }, "examples": { "successful": { "summary": "successful", "value": { "title": "Halloween is here!", "body": "New costumes in store for this spooky season
", "labels": [ "Product", "Update", "New" ], "sender_id": 991267079, "deliver_silently": true, "reactions": [ "😆", "😅" ], "state": "live", "newsfeed_assignments": [ { "newsfeed_id": 28, "published_at": 1664638214 } ] } } } } } } } }, "/news/news_items/{id}": { "get": { "summary": "Retrieve a news item", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The unique identifier for the news item which is given by Intercom.", "example": 123, "schema": { "type": "integer" } } ], "tags": [ "News" ], "operationId": "retrieveNewsItem", "description": "You can fetch the details of a single news item.", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "id": "20", "type": "news-item", "workspace_id": "this_is_an_id511_that_should_be_at_least_", "title": "We have news", "body": "Hello there,
", "sender_id": 991267082, "state": "live", "labels": [], "cover_image_url": null, "reactions": [ null, null, null, null ], "deliver_silently": false, "created_at": 1717021265, "updated_at": 1717021265, "newsfeed_assignments": [ { "newsfeed_id": 30, "published_at": 1717021265 } ] } } }, "schema": { "$ref": "#/components/schemas/news_item" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "918bb992-a100-405f-89b8-fed57f5242b8", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "News Item Not Found", "content": { "application/json": { "examples": { "News Item Not Found": { "value": { "type": "error.list", "request_id": "34550886-e5ae-4e9c-b440-9bb02e5944f8", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } }, "put": { "summary": "Update a news item", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The unique identifier for the news item which is given by Intercom.", "example": 123, "schema": { "type": "integer" } } ], "tags": [ "News" ], "operationId": "updateNewsItem", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "id": "23", "type": "news-item", "workspace_id": "this_is_an_id517_that_should_be_at_least_", "title": "Christmas is here!", "body": "New gifts in store for the jolly season
", "sender_id": 991267090, "state": "live", "labels": [], "cover_image_url": null, "reactions": [ "😝", "😂" ], "deliver_silently": false, "created_at": 1717021267, "updated_at": 1717021267, "newsfeed_assignments": [] } } }, "schema": { "$ref": "#/components/schemas/news_item" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "3a106443-1484-4f08-9384-091a0d25f465", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "News Item Not Found", "content": { "application/json": { "examples": { "News Item Not Found": { "value": { "type": "error.list", "request_id": "92a2f1ae-96cd-436c-b214-80e210d833d7", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/news_item_request" }, "examples": { "successful": { "summary": "successful", "value": { "title": "Christmas is here!", "body": "New gifts in store for the jolly season
", "sender_id": 991267090, "reactions": [ "😝", "😂" ] } }, "news_item_not_found": { "summary": "News Item Not Found", "value": { "title": "Christmas is here!", "body": "New gifts in store for the jolly season
", "sender_id": 991267093, "reactions": [ "😝", "😂" ] } } } } } } }, "delete": { "summary": "Delete a news item", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The unique identifier for the news item which is given by Intercom.", "example": 123, "schema": { "type": "integer" } } ], "tags": [ "News" ], "operationId": "deleteNewsItem", "description": "You can delete a single news item.", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "id": "26", "object": "news-item", "deleted": true } } }, "schema": { "$ref": "#/components/schemas/deleted_object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "e0ccf4bd-7aba-435a-a4d7-86225e4c3c41", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "News Item Not Found", "content": { "application/json": { "examples": { "News Item Not Found": { "value": { "type": "error.list", "request_id": "f1efc828-2e52-48b6-b422-60f44a4f67d7", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/news/newsfeeds/{id}/items": { "get": { "summary": "List all live newsfeed items", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The unique identifier for the news feed item which is given by Intercom.", "example": "123", "schema": { "type": "string" } } ], "tags": [ "News" ], "operationId": "listLiveNewsfeedItems", "description": "You can fetch a list of all news items that are live on a given newsfeed", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "list", "pages": { "page": 1, "per_page": 20, "total_pages": 0, "type": "pages" }, "data": [], "total_count": 0 } } }, "schema": { "$ref": "#/components/schemas/paginated_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "4dedd436-7f40-443b-95f4-325a30069125", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/news/newsfeeds": { "get": { "summary": "List all newsfeeds", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "News" ], "operationId": "listNewsfeeds", "description": "You can fetch a list of all newsfeeds", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "list", "pages": { "page": 1, "per_page": 10, "total_pages": 1, "type": "pages" }, "data": [ { "id": "43", "type": "newsfeed", "name": "Visitor Feed", "created_at": 1717021272, "updated_at": 1717021272 }, { "id": "44", "type": "newsfeed", "name": "Visitor Feed", "created_at": 1717021272, "updated_at": 1717021272 } ], "total_count": 2 } } }, "schema": { "$ref": "#/components/schemas/paginated_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "82179d07-57c8-448f-9074-536f46ce6e49", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/news/newsfeeds/{id}": { "get": { "summary": "Retrieve a newsfeed", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The unique identifier for the news feed item which is given by Intercom.", "example": "123", "schema": { "type": "string" } } ], "tags": [ "News" ], "operationId": "retrieveNewsfeed", "description": "You can fetch the details of a single newsfeed", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "id": "47", "type": "newsfeed", "name": "Visitor Feed", "created_at": 1717021273, "updated_at": 1717021273 } } }, "schema": { "$ref": "#/components/schemas/newsfeed" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "3bb567a3-6085-43dd-89d5-a8d80eeda39f", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/notes/{id}": { "get": { "summary": "Retrieve a note", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The unique identifier of a given note", "example": 1, "schema": { "type": "integer" } } ], "tags": [ "Notes" ], "operationId": "retrieveNote", "description": "You can fetch the details of a single note.", "responses": { "200": { "description": "Note found", "content": { "application/json": { "examples": { "Note found": { "value": { "type": "note", "id": "24", "created_at": 1716330074, "contact": { "type": "contact", "id": "6657aa5a6abd01639cc9ea3e" }, "author": { "type": "admin", "id": "991267109", "name": "Ciaran323 Lee", "email": "admin323@email.com", "away_mode_enabled": false, "away_mode_reassign": false }, "body": "This is a note.
" } } }, "schema": { "$ref": "#/components/schemas/note" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "7036c267-82e0-4dee-b9a9-39b78883a569", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Note not found", "content": { "application/json": { "examples": { "Note not found": { "value": { "type": "error.list", "request_id": "a10c7ac3-ea24-4451-8fbd-7b1cffb263df", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/segments": { "get": { "summary": "List all segments", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "include_count", "in": "query", "required": false, "description": "It includes the count of contacts that belong to each segment.", "example": true, "schema": { "type": "boolean" } } ], "tags": [ "Segments" ], "operationId": "listSegments", "description": "You can fetch a list of all segments.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "examples": { "Successful response": { "value": { "type": "segment.list", "segments": [ { "type": "segment", "id": "6657aa5c6abd01639cc9ea41", "name": "John segment", "created_at": 1717021276, "updated_at": 1717021276, "person_type": "user" }, { "type": "segment", "id": "6657aa5c6abd01639cc9ea42", "name": "Jane segment", "created_at": 1717021276, "updated_at": 1717021276, "person_type": "user" } ] } } }, "schema": { "$ref": "#/components/schemas/segment_list" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "63f602d4-1aa6-4632-8450-3d774cc1f88a", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/segments/{id}": { "get": { "summary": "Retrieve a segment", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The unique identified of a given segment.", "example": "123", "schema": { "type": "string" } } ], "tags": [ "Segments" ], "operationId": "retrieveSegment", "description": "You can fetch the details of a single segment.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "examples": { "Successful response": { "value": { "type": "segment", "id": "6657aa5d6abd01639cc9ea45", "name": "John segment", "created_at": 1717021277, "updated_at": 1717021277, "person_type": "user" } } }, "schema": { "$ref": "#/components/schemas/segment" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "6da4b084-8feb-4793-8bf9-ddd5fe3cb015", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Segment not found", "content": { "application/json": { "examples": { "Segment not found": { "value": { "type": "error.list", "request_id": "b1f200b2-1468-4d1b-a3ba-48c2f03d67a5", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/subscription_types": { "get": { "summary": "List subscription types", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Subscription Types" ], "operationId": "listSubscriptionTypes", "description": "You can list all subscription types. A list of subscription type objects will be returned.", "responses": { "200": { "description": "Successful", "content": { "application/json": { "examples": { "Successful": { "value": { "type": "list", "data": [ { "type": "subscription", "id": "91", "state": "live", "consent_type": "opt_out", "default_translation": { "name": "Newsletters", "description": "Lorem ipsum dolor sit amet", "locale": "en" }, "translations": [ { "name": "Newsletters", "description": "Lorem ipsum dolor sit amet", "locale": "en" } ], "content_types": [ "email" ] } ] } } }, "schema": { "$ref": "#/components/schemas/subscription_type_list" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "e634390a-36b8-43ce-bfcf-b9436480b996", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/phone_call_redirects": { "post": { "summary": "Create a phone Switch", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Switch" ], "operationId": "createPhoneSwitch", "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", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "url": "http://via.intercom.io/msgr/961bb332-4dd3-4358-a03d-2d1ba1743272", "type": "phone_call_redirect" } } }, "schema": { "$ref": "#/components/schemas/phone_switch" } } } }, "400": { "description": "bad request - invalid number", "content": { "application/json": { "examples": { "bad request - exception sending sms": { "value": { "error_key": "sms_failed", "message": "SMS was not sent due to an unknown error" } }, "bad request - invalid number": { "value": { "error_key": "invalid_phone_number", "message": "Invalid phone number" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "0687d3ed-ff35-4dbb-a00e-51c4835d668f", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "422": { "description": "unprocessable entity", "content": { "application/json": { "examples": { "unprocessable entity": { "value": { "error_key": "some_error" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_phone_switch_request" }, "examples": { "successful": { "summary": "successful", "value": { "phone": "+353832345678", "custom_attributes": { "issue_type": "Billing", "priority": "High" } } }, "bad_request_-_exception_sending_sms": { "summary": "bad request - exception sending sms", "value": { "phone": "+353832345678", "custom_attributes": { "issue_type": "Billing", "priority": "High" } } }, "bad_request_-_invalid_number": { "summary": "bad request - invalid number", "value": { "phone": "+353832345678", "custom_attributes": { "issue_type": "Billing", "priority": "High" } } }, "unprocessable_entity": { "summary": "unprocessable entity", "value": { "phone": "+40241100100", "custom_attributes": { "issue_type": "Billing", "priority": "High" } } } } } } } } }, "/tags": { "get": { "summary": "List all tags", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Tags" ], "operationId": "listTags", "description": "You can fetch a list of all tags for a given workspace.\n\n", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "list", "data": [ { "type": "tag", "id": "64", "name": "Manual tag 1" } ] } } }, "schema": { "$ref": "#/components/schemas/tag_list" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "dbe9787a-d2ce-45f3-a0df-2dc6d448a5f1", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } }, "post": { "summary": "Create or update a tag, Tag or untag companies, Tag contacts", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Tags" ], "operationId": "createTag", "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", "responses": { "200": { "description": "Action successful", "content": { "application/json": { "examples": { "Action successful": { "value": { "type": "tag", "id": "67", "name": "test" } } }, "schema": { "$ref": "#/components/schemas/tag_basic" } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "examples": { "Invalid parameters": { "value": { "type": "error.list", "request_id": "bb5a7fdb-6f95-4239-9369-0783efc8e392", "errors": [ { "code": "parameter_invalid", "message": "invalid tag parameters" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "0f72dd0a-c61f-46ed-9d89-d605a7328f90", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "User not found", "content": { "application/json": { "examples": { "Company not found": { "value": { "type": "error.list", "request_id": "1cfc31fa-4fcd-4a84-918e-686749c191f9", "errors": [ { "code": "company_not_found", "message": "Company Not Found" } ] } }, "User not found": { "value": { "type": "error.list", "request_id": "75cc9ed3-5e35-4aea-a4c7-8d97cab6e6d1", "errors": [ { "code": "not_found", "message": "User Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/create_or_update_tag_request" }, { "$ref": "#/components/schemas/tag_company_request" }, { "$ref": "#/components/schemas/untag_company_request" }, { "$ref": "#/components/schemas/tag_multiple_users_request" } ] }, "examples": { "action_successful": { "summary": "Action successful", "value": { "name": "test" } }, "invalid_parameters": { "summary": "Invalid parameters", "value": { "test": "invalid" } }, "company_not_found": { "summary": "Company not found", "value": { "name": "test", "companies": [ { "company_id": "123" } ] } }, "user_not_found": { "summary": "User not found", "value": { "name": "test", "users": [ { "id": "123" } ] } } } } } } } }, "/tags/{id}": { "get": { "summary": "Find a specific tag", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "description": "The unique identifier of a given tag", "example": "123", "required": true, "schema": { "type": "string" } } ], "tags": [ "Tags" ], "operationId": "findTag", "description": "You can fetch the details of tags that are on the workspace by their id.\nThis will return a tag object.\n", "responses": { "200": { "description": "Tag found", "content": { "application/json": { "examples": { "Tag found": { "value": { "type": "tag", "id": "75", "name": "Manual tag" } } }, "schema": { "$ref": "#/components/schemas/tag_basic" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "4921c169-ffc3-4f67-8318-56877c8eedc4", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Tag not found", "content": { "application/json": { "examples": { "Tag not found": { "value": { "type": "error.list", "request_id": "8a030ef7-512e-43ea-b870-71e5cecc9b4d", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } }, "delete": { "summary": "Delete tag", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "description": "The unique identifier of a given tag", "example": "123", "required": true, "schema": { "type": "string" } } ], "tags": [ "Tags" ], "operationId": "deleteTag", "description": "You can delete the details of tags that are on the workspace by passing in the id.", "responses": { "200": { "description": "Successful" }, "400": { "description": "Tag has dependent objects", "content": { "application/json": { "examples": { "Tag has dependent objects": { "value": { "type": "error.list", "request_id": "58e5295a-5add-4f73-9351-09ce7a26aa45", "errors": [ { "code": "tag_has_dependent_objects", "message": "Unable to delete Tag with dependent objects. Segments: Seg 1." } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "03653ea6-49b8-4eb0-af2d-1870ea042214", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "examples": { "Resource not found": { "value": { "type": "error.list", "request_id": "afde7c7a-8813-420c-83ac-35e462869c51", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/teams": { "get": { "summary": "List all teams", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Teams" ], "operationId": "listTeams", "description": "This will return a list of team objects for the App.", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "team.list", "teams": [] } } }, "schema": { "$ref": "#/components/schemas/team_list" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "60e2e010-02cd-4933-907e-691680a84099", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/teams/{id}": { "get": { "summary": "Retrieve a team", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "id", "in": "path", "required": true, "description": "The unique identifier of a given team.", "example": "123", "schema": { "type": "string" } } ], "tags": [ "Teams" ], "operationId": "retrieveTeam", "description": "You can fetch the details of a single team, containing an array of admins that belong to this team.", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "team", "id": "991267147", "name": "team 1", "admin_ids": [] } } }, "schema": { "$ref": "#/components/schemas/team" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "dcf25206-503b-4e3b-af82-70eea3b95227", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Team not found", "content": { "application/json": { "examples": { "Team not found": { "value": { "type": "error.list", "request_id": "7f39318f-441d-4468-8b5b-2bfb41f18371", "errors": [ { "code": "team_not_found", "message": "Team not found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/visitors": { "put": { "summary": "Update a visitor", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Visitors" ], "operationId": "updateVisitor", "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", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "visitor", "id": "6657aa816abd01639cc9ea69", "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", "anonymous": true, "email": "", "phone": null, "name": "Gareth Bale", "pseudonym": "Rose Sunshine", "avatar": { "type": "avatar", "image_url": "https://static.intercomassets.com/app/pseudonym_avatars_2019/rose-sunshine.png" }, "app_id": "this_is_an_id636_that_should_be_at_least_", "companies": { "type": "company.list", "companies": [] }, "location_data": {}, "last_request_at": null, "created_at": 1717021313, "remote_created_at": 1717021313, "signed_up_at": 1717021313, "updated_at": 1717021313, "session_count": 0, "social_profiles": { "type": "social_profile.list", "social_profiles": [] }, "owner_id": null, "unsubscribed_from_emails": false, "marked_email_as_spam": false, "has_hard_bounced": false, "tags": { "type": "tag.list", "tags": [] }, "segments": { "type": "segment.list", "segments": [] }, "custom_attributes": {}, "referrer": null, "utm_campaign": null, "utm_content": null, "utm_medium": null, "utm_source": null, "utm_term": null, "do_not_track": null } } }, "schema": { "$ref": "#/components/schemas/visitor" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "8b50807d-f545-4c16-909c-772323103577", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "visitor Not Found", "content": { "application/json": { "examples": { "visitor Not Found": { "value": { "type": "error.list", "request_id": "a08f0ddc-3e62-418d-9fce-d790e7a8d6e0", "errors": [ { "code": "not_found", "message": "Visitor Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_visitor_request" }, "examples": { "successful": { "summary": "successful", "value": { "id": "6657aa816abd01639cc9ea69", "name": "Gareth Bale" } }, "visitor_not_found": { "summary": "visitor Not Found", "value": { "user_id": "fail", "name": "Christian Fail" } } } } } } }, "get": { "summary": "Retrieve a visitor with User ID", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } }, { "name": "user_id", "in": "query", "description": "The user_id of the Visitor you want to retrieve.", "required": true, "schema": { "type": "string" } } ], "tags": [ "Visitors" ], "operationId": "retrieveVisitorWithUserId", "description": "You can fetch the details of a single visitor.", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "visitor", "id": "6657aa836abd01639cc9ea6f", "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", "anonymous": true, "email": "", "phone": null, "name": null, "pseudonym": null, "avatar": { "type": "avatar", "image_url": null }, "app_id": "this_is_an_id642_that_should_be_at_least_", "companies": { "type": "company.list", "companies": [] }, "location_data": {}, "last_request_at": null, "created_at": 1717021315, "remote_created_at": 1717021315, "signed_up_at": 1717021315, "updated_at": 1717021315, "session_count": 0, "social_profiles": { "type": "social_profile.list", "social_profiles": [] }, "owner_id": null, "unsubscribed_from_emails": false, "marked_email_as_spam": false, "has_hard_bounced": false, "tags": { "type": "tag.list", "tags": [] }, "segments": { "type": "segment.list", "segments": [] }, "custom_attributes": {}, "referrer": null, "utm_campaign": null, "utm_content": null, "utm_medium": null, "utm_source": null, "utm_term": null, "do_not_track": null } } }, "schema": { "$ref": "#/components/schemas/visitor" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "5fea0d6b-8d4a-4c36-b349-66e6ee765ac8", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } }, "404": { "description": "Visitor not found", "content": { "application/json": { "examples": { "Visitor not found": { "value": { "type": "error.list", "request_id": "5f905ad6-48c0-4aa9-a373-160b1b99254a", "errors": [ { "code": "not_found", "message": "Visitor Not Found" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } } } }, "/visitors/convert": { "post": { "summary": "Convert a visitor", "parameters": [ { "name": "Intercom-Version", "in": "header", "schema": { "$ref": "#/components/schemas/intercom_version" } } ], "tags": [ "Visitors" ], "operationId": "convertVisitor", "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", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "successful": { "value": { "type": "contact", "id": "6657aa846abd01639cc9ea76", "workspace_id": "this_is_an_id648_that_should_be_at_least_", "external_id": null, "role": "user", "email": "foo@bar.com", "phone": null, "name": null, "avatar": null, "owner_id": null, "social_profiles": { "type": "list", "data": [] }, "has_hard_bounced": false, "marked_email_as_spam": false, "unsubscribed_from_emails": false, "created_at": 1717021316, "updated_at": 1717021317, "signed_up_at": 1717021316, "last_seen_at": null, "last_replied_at": null, "last_contacted_at": null, "last_email_opened_at": null, "last_email_clicked_at": null, "language_override": null, "browser": null, "browser_version": null, "browser_language": null, "os": null, "location": { "type": "location", "country": null, "region": null, "city": null, "country_code": null, "continent_code": null }, "android_app_name": null, "android_app_version": null, "android_device": null, "android_os_version": null, "android_sdk_version": null, "android_last_seen_at": null, "ios_app_name": null, "ios_app_version": null, "ios_device": null, "ios_os_version": null, "ios_sdk_version": null, "ios_last_seen_at": null, "custom_attributes": {}, "tags": { "type": "list", "data": [], "url": "/contacts/6657aa846abd01639cc9ea76/tags", "total_count": 0, "has_more": false }, "notes": { "type": "list", "data": [], "url": "/contacts/6657aa846abd01639cc9ea76/notes", "total_count": 0, "has_more": false }, "companies": { "type": "list", "data": [], "url": "/contacts/6657aa846abd01639cc9ea76/companies", "total_count": 0, "has_more": false }, "opted_out_subscription_types": { "type": "list", "data": [], "url": "/contacts/6657aa846abd01639cc9ea76/subscriptions", "total_count": 0, "has_more": false }, "opted_in_subscription_types": { "type": "list", "data": [], "url": "/contacts/6657aa846abd01639cc9ea76/subscriptions", "total_count": 0, "has_more": false }, "utm_campaign": null, "utm_content": null, "utm_medium": null, "utm_source": null, "utm_term": null, "referrer": null } } }, "schema": { "$ref": "#/components/schemas/contact" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "type": "error.list", "request_id": "6aea5bac-76c3-4117-9f9f-21d0002498aa", "errors": [ { "code": "unauthorized", "message": "Access Token Invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convert_visitor_request" }, "examples": { "successful": { "summary": "successful", "value": { "visitor": { "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3" }, "user": { "email": "foo@bar.com" }, "type": "user" } } } } } } } } }, "components": { "schemas": { "activity_log": { "title": "Activity Log", "type": "object", "description": "Activities performed by Admins.", "nullable": true, "properties": { "id": { "type": "string", "description": "The id representing the activity.", "example": "6" }, "performed_by": { "type": "object", "description": "Details about the Admin involved in the activity.", "properties": { "type": { "type": "string", "description": "String representing the object's type. Always has the value `admin`.", "example": "admin" }, "id": { "type": "string", "description": "The id representing the admin.", "example": "1295" }, "email": { "type": "string", "description": "The email of the admin.", "example": "john@example.com" }, "ip": { "type": "string", "description": "The IP address of the admin.", "example": "198.51.100.255" } } }, "metadata": { "$ref": "#/components/schemas/activity_log_metadata" }, "created_at": { "type": "integer", "format": "date-time", "description": "The time the activity was created.", "example": 1671028894 }, "activity_type": { "type": "string", "enum": [ "admin_assignment_limit_change", "admin_away_mode_change", "admin_deletion", "admin_deprovisioned", "admin_impersonation_end", "admin_impersonation_start", "admin_invite_change", "admin_invite_creation", "admin_invite_deletion", "admin_login_failure", "admin_login_success", "admin_logout", "admin_password_reset_request", "admin_password_reset_success", "admin_permission_change", "admin_provisioned", "admin_two_factor_auth_change", "admin_unauthorized_sign_in_method", "app_admin_join", "app_authentication_method_change", "app_data_deletion", "app_data_export", "app_google_sso_domain_change", "app_identity_verification_change", "app_name_change", "app_outbound_address_change", "app_package_installation", "app_package_token_regeneration", "app_package_uninstallation", "app_team_creation", "app_team_deletion", "app_team_membership_modification", "app_timezone_change", "app_webhook_creation", "app_webhook_deletion", "articles_in_messenger_enabled_change", "bulk_delete", "bulk_export", "campaign_deletion", "campaign_state_change", "conversation_part_deletion", "conversation_topic_change", "conversation_topic_creation", "conversation_topic_deletion", "help_center_settings_change", "inbound_conversations_change", "inbox_access_change", "message_deletion", "message_state_change", "messenger_look_and_feel_change", "messenger_search_required_change", "messenger_spaces_change", "office_hours_change", "role_change", "role_creation", "role_deletion", "ruleset_activation_title_preview", "ruleset_creation", "ruleset_deletion", "search_browse_enabled_change", "search_browse_required_change", "seat_change", "seat_revoke", "security_settings_change", "temporary_expectation_change", "upfront_email_collection_change", "welcome_message_change" ], "example": "app_name_change" }, "activity_description": { "type": "string", "description": "A sentence or two describing the activity.", "example": "Admin updated the app's name to \"My App\"." } } }, "activity_log_list": { "title": "Paginated Response", "type": "object", "description": "A paginated list of activity logs.", "properties": { "type": { "type": "string", "description": "String representing the object's type. Always has the value `activity_log.list`.", "example": "activity_log.list" }, "pages": { "$ref": "#/components/schemas/cursor_pages" }, "activity_logs": { "type": "array", "description": "An array of activity logs", "items": { "$ref": "#/components/schemas/activity_log" } } } }, "activity_log_metadata": { "title": "Activity Log Metadata", "type": "object", "description": "Additional data provided about Admin activity.", "nullable": true, "properties": { "sign_in_method": { "type": "string", "nullable": true, "description": "The way the admin signed in.", "example": "email_password" }, "external_id": { "type": "string", "nullable": true, "description": "The unique identifier for the contact which is provided by the Client.", "example": "f3b87a2e09d514c6c2e79b9a" }, "away_mode": { "type": "boolean", "nullable": true, "description": "The away mode status which is set to true when away and false when returned.", "example": true }, "away_status_reason": { "type": "string", "nullable": true, "description": "The reason the Admin is away.", "example": "😌 On a break" }, "reassign_conversations": { "type": "boolean", "nullable": true, "description": "Indicates if conversations should be reassigned while an Admin is away.", "example": false }, "source": { "type": "string", "nullable": true, "description": "The action that initiated the status change.", "example": "admin update from web - Admin id: 93" }, "auto_changed": { "type": "string", "nullable": true, "description": "Indicates if the status was changed automatically or manually.", "example": false }, "update_by": { "type": "integer", "nullable": true, "description": "The ID of the Admin who initiated the activity.", "example": 93 }, "update_by_name": { "type": "string", "nullable": true, "description": "The name of the Admin who initiated the activity.", "example": "Joe Bloggs" } } }, "addressable_list": { "title": "Addressable List", "type": "object", "nullable": false, "description": "A list used to access other resources from a parent model.", "properties": { "type": { "type": "string", "format": "uri", "description": "The addressable object type", "example": "note" }, "id": { "type": "string", "description": "The id of the addressable object", "example": "123" }, "url": { "type": "string", "format": "uri", "description": "Url to get more company resources for this contact", "example": "/contacts/5ba682d23d7cf92bef87bfd4/notes" } } }, "admin": { "title": "Admin", "type": "object", "x-tags": [ "Admins" ], "description": "Admins are teammate accounts that have access to a workspace.", "nullable": true, "properties": { "type": { "type": "string", "description": "String representing the object's type. Always has the value `admin`.", "example": "admin" }, "id": { "type": "string", "description": "The id representing the admin.", "example": "1295" }, "name": { "type": "string", "description": "The name of the admin.", "example": "Joe Examplee" }, "email": { "type": "string", "description": "The email of the admin.", "example": "wash@example.com" }, "job_title": { "type": "string", "description": "The job title of the admin.", "example": "Philosopher" }, "away_mode_enabled": { "type": "boolean", "description": "Identifies if this admin is currently set in away mode.", "example": false }, "away_mode_reassign": { "type": "boolean", "description": "Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.", "example": false }, "has_inbox_seat": { "type": "boolean", "description": "Identifies if this admin has a paid inbox seat to restrict/allow features that require them.", "example": true }, "team_ids": { "type": "array", "description": "This object represents the avatar associated with the admin.", "example": [ 814865 ], "items": { "type": "integer" } }, "avatar": { "type": "string", "format": "uri", "nullable": true, "description": "Image for the associated team or teammate", "example": "https://picsum.photos/200/300" }, "team_priority_level": { "$ref": "#/components/schemas/team_priority_level" } } }, "admin_list": { "title": "Admins", "type": "object", "description": "A list of admins associated with a given workspace.", "properties": { "type": { "type": "string", "description": "String representing the object's type. Always has the value `admin.list`.", "example": "admin.list" }, "admins": { "type": "array", "description": "A list of admins associated with a given workspace.", "items": { "$ref": "#/components/schemas/admin" } } } }, "admin_priority_level": { "title": "Admin Priority Level", "type": "object", "nullable": true, "description": "Admin priority levels for the team", "properties": { "primary_admin_ids": { "type": "array", "description": "The primary admin ids for the team", "nullable": true, "example": [ 493881 ], "items": { "type": "integer" } }, "secondary_admin_ids": { "type": "array", "description": "The secondary admin ids for the team", "nullable": true, "example": [ 814865 ], "items": { "type": "integer" } } } }, "admin_reply_conversation_request": { "title": "Admin Reply", "type": "object", "description": "Payload of the request to reply on behalf of an admin", "properties": { "message_type": { "type": "string", "enum": [ "comment", "note" ] }, "type": { "type": "string", "enum": [ "admin" ], "example": "admin" }, "body": { "type": "string", "description": "The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types.", "example": "Hello there!" }, "admin_id": { "type": "string", "description": "The id of the admin who is authoring the comment.", "example": "3156780" }, "created_at": { "type": "integer", "description": "The time the reply was created. If not provided, the current time will be used.", "example": 1590000000 }, "attachment_urls": { "type": "array", "description": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", "items": { "type": "string", "format": "uri" }, "maxItems": 10 }, "attachment_files": { "type": "array", "description": "A list of files that will be added as attachments. You can include up to 10 files", "items": { "$ref": "#/components/schemas/conversation_attachment_files" }, "maxItems": 10 } }, "required": [ "message_type", "type", "admin_id" ] }, "admin_with_app": { "title": "Admin", "type": "object", "description": "Admins are the teammate accounts that have access to a workspace", "nullable": true, "properties": { "type": { "type": "string", "description": "String representing the object's type. Always has the value `admin`.", "example": "admin" }, "id": { "type": "string", "description": "The id representing the admin.", "example": "1295" }, "name": { "type": "string", "description": "The name of the admin.", "example": "Joe Examplee" }, "email": { "type": "string", "description": "The email of the admin.", "example": "wash@example.com" }, "job_title": { "type": "string", "description": "The job title of the admin.", "example": "Philosopher" }, "away_mode_enabled": { "type": "boolean", "description": "Identifies if this admin is currently set in away mode.", "example": false }, "away_mode_reassign": { "type": "boolean", "description": "Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.", "example": false }, "has_inbox_seat": { "type": "boolean", "description": "Identifies if this admin has a paid inbox seat to restrict/allow features that require them.", "example": true }, "team_ids": { "type": "array", "description": "This is a list of ids of the teams that this admin is part of.", "example": [ 814865 ], "items": { "type": "integer" } }, "avatar": { "type": "object", "description": "This object represents the avatar associated with the admin.", "properties": { "type": { "type": "string", "description": "This is a string that identifies the type of the object. It will always have the value `avatar`.", "default": "avatar", "example": "avatar" }, "image_url": { "type": "string", "format": "uri", "nullable": true, "description": "This object represents the avatar associated with the admin.", "example": "https://example.com/avatar.png" } } }, "email_verified": { "type": "boolean", "description": "Identifies if this admin's email is verified.", "nullable": true, "example": true }, "app": { "$ref": "#/components/schemas/app", "nullable": true, "description": "App that the admin belongs to." } } }, "app": { "title": "App", "type": "object", "description": "App is a workspace on Intercom", "nullable": true, "properties": { "type": { "type": "string", "description": "", "default": "app", "example": "app" }, "id_code": { "type": "string", "description": "The id of the app.", "example": "xyz789" }, "name": { "type": "string", "description": "The name of the app.", "example": "ACME" }, "region": { "type": "string", "description": "The Intercom region the app is located in.", "example": "US" }, "timezone": { "type": "string", "description": "The timezone of the region where the app is located.", "example": "America/Los_Angeles" }, "created_at": { "type": "integer", "description": "When the app was created.", "example": 1671465577 }, "identity_verification": { "type": "boolean", "description": "Whether or not the app uses identity verification.", "example": false } } }, "article": { "title": "Article", "type": "object", "x-tags": [ "Articles" ], "description": "The Articles API is a central place to gather all information and take actions on your articles. Articles can live within collections and sections, or alternatively they can stand alone.", "properties": { "statistics": { "nullable": true, "$ref": "#/components/schemas/article_statistics" } }, "allOf": [ { "$ref": "#/components/schemas/article_list_item" } ] }, "article_content": { "title": "Article Content", "type": "object", "description": "The Content of an Article.", "nullable": true, "properties": { "type": { "type": "string", "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ], "example": "article_content", "nullable": true }, "title": { "type": "string", "description": "The title of the article.", "example": "How to create a new article" }, "description": { "type": "string", "description": "The description of the article.", "example": "This article will show you how to create a new article." }, "body": { "type": "string", "description": "The body of the article.", "example": "This is the body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article.", "example": "5017691" }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ], "example": "draft" }, "created_at": { "type": "integer", "format": "date-time", "description": "The time when the article was created (seconds).", "example": 1663597223 }, "updated_at": { "type": "integer", "format": "date-time", "description": "The time when the article was last updated (seconds).", "example": 1663597260 }, "url": { "type": "string", "description": "The URL of the article.", "example": "http://intercom.test/help/en/articles/3-default-language" } } }, "article_list": { "title": "Articles", "type": "object", "description": "This will return a list of articles for the App.", "properties": { "type": { "type": "string", "description": "The type of the object - `list`.", "enum": [ "list" ], "example": "list" }, "pages": { "$ref": "#/components/schemas/cursor_pages" }, "total_count": { "type": "integer", "description": "A count of the total number of articles.", "example": 1 }, "data": { "type": "array", "description": "An array of Article objects", "items": { "$ref": "#/components/schemas/article_list_item" } } } }, "article_list_item": { "title": "Articles", "type": "object", "x-tags": [ "Articles" ], "description": "The data returned about your articles when you list them.", "properties": { "type": { "type": "string", "description": "The type of object - `article`.", "enum": [ "article" ], "default": "article", "example": "article" }, "id": { "type": "string", "description": "The unique identifier for the article which is given by Intercom.", "example": "6871119" }, "workspace_id": { "type": "string", "description": "The id of the workspace which the article belongs to.", "example": "hfi1bx4l" }, "title": { "type": "string", "description": "The title of the article. For multilingual articles, this will be the title of the default language's content.", "example": "Default language title" }, "description": { "type": "string", "nullable": true, "description": "The description of the article. For multilingual articles, this will be the description of the default language's content.", "example": "Default language description" }, "body": { "type": "string", "nullable": true, "description": "The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.", "example": "Default language body in html" }, "author_id": { "type": "integer", "description": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", "example": "5017691" }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content.", "enum": [ "published", "draft" ], "default": "draft", "example": "published" }, "created_at": { "type": "integer", "format": "date-time", "description": "The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.", "example": 1672928359 }, "updated_at": { "type": "integer", "format": "date-time", "description": "The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.", "example": 1672928610 }, "url": { "type": "string", "nullable": true, "description": "The URL of the article. For multilingual articles, this will be the URL of the default language's content.", "example": "http://intercom.test/help/en/articles/3-default-language" }, "parent_id": { "type": "integer", "nullable": true, "description": "The id of the article's parent collection or section. An article without this field stands alone.", "example": "125685" }, "parent_ids": { "type": "array", "description": "The ids of the article's parent collections or sections. An article without this field stands alone.", "items": { "type": "integer" }, "example": [ 18, 19 ] }, "parent_type": { "type": "string", "nullable": true, "description": "The type of parent, which can either be a `collection` or `section`.", "example": "collection" }, "default_locale": { "type": "string", "description": "The default locale of the help center. This field is only returned for multilingual help centers.", "example": "en" }, "translated_content": { "nullable": true, "$ref": "#/components/schemas/article_translated_content" } } }, "article_statistics": { "title": "Article Statistics", "type": "object", "description": "The statistics of an article.", "nullable": true, "properties": { "type": { "type": "string", "description": "The type of object - `article_statistics`.", "enum": [ "article_statistics" ], "default": "article_statistics", "example": "article_statistics" }, "views": { "type": "integer", "description": "The number of total views the article has received.", "example": 10 }, "conversions": { "type": "integer", "description": "The number of conversations started from the article.", "example": 0 }, "reactions": { "type": "integer", "description": "The number of total reactions the article has received.", "example": 10 }, "happy_reaction_percentage": { "type": "number", "format": "float", "description": "The percentage of happy reactions the article has received against other types of reaction.", "example": 40 }, "neutral_reaction_percentage": { "type": "number", "format": "float", "description": "The percentage of neutral reactions the article has received against other types of reaction.", "example": 40 }, "sad_reaction_percentage": { "type": "number", "format": "float", "description": "The percentage of sad reactions the article has received against other types of reaction.", "example": 20 } } }, "article_translated_content": { "title": "Article Translated Content", "type": "object", "description": "The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.", "nullable": true, "properties": { "type": { "type": "string", "description": "The type of object - article_translated_content.", "enum": [ null, "article_translated_content" ], "example": "article_translated_content", "nullable": true }, "ar": { "description": "The content of the article in Arabic", "$ref": "#/components/schemas/article_content" }, "bg": { "description": "The content of the article in Bulgarian", "$ref": "#/components/schemas/article_content" }, "bs": { "description": "The content of the article in Bosnian", "$ref": "#/components/schemas/article_content" }, "ca": { "description": "The content of the article in Catalan", "$ref": "#/components/schemas/article_content" }, "cs": { "description": "The content of the article in Czech", "$ref": "#/components/schemas/article_content" }, "da": { "description": "The content of the article in Danish", "$ref": "#/components/schemas/article_content" }, "de": { "description": "The content of the article in German", "$ref": "#/components/schemas/article_content" }, "el": { "description": "The content of the article in Greek", "$ref": "#/components/schemas/article_content" }, "en": { "description": "The content of the article in English", "$ref": "#/components/schemas/article_content" }, "es": { "description": "The content of the article in Spanish", "$ref": "#/components/schemas/article_content" }, "et": { "description": "The content of the article in Estonian", "$ref": "#/components/schemas/article_content" }, "fi": { "description": "The content of the article in Finnish", "$ref": "#/components/schemas/article_content" }, "fr": { "description": "The content of the article in French", "$ref": "#/components/schemas/article_content" }, "he": { "description": "The content of the article in Hebrew", "$ref": "#/components/schemas/article_content" }, "hr": { "description": "The content of the article in Croatian", "$ref": "#/components/schemas/article_content" }, "hu": { "description": "The content of the article in Hungarian", "$ref": "#/components/schemas/article_content" }, "id": { "description": "The content of the article in Indonesian", "$ref": "#/components/schemas/article_content" }, "it": { "description": "The content of the article in Italian", "$ref": "#/components/schemas/article_content" }, "ja": { "description": "The content of the article in Japanese", "$ref": "#/components/schemas/article_content" }, "ko": { "description": "The content of the article in Korean", "$ref": "#/components/schemas/article_content" }, "lt": { "description": "The content of the article in Lithuanian", "$ref": "#/components/schemas/article_content" }, "lv": { "description": "The content of the article in Latvian", "$ref": "#/components/schemas/article_content" }, "mn": { "description": "The content of the article in Mongolian", "$ref": "#/components/schemas/article_content" }, "nb": { "description": "The content of the article in Norwegian", "$ref": "#/components/schemas/article_content" }, "nl": { "description": "The content of the article in Dutch", "$ref": "#/components/schemas/article_content" }, "pl": { "description": "The content of the article in Polish", "$ref": "#/components/schemas/article_content" }, "pt": { "description": "The content of the article in Portuguese (Portugal)", "$ref": "#/components/schemas/article_content" }, "ro": { "description": "The content of the article in Romanian", "$ref": "#/components/schemas/article_content" }, "ru": { "description": "The content of the article in Russian", "$ref": "#/components/schemas/article_content" }, "sl": { "description": "The content of the article in Slovenian", "$ref": "#/components/schemas/article_content" }, "sr": { "description": "The content of the article in Serbian", "$ref": "#/components/schemas/article_content" }, "sv": { "description": "The content of the article in Swedish", "$ref": "#/components/schemas/article_content" }, "tr": { "description": "The content of the article in Turkish", "$ref": "#/components/schemas/article_content" }, "vi": { "description": "The content of the article in Vietnamese", "$ref": "#/components/schemas/article_content" }, "pt-BR": { "description": "The content of the article in Portuguese (Brazil)", "$ref": "#/components/schemas/article_content" }, "zh-CN": { "description": "The content of the article in Chinese (China)", "$ref": "#/components/schemas/article_content" }, "zh-TW": { "description": "The content of the article in Chinese (Taiwan)", "$ref": "#/components/schemas/article_content" } } }, "assign_conversation_request": { "title": "Assign Conversation Request", "type": "object", "description": "Payload of the request to assign a conversation", "properties": { "message_type": { "type": "string", "enum": [ "assignment" ], "example": "assignment" }, "type": { "type": "string", "enum": [ "admin", "team" ], "example": "admin" }, "admin_id": { "type": "string", "description": "The id of the admin who is performing the action.", "example": "12345" }, "assignee_id": { "type": "string", "description": "The `id` of the `admin` or `team` which will be assigned the conversation. A conversation can be assigned both an admin and a team.\\nSet `0` if you want this assign to no admin or team (ie. Unassigned).", "example": "4324241" }, "body": { "type": "string", "description": "Optionally you can send a response in the conversation when it is assigned.", "example": "Let me pass you over to one of my colleagues." } }, "required": [ "message_type", "type", "admin_id", "assignee_id" ] }, "attach_contact_to_conversation_request": { "title": "Assign Conversation Request", "type": "object", "description": "Payload of the request to assign a conversation", "properties": { "admin_id": { "type": "string", "description": "The `id` of the admin who is adding the new participant.", "example": "12345" }, "customer": { "type": "object", "oneOf": [ { "title": "Intercom User ID", "properties": { "intercom_user_id": { "type": "string", "description": "The identifier for the contact as given by Intercom.", "example": "6329bd9ffe4e2e91dac76188" }, "customer": { "$ref": "#/components/schemas/customer_request" } }, "required": [ "intercom_user_id" ] }, { "title": "User ID", "properties": { "user_id": { "type": "string", "description": "The external_id you have defined for the contact who is being added as a participant.", "example": "6329bd9ffe4e2e91dac76188" }, "customer": { "$ref": "#/components/schemas/customer_request" } }, "required": [ "user_id" ] }, { "title": "Email", "properties": { "email": { "type": "string", "description": "The email you have defined for the contact who is being added as a participant.", "example": "joe@example.com" }, "customer": { "$ref": "#/components/schemas/customer_request" } }, "required": [ "email" ] } ] } } }, "close_conversation_request": { "title": "Close Conversation Request", "type": "object", "description": "Payload of the request to close a conversation", "properties": { "message_type": { "type": "string", "enum": [ "close" ], "example": "close" }, "type": { "type": "string", "enum": [ "admin" ], "example": "admin" }, "admin_id": { "type": "string", "description": "The id of the admin who is performing the action.", "example": "12345" }, "body": { "type": "string", "description": "Optionally you can leave a message in the conversation to provide additional context to the user and other teammates.", "example": " This conversation is now closed!" } }, "required": [ "message_type", "type", "admin_id" ] }, "collection": { "title": "Collection", "type": "object", "x-tags": [ "Help Center" ], "description": "Collections are top level containers for Articles within the Help Center.", "properties": { "id": { "type": "string", "description": "The unique identifier for the collection which is given by Intercom.", "example": "6871119" }, "workspace_id": { "type": "string", "description": "The id of the workspace which the collection belongs to.", "example": "hfi1bx4l" }, "name": { "type": "string", "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content.", "example": "Default language name" }, "description": { "type": "string", "nullable": true, "description": "The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.", "example": "Default language description" }, "created_at": { "type": "integer", "format": "date-time", "description": "The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.", "example": 1672928359 }, "updated_at": { "type": "integer", "format": "date-time", "description": "The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.", "example": 1672928610 }, "url": { "type": "string", "nullable": true, "description": "The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.", "example": "http://intercom.test/help/collection/name" }, "icon": { "type": "string", "nullable": true, "description": "The icon of the collection.", "example": "book-bookmark" }, "order": { "type": "integer", "description": "The order of the section in relation to others sections within a collection. Values go from `0` upwards. `0` is the default if there's no order.", "example": "1" }, "default_locale": { "type": "string", "description": "The default locale of the help center. This field is only returned for multilingual help centers.", "example": "en" }, "translated_content": { "nullable": true, "$ref": "#/components/schemas/group_translated_content" }, "help_center_id": { "type": "integer", "nullable": true, "description": "The id of the help center the collection is in.", "example": "123" }, "type": { "type": "string", "description": "The type of object - `collection`.", "enum": [ "collection" ], "default": "collection", "example": "collection" } } }, "collection_list": { "title": "Collections", "type": "object", "description": "This will return a list of Collections for the App.", "properties": { "type": { "type": "string", "description": "The type of the object - `list`.", "enum": [ "list" ], "example": "list" }, "pages": { "$ref": "#/components/schemas/cursor_pages" }, "total_count": { "type": "integer", "description": "A count of the total number of collections.", "example": 1 }, "data": { "type": "array", "description": "An array of collection objects", "items": { "$ref": "#/components/schemas/collection" } } } }, "company": { "title": "Company", "type": "object", "x-tags": [ "Companies" ], "description": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", "properties": { "type": { "type": "string", "description": "Value is `company`", "enum": [ "company" ], "example": "company" }, "id": { "type": "string", "description": "The Intercom defined id representing the company.", "example": "531ee472cce572a6ec000006" }, "name": { "type": "string", "description": "The name of the company.", "example": "Example Company Inc." }, "app_id": { "type": "string", "description": "The Intercom defined code of the workspace the company is associated to.", "example": "ecahpwf5" }, "plan": { "type": "object", "properties": { "type": { "type": "string", "description": "Value is always \"plan\"", "example": "plan" }, "id": { "type": "string", "description": "The id of the plan", "example": "269315" }, "name": { "type": "string", "description": "The name of the plan", "example": "Pro" } } }, "company_id": { "type": "string", "description": "The company id you have defined for the company.", "example": "6" }, "remote_created_at": { "type": "integer", "description": "The time the company was created by you.", "example": 1663597223 }, "created_at": { "type": "integer", "description": "The time the company was added in Intercom.", "example": 1663597223 }, "updated_at": { "type": "integer", "description": "The last time the company was updated.", "example": 1663597223 }, "last_request_at": { "type": "integer", "description": "The time the company last recorded making a request.", "example": 1663597223 }, "size": { "type": "integer", "description": "The number of employees in the company.", "example": 100 }, "website": { "type": "string", "description": "The URL for the company website.", "example": "https://www.intercom.com" }, "industry": { "type": "string", "description": "The industry that the company operates in.", "example": "Software" }, "monthly_spend": { "type": "integer", "description": "How much revenue the company generates for your business.", "example": 100 }, "session_count": { "type": "integer", "description": "How many sessions the company has recorded.", "example": 100 }, "user_count": { "type": "integer", "description": "The number of users in the company.", "example": 100 }, "custom_attributes": { "type": "object", "description": "The custom attributes you have set on the company.", "additionalProperties": { "type": "string" }, "example": { "paid_subscriber": true, "monthly_spend": 155.5, "team_mates": 9 } }, "tags": { "type": "object", "description": "The list of tags associated with the company", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "tag.list" ] }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/tag_basic" } } } }, "segments": { "type": "object", "description": "The list of segments associated with the company", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "segment.list" ] }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/segment" } } } } } }, "company_attached_contacts": { "title": "Company Attached Contacts", "type": "object", "description": "A list of Contact Objects", "properties": { "type": { "type": "string", "description": "The type of object - `list`", "enum": [ "list" ], "example": "list" }, "data": { "type": "array", "description": "An array containing Contact Objects", "items": { "$ref": "#/components/schemas/contact" } }, "total_count": { "type": "integer", "description": "The total number of contacts", "example": 100 }, "pages": { "$ref": "#/components/schemas/cursor_pages" } } }, "company_attached_segments": { "title": "Company Attached Segments", "type": "object", "description": "A list of Segment Objects", "properties": { "type": { "type": "string", "description": "The type of object - `list`", "enum": [ "list" ], "example": "list" }, "data": { "type": "array", "description": "An array containing Segment Objects", "items": { "$ref": "#/components/schemas/segment" } } } }, "company_list": { "title": "Companies", "type": "object", "description": "This will return a list of companies for the App.", "properties": { "type": { "type": "string", "description": "The type of object - `list`.", "enum": [ "list" ], "example": "list" }, "pages": { "$ref": "#/components/schemas/cursor_pages" }, "total_count": { "type": "integer", "description": "The total number of companies.", "example": 100 }, "data": { "type": "array", "description": "An array containing Company Objects.", "items": { "$ref": "#/components/schemas/company" } } } }, "company_scroll": { "title": "Company Scroll", "type": "object", "description": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", "nullable": true, "properties": { "type": { "type": "string", "description": "The type of object - `list`", "enum": [ "list" ], "example": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/company" } }, "pages": { "$ref": "#/components/schemas/cursor_pages" }, "total_count": { "type": "integer", "description": "The total number of companies", "nullable": true, "example": 100 }, "scroll_param": { "type": "string", "description": "The scroll parameter to use in the next request to fetch the next page of results.", "example": "25b649f7-4d33-4ef6-88f5-60e5b8244309" } } }, "contact": { "title": "Contact", "type": "object", "x-tags": [ "Contacts" ], "description": "Contact are the objects that represent your leads and users in Intercom.", "properties": { "type": { "type": "string", "description": "The type of object.", "example": "contact" }, "id": { "type": "string", "description": "The unique identifier for the contact which is given by Intercom.", "example": "5ba682d23d7cf92bef87bfd4" }, "external_id": { "type": "string", "nullable": true, "description": "The unique identifier for the contact which is provided by the Client.", "example": "f3b87a2e09d514c6c2e79b9a" }, "workspace_id": { "type": "string", "description": "The id of the workspace which the contact belongs to.", "example": "ecahpwf5" }, "role": { "type": "string", "description": "The role of the contact.", "example": "user" }, "email": { "type": "string", "description": "The contact's email.", "example": "joe@example.com" }, "email_domain": { "type": "string", "description": "The contact's email domain.", "example": "example.com" }, "phone": { "type": "string", "nullable": true, "description": "The contacts phone.", "example": "+1123456789" }, "name": { "type": "string", "nullable": true, "description": "The contacts name.", "example": "John Doe" }, "owner_id": { "type": "integer", "nullable": true, "description": "The id of an admin that has been assigned account ownership of the contact.", "example": 123 }, "has_hard_bounced": { "type": "boolean", "description": "Whether the contact has had an email sent to them hard bounce.", "example": true }, "marked_email_as_spam": { "type": "boolean", "description": "Whether the contact has marked an email sent to them as spam.", "example": true }, "unsubscribed_from_emails": { "type": "boolean", "description": "Whether the contact is unsubscribed from emails.", "example": true }, "created_at": { "type": "integer", "format": "date-time", "description": "(UNIX timestamp) The time when the contact was created.", "example": 1571672154 }, "updated_at": { "type": "integer", "format": "date-time", "description": "(UNIX timestamp) The time when the contact was last updated.", "example": 1571672154 }, "signed_up_at": { "type": "integer", "format": "date-time", "nullable": true, "description": "(UNIX timestamp) The time specified for when a contact signed up.", "example": 1571672154 }, "last_seen_at": { "type": "integer", "format": "date-time", "nullable": true, "description": "(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).", "example": 1571672154 }, "last_replied_at": { "type": "integer", "format": "date-time", "nullable": true, "description": "(UNIX timestamp) The time when the contact last messaged in.", "example": 1571672154 }, "last_contacted_at": { "type": "integer", "format": "date-time", "nullable": true, "description": "(UNIX timestamp) The time when the contact was last messaged.", "example": 1571672154 }, "last_email_opened_at": { "type": "integer", "format": "date-time", "nullable": true, "description": "(UNIX timestamp) The time when the contact last opened an email.", "example": 1571672154 }, "last_email_clicked_at": { "type": "integer", "format": "date-time", "nullable": true, "description": "(UNIX timestamp) The time when the contact last clicked a link in an email.", "example": 1571672154 }, "language_override": { "type": "string", "nullable": true, "description": "A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.", "example": "en" }, "browser": { "type": "string", "nullable": true, "description": "The name of the browser which the contact is using.", "example": "Chrome" }, "browser_version": { "type": "string", "nullable": true, "description": "The version of the browser which the contact is using.", "example": "80.0.3987.132" }, "browser_language": { "type": "string", "nullable": true, "description": "The language set by the browser which the contact is using.", "example": "en-US" }, "os": { "type": "string", "nullable": true, "description": "The operating system which the contact is using.", "example": "Mac OS X" }, "android_app_name": { "type": "string", "nullable": true, "description": "The name of the Android app which the contact is using.", "example": "Intercom" }, "android_app_version": { "type": "string", "nullable": true, "description": "The version of the Android app which the contact is using.", "example": "5.0.0" }, "android_device": { "type": "string", "nullable": true, "description": "The Android device which the contact is using.", "example": "Pixel 3" }, "android_os_version": { "type": "string", "nullable": true, "description": "The version of the Android OS which the contact is using.", "example": "10" }, "android_sdk_version": { "type": "string", "nullable": true, "description": "The version of the Android SDK which the contact is using.", "example": "28" }, "android_last_seen_at": { "type": "integer", "nullable": true, "format": "date-time", "description": "(UNIX timestamp) The time when the contact was last seen on an Android device.", "example": 1571672154 }, "ios_app_name": { "type": "string", "nullable": true, "description": "The name of the iOS app which the contact is using.", "example": "Intercom" }, "ios_app_version": { "type": "string", "nullable": true, "description": "The version of the iOS app which the contact is using.", "example": "5.0.0" }, "ios_device": { "type": "string", "nullable": true, "description": "The iOS device which the contact is using.", "example": "iPhone 11" }, "ios_os_version": { "type": "string", "nullable": true, "description": "The version of iOS which the contact is using.", "example": "13.3.1" }, "ios_sdk_version": { "type": "string", "nullable": true, "description": "The version of the iOS SDK which the contact is using.", "example": "13.3.1" }, "ios_last_seen_at": { "type": "integer", "nullable": true, "format": "date-time", "description": "(UNIX timestamp) The last time the contact used the iOS app.", "example": 1571672154 }, "custom_attributes": { "type": "object", "description": "The custom attributes which are set for the contact." }, "avatar": { "type": "object", "nullable": true, "properties": { "type": { "type": "string", "description": "The type of object", "example": "avatar" }, "image_url": { "type": "string", "format": "uri", "nullable": true, "description": "An image URL containing the avatar of a contact.", "example": "https://example.org/128Wash.jpg" } } }, "tags": { "$ref": "#/components/schemas/contact_tags" }, "notes": { "$ref": "#/components/schemas/contact_notes" }, "companies": { "$ref": "#/components/schemas/contact_companies" }, "location": { "$ref": "#/components/schemas/contact_location" }, "social_profiles": { "$ref": "#/components/schemas/contact_social_profiles" } } }, "contact_archived": { "title": "Contact Archived", "type": "object", "description": "archived contact object", "properties": { "type": { "type": "string", "description": "always contact", "enum": [ "contact" ], "example": "contact" }, "id": { "type": "string", "description": "The unique identifier for the contact which is given by Intercom.", "example": "5ba682d23d7cf92bef87bfd4" }, "external_id": { "type": "string", "nullable": true, "description": "The unique identifier for the contact which is provided by the Client.", "example": "f3b87a2e09d514c6c2e79b9a" }, "archived": { "type": "boolean", "description": "Whether the contact is archived or not.", "example": true } } }, "contact_attached_companies": { "title": "Contact Attached Companies", "type": "object", "description": "A list of Company Objects", "properties": { "type": { "type": "string", "description": "The type of object", "enum": [ "list" ], "example": "list" }, "companies": { "type": "array", "description": "An array containing Company Objects", "items": { "$ref": "#/components/schemas/company" } }, "total_count": { "type": "integer", "description": "The total number of companies associated to this contact", "example": 100 }, "pages": { "$ref": "#/components/schemas/pages_link" } } }, "contact_companies": { "title": "Contact companies", "type": "object", "nullable": false, "description": "An object containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more.", "properties": { "data": { "type": "array", "description": "An array of company data objects attached to the contact.", "items": { "$ref": "#/components/schemas/company_data" } }, "url": { "type": "string", "format": "uri", "description": "Url to get more company resources for this contact", "example": "/contacts/5ba682d23d7cf92bef87bfd4/companies" }, "total_count": { "type": "integer", "description": "Int representing the total number of companyies attached to this contact", "example": 100 }, "has_more": { "type": "boolean", "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", "example": true } } }, "company_data": { "title": "Company Data", "type": "object", "description": "An object containing data about the companies that a contact is associated with.", "properties": { "id": { "type": "string", "description": "The unique identifier for the company which is given by Intercom.", "example": "5ba682d23d7cf92bef87bfd4" }, "type": { "type": "string", "description": "The type of the object. Always company.", "enum": [ "company" ], "example": "company" }, "url": { "type": "string", "format": "uri", "description": "The relative URL of the company.", "example": "/companies/5ba682d23d7cf92bef87bfd4" } } }, "contact_deleted": { "title": "Contact Deleted", "type": "object", "description": "deleted contact object", "properties": { "type": { "type": "string", "description": "always contact", "enum": [ "contact" ], "example": "contact" }, "id": { "type": "string", "description": "The unique identifier for the contact which is given by Intercom.", "example": "5ba682d23d7cf92bef87bfd4" }, "external_id": { "type": "string", "nullable": true, "description": "The unique identifier for the contact which is provided by the Client.", "example": "f3b87a2e09d514c6c2e79b9a" }, "deleted": { "type": "boolean", "description": "Whether the contact is deleted or not.", "example": true } } }, "contact_list": { "title": "Contact List", "type": "object", "description": "Contacts are your users in Intercom.", "properties": { "type": { "type": "string", "description": "Always list", "enum": [ "list" ], "example": "list" }, "data": { "type": "array", "description": "The list of contact objects", "items": { "$ref": "#/components/schemas/contact" } }, "total_count": { "type": "integer", "description": "A count of the total number of objects.", "example": 100 }, "pages": { "$ref": "#/components/schemas/cursor_pages" } } }, "contact_location": { "title": "Contact Location", "type": "object", "nullable": false, "description": "An object containing location meta data about a Intercom contact.", "properties": { "type": { "type": "string", "nullable": true, "description": "Always location", "example": "location" }, "country": { "type": "string", "nullable": true, "description": "The country that the contact is located in", "example": "Ireland" }, "region": { "type": "string", "nullable": true, "description": "The overal region that the contact is located in", "example": "Dublin" }, "city": { "type": "string", "nullable": true, "description": "The city that the contact is located in", "example": "Dublin" } } }, "contact_notes": { "title": "Contact notes", "type": "object", "nullable": false, "description": "An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.", "properties": { "data": { "type": "array", "description": "This object represents the notes attached to a contact.", "items": { "$ref": "#/components/schemas/addressable_list" } }, "url": { "type": "string", "format": "uri", "description": "Url to get more company resources for this contact", "example": "/contacts/5ba682d23d7cf92bef87bfd4/notes" }, "total_count": { "type": "integer", "description": "Int representing the total number of companyies attached to this contact", "example": 100 }, "has_more": { "type": "boolean", "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", "example": true } } }, "contact_reference": { "title": "Contact Reference", "type": "object", "description": "reference to contact object", "properties": { "type": { "type": "string", "description": "always contact", "enum": [ "contact" ], "example": "contact" }, "id": { "type": "string", "description": "The unique identifier for the contact which is given by Intercom.", "example": "5ba682d23d7cf92bef87bfd4" }, "external_id": { "type": "string", "nullable": true, "description": "The unique identifier for the contact which is provided by the Client.", "example": "f3b87a2e09d514c6c2e79b9a" } } }, "contact_reply_base_request": { "title": "Contact Reply Base Object", "type": "object", "properties": { "message_type": { "type": "string", "enum": [ "comment" ] }, "type": { "type": "string", "enum": [ "user" ] }, "body": { "type": "string", "description": "The text body of the comment." }, "attachment_urls": { "title": "Attachment URLs", "type": "array", "description": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", "items": { "type": "string", "format": "uri" }, "maxItems": 10 } }, "required": [ "message_type", "type", "body" ] }, "contact_reply_conversation_request": { "title": "Contact Reply", "oneOf": [ { "$ref": "#/components/schemas/contact_reply_intercom_user_id_request" }, { "$ref": "#/components/schemas/contact_reply_email_request" }, { "$ref": "#/components/schemas/contact_reply_user_id_request" } ] }, "contact_reply_email_request": { "title": "Email", "type": "object", "description": "Payload of the request to reply on behalf of a contact using their `email`", "properties": { "email": { "type": "string", "description": "The email you have defined for the user." }, "attachment_files": { "type": "array", "description": "A list of files that will be added as attachments.", "items": { "$ref": "#/components/schemas/conversation_attachment_files" } } }, "allOf": [ { "$ref": "#/components/schemas/contact_reply_base_request" } ], "required": [ "email" ] }, "contact_reply_intercom_user_id_request": { "title": "Intercom User ID", "type": "object", "description": "Payload of the request to reply on behalf of a contact using their `intercom_user_id`", "allOf": [ { "$ref": "#/components/schemas/contact_reply_base_request" } ], "properties": { "intercom_user_id": { "type": "string", "description": "The identifier for the contact as given by Intercom." }, "attachment_files": { "type": "array", "description": "A list of files that will be added as attachments.", "items": { "$ref": "#/components/schemas/conversation_attachment_files" } } }, "required": [ "intercom_user_id" ] }, "contact_reply_ticket_email_request": { "title": "Email", "type": "object", "description": "Payload of the request to reply on behalf of a contact using their `email`", "properties": { "email": { "type": "string", "description": "The email you have defined for the user." } }, "allOf": [ { "$ref": "#/components/schemas/contact_reply_base_request" } ], "required": [ "email" ] }, "contact_reply_ticket_intercom_user_id_request": { "title": "Intercom User ID", "type": "object", "description": "Payload of the request to reply on behalf of a contact using their `intercom_user_id`", "allOf": [ { "$ref": "#/components/schemas/contact_reply_base_request" } ], "properties": { "intercom_user_id": { "type": "string", "description": "The identifier for the contact as given by Intercom." } }, "required": [ "intercom_user_id" ] }, "contact_reply_ticket_user_id_request": { "title": "User ID", "type": "object", "description": "Payload of the request to reply on behalf of a contact using their `user_id`", "allOf": [ { "$ref": "#/components/schemas/contact_reply_base_request" } ], "properties": { "user_id": { "type": "string", "description": "The external_id you have defined for the contact." } }, "required": [ "user_id" ] }, "contact_reply_user_id_request": { "title": "User ID", "type": "object", "description": "Payload of the request to reply on behalf of a contact using their `user_id`", "allOf": [ { "$ref": "#/components/schemas/contact_reply_base_request" } ], "properties": { "user_id": { "type": "string", "description": "The external_id you have defined for the contact." }, "attachment_files": { "type": "array", "description": "A list of files that will be added as attachments. You can include up to 10 files.", "items": { "$ref": "#/components/schemas/conversation_attachment_files" }, "maxItems": 10 } }, "required": [ "user_id" ] }, "contact_segments": { "title": "Segments", "type": "object", "description": "A list of segments objects attached to a specific contact.", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "list" ], "example": "list" }, "data": { "type": "array", "description": "Segment objects associated with the contact.", "items": { "$ref": "#/components/schemas/segment" } } } }, "contact_social_profiles": { "title": "Social Profile", "type": "object", "nullable": false, "description": "An object containing social profiles that a contact has.", "properties": { "data": { "type": "array", "description": "A list of social profiles objects associated with the contact.", "items": { "$ref": "#/components/schemas/social_profile" } } } }, "contact_subscription_types": { "title": "Contact Subscription Types", "type": "object", "nullable": false, "description": "An object containing Subscription Types meta data about the SubscriptionTypes that a contact has.", "properties": { "data": { "type": "array", "description": "This object represents the subscriptions attached to a contact.", "items": { "$ref": "#/components/schemas/addressable_list" } }, "url": { "type": "string", "format": "uri", "description": "Url to get more subscription type resources for this contact", "example": "/contacts/5ba682d23d7cf92bef87bfd4/subscriptions" }, "total_count": { "type": "integer", "description": "Int representing the total number of subscription types attached to this contact", "example": 100 }, "has_more": { "type": "boolean", "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", "example": true } } }, "contact_tags": { "title": "Contact Tags", "type": "object", "nullable": true, "description": "An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.", "properties": { "data": { "type": "array", "description": "This object represents the tags attached to a contact.", "items": { "$ref": "#/components/schemas/addressable_list" } }, "url": { "type": "string", "format": "uri", "description": "url to get more tag resources for this contact", "example": "/contacts/5ba682d23d7cf92bef87bfd4/tags" }, "total_count": { "type": "integer", "description": "Int representing the total number of tags attached to this contact", "example": 100 }, "has_more": { "type": "boolean", "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", "example": true } } }, "contact_unarchived": { "title": "Contact Unarchived", "type": "object", "description": "unarchived contact object", "properties": { "type": { "type": "string", "description": "always contact", "enum": [ "contact" ], "example": "contact" }, "id": { "type": "string", "description": "The unique identifier for the contact which is given by Intercom.", "example": "5ba682d23d7cf92bef87bfd4" }, "external_id": { "type": "string", "nullable": true, "description": "The unique identifier for the contact which is provided by the Client.", "example": "f3b87a2e09d514c6c2e79b9a" }, "archived": { "type": "boolean", "description": "Whether the contact is archived or not.", "example": false } } }, "conversation_list_item": { "title": "Conversation List Item", "type": "object", "x-tags": [ "Conversations" ], "description": "The data returned about your conversations when you list or search them.", "properties": { "type": { "type": "string", "description": "Always conversation.", "example": "conversation" }, "id": { "type": "string", "description": "The id representing the conversation.", "example": "1295" }, "title": { "type": "string", "nullable": true, "description": "The title given to the conversation.", "example": "Conversation Title" }, "created_at": { "type": "integer", "format": "date-time", "description": "The time the conversation was created.", "example": 1663597223 }, "updated_at": { "type": "integer", "format": "date-time", "description": "The last time the conversation was updated.", "example": 1663597260 }, "waiting_since": { "type": "integer", "format": "date-time", "nullable": true, "description": "The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.", "example": 1663597260 }, "snoozed_until": { "type": "integer", "format": "date-time", "nullable": true, "description": "If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.", "example": 1663597260 }, "open": { "type": "boolean", "description": "Indicates whether a conversation is open (true) or closed (false).", "example": true }, "state": { "type": "string", "enum": [ "open", "closed", "snoozed" ], "description": "Can be set to \"open\", \"closed\" or \"snoozed\".", "example": "open" }, "read": { "type": "boolean", "description": "Indicates whether a conversation has been read.", "example": true }, "priority": { "type": "string", "enum": [ "priority", "not_priority" ], "description": "If marked as priority, it will return priority or else not_priority.", "example": "priority" }, "admin_assignee_id": { "type": "integer", "nullable": true, "description": "The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.", "example": 0 }, "team_assignee_id": { "type": "integer", "nullable": true, "description": "The id of the team assigned to the conversation. If it's not assigned to a team it will return null.", "example": 5017691 }, "tags": { "$ref": "#/components/schemas/tags" }, "conversation_rating": { "$ref": "#/components/schemas/conversation_rating" }, "source": { "$ref": "#/components/schemas/conversation_source" }, "contacts": { "$ref": "#/components/schemas/conversation_contacts" }, "teammates": { "$ref": "#/components/schemas/conversation_teammates" }, "first_contact_reply": { "$ref": "#/components/schemas/conversation_first_contact_reply" }, "sla_applied": { "$ref": "#/components/schemas/sla_applied" }, "statistics": { "$ref": "#/components/schemas/conversation_statistics" } } }, "conversation": { "title": "Conversation", "type": "object", "x-tags": [ "Conversations" ], "description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", "properties": { "type": { "type": "string", "description": "Always conversation.", "example": "conversation" }, "id": { "type": "string", "description": "The id representing the conversation.", "example": "1295" }, "title": { "type": "string", "nullable": true, "description": "The title given to the conversation.", "example": "Conversation Title" }, "created_at": { "type": "integer", "format": "date-time", "description": "The time the conversation was created.", "example": 1663597223 }, "updated_at": { "type": "integer", "format": "date-time", "description": "The last time the conversation was updated.", "example": 1663597260 }, "waiting_since": { "type": "integer", "format": "date-time", "nullable": true, "description": "The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.", "example": 1663597260 }, "snoozed_until": { "type": "integer", "format": "date-time", "nullable": true, "description": "If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.", "example": 1663597260 }, "open": { "type": "boolean", "description": "Indicates whether a conversation is open (true) or closed (false).", "example": true }, "state": { "type": "string", "enum": [ "open", "closed", "snoozed" ], "description": "Can be set to \"open\", \"closed\" or \"snoozed\".", "example": "open" }, "read": { "type": "boolean", "description": "Indicates whether a conversation has been read.", "example": true }, "priority": { "type": "string", "enum": [ "priority", "not_priority" ], "description": "If marked as priority, it will return priority or else not_priority.", "example": "priority" }, "admin_assignee_id": { "type": "integer", "nullable": true, "description": "The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.", "example": 0 }, "team_assignee_id": { "type": "integer", "nullable": true, "description": "The id of the team assigned to the conversation. If it's not assigned to a team it will return null.", "example": 5017691 }, "tags": { "$ref": "#/components/schemas/tags" }, "conversation_rating": { "$ref": "#/components/schemas/conversation_rating" }, "source": { "$ref": "#/components/schemas/conversation_source" }, "contacts": { "$ref": "#/components/schemas/conversation_contacts" }, "teammates": { "$ref": "#/components/schemas/conversation_teammates" }, "first_contact_reply": { "$ref": "#/components/schemas/conversation_first_contact_reply" }, "sla_applied": { "$ref": "#/components/schemas/sla_applied" }, "statistics": { "$ref": "#/components/schemas/conversation_statistics" }, "conversation_parts": { "$ref": "#/components/schemas/conversation_parts" } } }, "conversation_attachment_files": { "title": "Conversation attachment files", "type": "object", "description": "Properties of the attachment files in a conversation part", "properties": { "content_type": { "type": "string", "description": "The content type of the file", "example": "application/json" }, "data": { "type": "string", "description": "The base64 encoded file data.", "example": "ewogICJ0ZXN0IjogMQp9" }, "name": { "type": "string", "description": "The name of the file.", "example": "test.json" } } }, "conversation_contacts": { "title": "Contacts", "type": "object", "description": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", "properties": { "type": { "type": "string", "description": "", "enum": [ "contact.list" ], "example": "contact.list" }, "contacts": { "type": "array", "description": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", "items": { "$ref": "#/components/schemas/contact_reference" } } } }, "conversation_first_contact_reply": { "title": "First contact reply", "type": "object", "nullable": true, "description": "An object containing information on the first users message. For a contact initiated message this will represent the users original message.", "properties": { "created_at": { "type": "integer", "format": "date-time", "description": "", "example": 1663597223 }, "type": { "type": "string", "description": "", "example": "conversation" }, "url": { "type": "string", "nullable": true, "description": "", "example": "https://developers.intercom.com/" } } }, "conversation_list": { "title": "Conversation List", "type": "object", "description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", "properties": { "type": { "type": "string", "description": "Always conversation.list", "enum": [ "conversation.list" ], "example": "conversation.list" }, "conversations": { "type": "array", "description": "The list of conversation objects", "items": { "$ref": "#/components/schemas/conversation_list_item" } }, "total_count": { "type": "integer", "description": "A count of the total number of objects.", "example": 12345 }, "pages": { "$ref": "#/components/schemas/cursor_pages" } } }, "conversation_part": { "title": "Conversation Part", "type": "object", "description": "A Conversation Part represents a message in the conversation.", "properties": { "type": { "type": "string", "description": "Always conversation_part", "example": "conversation_part" }, "id": { "type": "string", "description": "The id representing the conversation part.", "example": "3" }, "part_type": { "type": "string", "description": "The type of conversation part.", "example": "comment" }, "body": { "type": "string", "nullable": true, "description": "The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.", "example": "Okay!
" }, "created_at": { "type": "integer", "format": "date-time", "description": "The time the conversation part was created.", "example": 1663597223 }, "updated_at": { "type": "integer", "format": "date-time", "description": "The last time the conversation part was updated.", "example": 1663597260 }, "notified_at": { "type": "integer", "format": "date-time", "description": "The time the user was notified with the conversation part.", "example": 1663597260 }, "assigned_to": { "$ref": "#/components/schemas/reference", "nullable": true, "description": "The id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.)" }, "author": { "$ref": "#/components/schemas/conversation_part_author" }, "attachments": { "title": "Conversation part attachments", "type": "array", "description": "A list of attachments for the part.", "items": { "$ref": "#/components/schemas/part_attachment" } }, "external_id": { "type": "string", "nullable": true, "description": "The external id of the conversation part", "example": "abcd1234" }, "redacted": { "type": "boolean", "description": "Whether or not the conversation part has been redacted.", "example": false } } }, "conversation_part_author": { "title": "Conversation part author", "type": "object", "description": "The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.", "properties": { "type": { "type": "string", "description": "The type of the author", "example": "admin" }, "id": { "type": "string", "description": "The id of the author", "example": "274" }, "name": { "type": "string", "nullable": true, "description": "The name of the author", "example": "Operator" }, "email": { "type": "string", "format": "email", "description": "The email of the author", "example": "operator+abcd1234@intercom.io" } } }, "conversation_parts": { "title": "Conversation Parts", "type": "object", "description": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", "properties": { "type": { "type": "string", "description": "", "enum": [ "conversation_part.list" ], "example": "conversation_part.list" }, "conversation_parts": { "title": "Conversation Parts", "type": "array", "description": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", "items": { "$ref": "#/components/schemas/conversation_part" } }, "total_count": { "type": "integer", "description": "", "example": 2 } } }, "conversation_rating": { "title": "Conversation Rating", "type": "object", "nullable": true, "description": "The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.", "properties": { "rating": { "type": "integer", "description": "The rating, between 1 and 5, for the conversation.", "example": 5 }, "remark": { "type": "string", "description": "An optional field to add a remark to correspond to the number rating", "example": "" }, "created_at": { "type": "integer", "format": "date-time", "description": "The time the rating was requested in the conversation being rated.", "example": 1671028894 }, "contact": { "$ref": "#/components/schemas/contact_reference" }, "teammate": { "$ref": "#/components/schemas/reference" } } }, "conversation_source": { "title": "Conversation source", "type": "object", "description": "The type of the conversation part that started this conversation. Can be Contact, Admin, Campaign, Automated or Operator initiated.", "properties": { "type": { "type": "string", "description": "This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp.", "example": "conversation", "enum": [ "conversation", "email", "facebook", "instagram", "phone_call", "phone_switch", "push", "sms", "twitter", "whatsapp" ] }, "id": { "type": "string", "description": "The id representing the message.", "example": "3" }, "delivered_as": { "type": "string", "description": "The conversation's initiation type. Possible values are customer_initiated, campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), automated (Series and other outbounds with dynamic audience message) and admin_initiated (fixed audience message, ticket initiated by an admin, group email).", "example": "operator_initiated" }, "subject": { "type": "string", "description": "Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured.", "example": "" }, "body": { "type": "string", "description": "The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.", "example": "Hey there!
" }, "author": { "$ref": "#/components/schemas/conversation_part_author" }, "attachments": { "type": "array", "description": "A list of attachments for the part.", "items": { "$ref": "#/components/schemas/part_attachment" } }, "url": { "type": "string", "nullable": true, "description": "The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank.", "example": null }, "redacted": { "type": "boolean", "description": "Whether or not the source message has been redacted. Only applicable for contact initiated messages.", "example": false } } }, "conversation_statistics": { "title": "Conversation statistics", "type": "object", "nullable": true, "description": "A Statistics object containing all information required for reporting, with timestamps and calculated metrics.", "properties": { "type": { "type": "string", "description": "", "example": "conversation_statistics" }, "time_to_assignment": { "type": "integer", "description": "Duration until last assignment before first admin reply. In seconds.", "example": 2310 }, "time_to_admin_reply": { "type": "integer", "description": "Duration until first admin reply. Subtracts out of business hours. In seconds.", "example": 2310 }, "time_to_first_close": { "type": "integer", "description": "Duration until conversation was closed first time. Subtracts out of business hours. In seconds.", "example": 2310 }, "time_to_last_close": { "type": "integer", "description": "Duration until conversation was closed last time. Subtracts out of business hours. In seconds.", "example": 2310 }, "median_time_to_reply": { "type": "integer", "description": "Median based on all admin replies after a contact reply. Subtracts out of business hours. In seconds.", "example": 2310 }, "first_contact_reply_at": { "type": "integer", "format": "date-time", "description": "Time of first text conversation part from a contact.", "example": 1663597233 }, "first_assignment_at": { "type": "integer", "format": "date-time", "description": "Time of first assignment after first_contact_reply_at.", "example": 1663597233 }, "first_admin_reply_at": { "type": "integer", "format": "date-time", "description": "Time of first admin reply after first_contact_reply_at.", "example": 1663597233 }, "first_close_at": { "type": "integer", "format": "date-time", "description": "Time of first close after first_contact_reply_at.", "example": 1663597233 }, "last_assignment_at": { "type": "integer", "format": "date-time", "description": "Time of last assignment after first_contact_reply_at.", "example": 1663597233 }, "last_assignment_admin_reply_at": { "type": "integer", "format": "date-time", "description": "Time of first admin reply since most recent assignment.", "example": 1663597233 }, "last_contact_reply_at": { "type": "integer", "format": "date-time", "description": "Time of the last conversation part from a contact.", "example": 1663597233 }, "last_admin_reply_at": { "type": "integer", "format": "date-time", "description": "Time of the last conversation part from an admin.", "example": 1663597233 }, "last_close_at": { "type": "integer", "format": "date-time", "description": "Time of the last conversation close.", "example": 1663597233 }, "last_closed_by_id": { "type": "string", "description": "The last admin who closed the conversation. Returns a reference to an Admin object.", "example": "c3po" }, "count_reopens": { "type": "integer", "description": "Number of reopens after first_contact_reply_at.", "example": 1 }, "count_assignments": { "type": "integer", "description": "Number of assignments after first_contact_reply_at.", "example": 1 }, "count_conversation_parts": { "type": "integer", "description": "Total number of conversation parts.", "example": 1 } } }, "conversation_teammates": { "title": "Conversation teammates", "type": "object", "nullable": true, "description": "The list of teammates who participated in the conversation (wrote at least one conversation part).", "properties": { "type": { "type": "string", "description": "The type of the object - `admin.list`.", "example": "admin.list" }, "teammates": { "type": "array", "description": "The list of teammates who participated in the conversation (wrote at least one conversation part).", "items": { "$ref": "#/components/schemas/reference" } } } }, "convert_visitor_request": { "description": "You can merge a Visitor to a Contact of role type lead or user.", "type": "object", "title": "Convert Visitor Request Payload", "properties": { "type": { "type": "string", "description": "Represents the role of the Contact model. Accepts `lead` or `user`.", "example": "user" }, "user": { "type": "object", "description": "The unique identifiers retained after converting or merging.", "properties": { "id": { "type": "string", "description": "The unique identifier for the contact which is given by Intercom.", "example": "8a88a590-e1c3-41e2-a502-e0649dbf721c" }, "user_id": { "type": "string", "description": "A unique identifier for the contact which is given to Intercom, which will be represented as external_id.", "example": "8a88a590-e1c3-41e2-a502-e0649dbf721c" }, "email": { "type": "string", "description": "The contact's email, retained by default if one is present.", "example": "joe@example.com" } }, "anyOf": [ { "required": [ "id" ] }, { "required": [ "user_id" ] } ] }, "visitor": { "type": "object", "description": "The unique identifiers to convert a single Visitor.", "properties": { "id": { "type": "string", "description": "The unique identifier for the contact which is given by Intercom.", "example": "8a88a590-e1c3-41e2-a502-e0649dbf721c" }, "user_id": { "type": "string", "description": "A unique identifier for the contact which is given to Intercom.", "example": "8a88a590-e1c3-41e2-a502-e0649dbf721c" }, "email": { "type": "string", "description": "The visitor's email.", "example": "joe@example.com" } }, "anyOf": [ { "required": [ "id" ] }, { "required": [ "user_id" ] }, { "required": [ "email" ] } ] } }, "required": [ "type", "user", "visitor" ] }, "create_article_request": { "description": "You can create an Article", "type": "object", "title": "Create Article Request Payload", "nullable": true, "properties": { "title": { "type": "string", "description": "The title of the article.For multilingual articles, this will be the title of the default language's content.", "example": "Thanks for everything" }, "description": { "type": "string", "description": "The description of the article. For multilingual articles, this will be the description of the default language's content.", "example": "Description of the Article" }, "body": { "type": "string", "description": "The content of the article. For multilingual articles, this will be the body of the default language's content.", "example": "This is the body in html
" }, "author_id": { "type": "integer", "description": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", "example": 1295 }, "state": { "type": "string", "description": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.", "enum": [ "published", "draft" ], "example": "draft" }, "parent_id": { "type": "integer", "description": "The id of the article's parent collection or section. An article without this field stands alone.", "example": 18 }, "parent_type": { "type": "string", "description": "The type of parent, which can either be a `collection` or `section`.", "example": "collection" }, "translated_content": { "$ref": "#/components/schemas/article_translated_content" } }, "required": [ "title", "author_id" ] }, "create_collection_request": { "description": "You can create a collection", "type": "object", "title": "Create Collection Request Payload", "properties": { "name": { "type": "string", "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content.", "example": "collection 51" }, "description": { "type": "string", "description": "The description of the collection. For multilingual collections, this will be the description of the default language's content.", "example": "English description" }, "translated_content": { "nullable": true, "$ref": "#/components/schemas/group_translated_content" }, "help_center_id": { "type": "integer", "nullable": true, "description": "The id of the help center where the collection will be created. If `null` then it will be created in the default help center.", "example": "123" } }, "required": [ "name" ] }, "create_contact_request": { "description": "Payload to create a contact", "type": "object", "title": "Create Contact Request Payload", "properties": { "role": { "type": "string", "description": "The role of the contact.", "example": "user" }, "external_id": { "type": "string", "description": "A unique identifier for the contact which is given to Intercom", "example": "625e90fc55ab113b6d92175f" }, "email": { "type": "string", "description": "The contacts email", "example": "jdoe@example.com" }, "phone": { "type": "string", "nullable": true, "description": "The contacts phone", "example": "+353871234567" }, "name": { "type": "string", "nullable": true, "description": "The contacts name", "example": "John Doe" }, "avatar": { "type": "string", "nullable": true, "description": "An image URL containing the avatar of a contact", "example": "https://www.example.com/avatar_image.jpg" }, "signed_up_at": { "type": "integer", "format": "date-time", "nullable": true, "description": "The time specified for when a contact signed up", "example": 1571672154 }, "last_seen_at": { "type": "integer", "format": "date-time", "nullable": true, "description": "The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)", "example": 1571672154 }, "owner_id": { "type": "integer", "nullable": true, "description": "The id of an admin that has been assigned account ownership of the contact", "example": 123 }, "unsubscribed_from_emails": { "type": "boolean", "nullable": true, "description": "Whether the contact is unsubscribed from emails", "example": true }, "custom_attributes": { "type": "object", "nullable": true, "description": "The custom attributes which are set for the contact", "example": { "paid_subscriber": true, "monthly_spend": 155.5, "team_mates": 1 } } }, "anyOf": [ { "required": [ "email" ], "title": "Create contact with email" }, { "required": [ "external_id" ], "title": "Create contact with external_id" }, { "required": [ "role" ], "title": "Create contact with role" } ] }, "create_conversation_request": { "description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", "type": "object", "title": "Create Conversation Request Payload", "properties": { "from": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lead", "user", "contact" ], "description": "The role associated to the contact - user or lead.", "example": "user" }, "id": { "type": "string", "description": "The identifier for the contact which is given by Intercom.", "format": "uuid", "minLength": 24, "maxLength": 24, "example": "536e564f316c83104c000020" } }, "required": [ "type", "id" ] }, "body": { "type": "string", "description": "The content of the message. HTML is not supported.", "example": "Hello" }, "subject": { "type": "string", "description": "The title of the email. Only applicable if the message type is email.", "example": "Thanks for everything" }, "attachment_urls": { "type": "array", "description": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", "items": { "type": "string", "format": "uri" }, "maxItems": 10 }, "message_type": { "type": "string", "description": "The kind of message being created. Values: `inapp` (in-app messaging), `email`, `sms`, `whatsapp`, or `facebook`.", "enum": [ "inapp", "email", "sms", "whatsapp", "facebook" ], "example": "inapp" } }, "required": [ "from", "body" ] }, "create_data_attribute_request": { "description": "", "type": "object", "title": "Create Data Attribute Request", "properties": { "name": { "type": "string", "description": "The name of the data attribute.", "example": "My Data Attribute" }, "model": { "type": "string", "description": "The model that the data attribute belongs to.", "enum": [ "contact", "company" ], "example": "contact" }, "description": { "type": "string", "description": "The readable description you see in the UI for the attribute.", "example": "My Data Attribute Description" }, "messenger_writable": { "type": "boolean", "description": "Can this attribute be updated by the Messenger", "example": false } }, "required": [ "name", "model", "data_type" ], "oneOf": [ { "properties": { "data_type": { "enum": [ "options" ] }, "options": { "type": "array", "description": "Array of objects representing the options of the list, with `value` as the key and the option as the value. At least two options are required.", "items": { "type": "object", "properties": { "value": { "type": "string" } } }, "example": [ { "value": "1-10" }, { "value": "11-50" } ] } }, "required": [ "options" ], "title": "list attribute" }, { "properties": { "data_type": { "enum": [ "string", "integer", "float", "boolean", "datetime", "date" ] } }, "title": "other type" } ] }, "create_data_event_request": { "description": "", "type": "object", "title": "Create Data Event Request", "properties": { "event_name": { "type": "string", "description": "The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", "example": "invited-friend" }, "created_at": { "type": "integer", "format": "date-time", "description": "The time the event occurred as a UTC Unix timestamp", "example": 1671028894 }, "user_id": { "type": "string", "description": "Your identifier for the user.", "example": "314159" }, "id": { "type": "string", "description": "The unique identifier for the contact (lead or user) which is given by Intercom.", "example": "8a88a590-e1c3-41e2-a502-e0649dbf721c" }, "email": { "type": "string", "description": "An email address for your user. An email should only be used where your application uses email to uniquely identify users.", "example": "frodo.baggins@example.com" }, "metadata": { "type": "object", "description": "Optional metadata about the event.", "additionalProperties": { "type": "string" }, "example": { "invite_code": "ADDAFRIEND" } } }, "anyOf": [ { "title": "id required", "required": [ "event_name", "created_at", "id" ] }, { "title": "user_id required", "required": [ "event_name", "created_at", "user_id" ] }, { "title": "email required", "required": [ "event_name", "created_at", "email" ] } ] }, "create_data_event_summaries_request": { "description": "You can send a list of event summaries for a user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense \"verb-noun\" combination, to improve readability, for example `updated-plan`.", "type": "object", "title": "Create Data Event Summaries Request", "properties": { "user_id": { "type": "string", "description": "Your identifier for the user.", "example": "314159" }, "event_summaries": { "type": "object", "description": "A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", "properties": { "event_name": { "type": "string", "description": "The name of the event that occurred. A good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", "example": "invited-friend" }, "count": { "type": "integer", "description": "The number of times the event occurred.", "example": 1 }, "first": { "type": "integer", "format": "date-time", "description": "The first time the event was sent", "example": 1671028894 }, "last": { "type": "integer", "format": "date-time", "description": "The last time the event was sent", "example": 1671028894 } } } } }, "create_data_exports_request": { "description": "Request for creating a data export", "type": "object", "title": "Create Data Export Request", "properties": { "created_at_after": { "type": "integer", "description": "The start date that you request data for. It must be formatted as a unix timestamp.", "example": 1527811200 }, "created_at_before": { "type": "integer", "description": "The end date that you request data for. It must be formatted as a unix timestamp.", "example": 1527811200 } }, "required": [ "created_at_after", "created_at_before" ] }, "create_message_request": { "description": "You can create a message", "type": "object", "title": "Create Message Request Payload", "nullable": true, "properties": { "message_type": { "type": "string", "description": "The kind of message being created. Values: `in_app` or `email`.", "enum": [ "in_app", "email" ], "example": "in_app" }, "subject": { "type": "string", "description": "The title of the email.", "example": "Thanks for everything" }, "body": { "type": "string", "description": "The content of the message. HTML and plaintext are supported.", "example": "Hello there" }, "template": { "type": "string", "description": "The style of the outgoing message. Possible values `plain` or `personal`.", "example": "plain" }, "from": { "type": "object", "description": "The sender of the message. If not provided, the default sender will be used.", "properties": { "type": { "type": "string", "description": "Always `admin`.", "enum": [ "admin" ], "example": "admin" }, "id": { "type": "integer", "description": "The identifier for the admin which is given by Intercom.", "example": 394051 } }, "required": [ "type", "id" ] }, "to": { "type": "object", "description": "The sender of the message. If not provided, the default sender will be used.", "properties": { "type": { "type": "string", "description": "The role associated to the contact - `user` or `lead`.", "enum": [ "user", "lead" ], "example": "user" }, "id": { "type": "string", "description": "The identifier for the contact which is given by Intercom.", "example": "536e564f316c83104c000020" } }, "required": [ "type", "id" ] }, "create_conversation_without_contact_reply": { "type": "boolean", "description": "Whether a conversation should be opened in the inbox for the message without the contact replying. Defaults to false if not provided.", "default": false, "example": true } }, "anyOf": [ { "title": "message_type: `email`.", "required": [ "message_type", "subject", "body", "template", "from", "to" ] }, { "title": "message_type: `inapp`.", "required": [ "message_type", "body", "from", "to" ] } ] }, "create_or_update_company_request": { "type": "object", "title": "Create Or Update Company Request Payload", "description": "You can create or update a Company", "nullable": true, "properties": { "name": { "type": "string", "description": "The name of the Company", "example": "Intercom" }, "company_id": { "type": "string", "description": "The company id you have defined for the company. Can't be updated", "example": "625e90fc55ab113b6d92175f" }, "plan": { "type": "string", "description": "The name of the plan you have associated with the company.", "example": "Enterprise" }, "size": { "type": "integer", "description": "The number of employees in this company.", "example": "100" }, "website": { "type": "string", "description": "The URL for this company's website. Please note that the value specified here is not validated. Accepts any string.", "example": "https://www.example.com" }, "industry": { "type": "string", "description": "The industry that this company operates in.", "example": "Technology" }, "custom_attributes": { "type": "object", "description": "A hash of key/value pairs containing any other data about the company you want Intercom to store.", "additionalProperties": { "type": "string" }, "example": { "paid_subscriber": true, "monthly_spend": 155.5, "team_mates": 9 } }, "remote_created_at": { "type": "integer", "description": "The time the company was created by you.", "example": 1394531169 }, "monthly_spend": { "type": "integer", "description": "How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647..", "example": 1000 } } }, "create_or_update_tag_request": { "description": "You can create or update an existing tag.", "type": "object", "title": "Create or Update Tag Request Payload", "properties": { "name": { "type": "string", "description": "The name of the tag, which will be created if not found, or the new name for the tag if this is an update request. Names are case insensitive.", "example": "Independent" }, "id": { "type": "string", "description": "The id of tag to updates.", "example": "656452352" } }, "required": [ "name" ] }, "create_phone_switch_request": { "description": "You can create an phone switch", "type": "object", "title": "Create Phone Switch Request Payload", "nullable": true, "properties": { "phone": { "type": "string", "description": "Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger.", "example": "+1 1234567890" }, "custom_attributes": { "$ref": "#/components/schemas/custom_attributes" } }, "required": [ "phone" ] }, "create_section_request": { "description": "You can create a Section", "type": "object", "title": "Create Section Request Payload", "properties": { "name": { "type": "string", "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content.", "example": "Section 51" }, "parent_id": { "type": "integer", "description": "The id for the collection this section will be within.", "example": 18 }, "translated_content": { "nullable": true, "$ref": "#/components/schemas/group_translated_content" } }, "required": [ "name", "parent_id" ] }, "cursor_pages": { "title": "Cursor based pages", "type": "object", "description": "Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data.\nA \"cursor\" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or \"pages\" as needed.\n", "nullable": true, "properties": { "type": { "type": "string", "description": "the type of object `pages`.", "example": "pages", "enum": [ "pages" ] }, "page": { "type": "integer", "description": "The current page", "example": 1 }, "next": { "$ref": "#/components/schemas/starting_after_paging" }, "per_page": { "type": "integer", "description": "Number of results per page", "example": 2 }, "total_pages": { "type": "integer", "description": "Total number of pages", "example": 13 } } }, "custom_attributes": { "title": "Custom Attributes", "type": "object", "description": "An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models.", "additionalProperties": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/custom_object_instance" } ] } }, "custom_object_instance": { "title": "Custom Object Instance", "type": "object", "x-tags": [ "Custom Object Instances" ], "nullable": true, "description": "A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.", "properties": { "id": { "type": "string", "description": "The Intercom defined id representing the custom object instance.", "example": "5a7a19e9f59ae20001d1c1e6" }, "external_id": { "type": "string", "description": "The id you have defined for the custom object instance.", "example": "0001d1c1e65a7a19e9f59ae2" }, "type": { "type": "string", "description": "The identifier of the custom object type that defines the structure of the custom object instance.", "example": "Order" }, "custom_attributes": { "type": "object", "description": "The custom attributes you have set on the custom object instance.", "additionalProperties": { "type": "string" } } } }, "customer_request": { "type": "object", "nullable": true, "oneOf": [ { "title": "Intercom User ID", "properties": { "intercom_user_id": { "type": "string", "description": "The identifier for the contact as given by Intercom.", "example": "6329bd9ffe4e2e91dac76188" } }, "required": [ "intercom_user_id" ] }, { "title": "User ID", "properties": { "user_id": { "type": "string", "description": "The external_id you have defined for the contact who is being added as a participant.", "example": "2e91dac761886329bd9ffe4e" } }, "required": [ "user_id" ] }, { "title": "Email", "properties": { "email": { "type": "string", "description": "The email you have defined for the contact who is being added as a participant.", "example": "sam.sung@example.com" } }, "required": [ "email" ] } ] }, "data_attribute": { "title": "Data Attribute", "type": "object", "x-tags": [ "Data Attributes" ], "description": "Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes.", "properties": { "type": { "type": "string", "description": "Value is `data_attribute`.", "enum": [ "data_attribute" ], "example": "data_attribute" }, "id": { "type": "integer", "description": "The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.", "example": 12878 }, "model": { "type": "string", "description": "Value is `contact` for user/lead attributes and `company` for company attributes.", "enum": [ "contact", "company" ], "example": "contact" }, "name": { "type": "string", "description": "Name of the attribute.", "example": "paid_subscriber" }, "full_name": { "type": "string", "description": "Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on `.` to access nested user object values.", "example": "custom_attributes.paid_subscriber" }, "label": { "type": "string", "description": "Readable name of the attribute (i.e. name you see in the UI)", "example": "Paid Subscriber" }, "description": { "type": "string", "description": "Readable description of the attribute.", "example": "Whether the user is a paid subscriber." }, "data_type": { "type": "string", "description": "The data type of the attribute.", "enum": [ "string", "integer", "float", "boolean", "date" ], "example": "boolean" }, "options": { "type": "array", "description": "List of predefined options for attribute value.", "items": { "type": "string" }, "example": [ "true", "false" ] }, "api_writable": { "type": "boolean", "description": "Can this attribute be updated through API", "example": true }, "messenger_writable": { "type": "boolean", "description": "Can this attribute be updated by the Messenger", "example": false }, "ui_writable": { "type": "boolean", "description": "Can this attribute be updated in the UI", "example": true }, "custom": { "type": "boolean", "description": "Set to true if this is a CDA", "example": true }, "archived": { "type": "boolean", "description": "Is this attribute archived. (Only applicable to CDAs)", "example": false }, "created_at": { "type": "integer", "format": "date-time", "description": "The time the attribute was created as a UTC Unix timestamp", "example": 1671028894 }, "updated_at": { "type": "integer", "format": "date-time", "description": "The time the attribute was last updated as a UTC Unix timestamp", "example": 1671028894 }, "admin_id": { "type": "string", "description": "Teammate who created the attribute. Only applicable to CDAs", "example": "5712945" } } }, "data_attribute_list": { "title": "Data Attribute List", "type": "object", "description": "A list of all data attributes belonging to a workspace for contacts, companies or conversations.", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "list" ], "example": "list" }, "data": { "type": "array", "description": "A list of data attributes", "items": { "$ref": "#/components/schemas/data_attribute" } } } }, "data_event": { "title": "Data Event", "type": "object", "x-tags": [ "Data Events" ], "description": "Data events are used to notify Intercom of changes to your data.", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "event" ], "example": "event" }, "event_name": { "type": "string", "description": "The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", "example": "invited-friend" }, "created_at": { "type": "integer", "format": "date-time", "description": "The time the event occurred as a UTC Unix timestamp", "example": 1671028894 }, "user_id": { "type": "string", "description": "Your identifier for the user.", "example": "314159" }, "id": { "type": "string", "description": "Your identifier for a lead or a user.", "example": "8a88a590-e1c3-41e2-a502-e0649dbf721c" }, "intercom_user_id": { "type": "string", "description": "The Intercom identifier for the user.", "example": "63a0979a5eeebeaf28dd56ba" }, "email": { "type": "string", "description": "An email address for your user. An email should only be used where your application uses email to uniquely identify users.", "example": "frodo.baggins@example.com" }, "metadata": { "type": "object", "description": "Optional metadata about the event.", "additionalProperties": { "type": "string" }, "example": { "invite_code": "ADDAFRIEND" } } }, "required": [ "event_name", "created_at" ] }, "data_event_list": { "title": "Data Event List", "type": "object", "description": "This will return a list of data events for the App.", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "event.list" ], "example": "event.list" }, "events": { "type": "array", "description": "A list of data events", "items": { "$ref": "#/components/schemas/data_event" } }, "pages": { "type": "object", "description": "Pagination", "properties": { "next": { "type": "string", "example": "https://api.intercom.io/events?per_page=2&before=1389913941064&intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user\"" }, "since": { "type": "string", "example": "https://api.intercom.io/events?intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user&since=1389913941065" } } } } }, "data_event_summary": { "title": "Data Event Summary", "type": "object", "description": "This will return a summary of data events for the App.", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "event.summary" ], "example": "event.summary" }, "email": { "type": "string", "description": "The email address of the user", "example": "Sam.Sung@example.com" }, "intercom_user_id": { "type": "string", "description": "The Intercom user ID of the user", "example": "63a0979a5eeebeaf28dd56ba" }, "user_id": { "type": "string", "description": "The user ID of the user", "example": "62b997f288e14803c5006932" }, "events": { "type": "array", "description": "A summary of data events", "items": { "$ref": "#/components/schemas/data_event_summary_item" } } } }, "data_event_summary_item": { "title": "Data Event Summary Item", "type": "object", "description": "This will return a summary of a data event for the App.", "nullable": true, "properties": { "name": { "type": "string", "description": "The name of the event", "example": "placed-order" }, "first": { "type": "string", "description": "The first time the event was sent", "example": "2014-01-16T23:12:21.000+00:00" }, "last": { "type": "string", "description": "The last time the event was sent", "example": "2014-01-16T23:12:21.000+00:00 " }, "count": { "type": "integer", "description": "The number of times the event was sent", "example": 1 }, "description": { "type": "string", "description": "The description of the event", "example": "A user placed an order" } } }, "data_export": { "title": "Data Export", "type": "object", "x-tags": [ "Data Export" ], "description": "The data export API is used to export message delivery and engagement statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more) sent in a given timeframe. The exported data includes who received each message, when they received it, and how they engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces).", "properties": { "job_identfier": { "type": "string", "description": "The identifier for your job.", "example": "orzzsbd7hk67xyu" }, "status": { "type": "string", "enum": [ "pending", "in_progress", "failed", "completed", "no_data", "canceled" ], "description": "The current state of your job.", "example": "pending" }, "download_expires_at": { "type": "string", "description": "The time after which you will not be able to access the data.", "example": "1674917488" }, "download_url": { "type": "string", "description": "The location where you can download your data.", "example": "https://api.intercom.test/download/messages/data/example" } } }, "data_export_csv": { "title": "Data Export CSV", "type": "object", "description": "A CSV output file", "properties": { "user_id": { "type": "string", "description": "The user_id of the user who was sent the message." }, "user_external_id": { "type": "string", "description": "The external_user_id of the user who was sent the message" }, "company_id": { "type": "string", "description": "The company ID of the user in relation to the message that was sent. Will return -1 if no company is present." }, "email": { "type": "string", "description": "The users email who was sent the message." }, "name": { "type": "string", "description": "The full name of the user receiving the message" }, "ruleset_id": { "type": "string", "description": "The id of the message." }, "content_id": { "type": "string", "description": "The specific content that was received. In an A/B test each version has its own Content ID." }, "content_type": { "type": "string", "description": "Email, Chat, Post etc." }, "content_title": { "type": "string", "description": "The title of the content you see in your Intercom workspace." }, "ruleset_version_id": { "type": "string", "description": "As you edit content we record new versions. This ID can help you determine which version of a piece of content that was received." }, "receipt_id": { "type": "string", "description": "ID for this receipt. Will be included with any related stats in other files to identify this specific delivery of a message." }, "received_at": { "type": "integer", "description": "Timestamp for when the receipt was recorded." }, "series_id": { "type": "string", "description": "The id of the series that this content is part of. Will return -1 if not part of a series." }, "series_title": { "type": "string", "description": "The title of the series that this content is part of." }, "node_id": { "type": "string", "description": "The id of the series node that this ruleset is associated with. Each block in a series has a corresponding node_id." }, "first_reply": { "type": "integer", "description": "The first time a user replied to this message if the content was able to receive replies." }, "first_completion": { "type": "integer", "description": "The first time a user completed this message if the content was able to be completed e.g. Tours, Surveys." }, "first_series_completion": { "type": "integer", "description": "The first time the series this message was a part of was completed by the user." }, "first_series_disengagement": { "type": "integer", "description": "The first time the series this message was a part of was disengaged by the user." }, "first_series_exit": { "type": "integer", "description": "The first time the series this message was a part of was exited by the user." }, "first_goal_success": { "type": "integer", "description": "The first time the user met this messages associated goal if one exists." }, "first_open": { "type": "integer", "description": "The first time the user opened this message." }, "first_click": { "type": "integer", "description": "The first time the series the user clicked on a link within this message." }, "first_dismisall": { "type": "integer", "description": "The first time the series the user dismissed this message." }, "first_unsubscribe": { "type": "integer", "description": "The first time the user unsubscribed from this message." }, "first_hard_bounce": { "type": "integer", "description": "The first time this message hard bounced for this user" } } }, "deleted_article_object": { "title": "Deleted Article Object", "type": "object", "description": "Response returned when an object is deleted", "properties": { "id": { "type": "string", "description": "The unique identifier for the article which you provided in the URL.", "example": "6890762" }, "object": { "type": "string", "description": "The type of object which was deleted. - article", "enum": [ "article" ], "example": "article" }, "deleted": { "type": "boolean", "description": "Whether the article was deleted successfully or not.", "example": true } } }, "deleted_collection_object": { "title": "Deleted Collection Object", "type": "object", "description": "Response returned when an object is deleted", "properties": { "id": { "type": "string", "description": "The unique identifier for the collection which you provided in the URL.", "example": "6890762" }, "object": { "type": "string", "description": "The type of object which was deleted. - `collection`", "enum": [ "collection" ], "example": "collection" }, "deleted": { "type": "boolean", "description": "Whether the collection was deleted successfully or not.", "example": true } } }, "deleted_company_object": { "title": "Deleted Company Object", "type": "object", "description": "Response returned when an object is deleted", "properties": { "id": { "type": "string", "description": "The unique identifier for the company which is given by Intercom.", "example": "5b7e8b2f-7a1a-4e6c-8e1b-4f9d4f4c4d4f" }, "object": { "type": "string", "description": "The type of object which was deleted. - `company`", "enum": [ "company" ], "example": "company" }, "deleted": { "type": "boolean", "description": "Whether the company was deleted successfully or not.", "example": true } } }, "deleted_object": { "title": "Deleted Object", "type": "object", "description": "Response returned when an object is deleted", "properties": { "id": { "type": "string", "description": "The unique identifier for the news item which you provided in the URL.", "example": "6890762" }, "object": { "type": "string", "description": "The type of object which was deleted - news-item.", "enum": [ "news-item" ], "example": "news-item" }, "deleted": { "type": "boolean", "description": "Whether the news item was deleted successfully or not.", "example": true } } }, "deleted_section_object": { "title": "Deleted Section Object", "type": "object", "description": "Response returned when an object is deleted", "properties": { "id": { "type": "string", "description": "The unique identifier for the section which you provided in the URL.", "example": "6890762" }, "object": { "type": "string", "description": "The type of object which was deleted. - `section`", "enum": [ "section" ], "example": "section" }, "deleted": { "type": "boolean", "description": "Whether the section was deleted successfully or not.", "example": true } } }, "detach_contact_from_conversation_request": { "properties": { "admin_id": { "type": "string", "description": "The `id` of the admin who is performing the action.", "example": "5017690" } }, "required": [ "admin_id" ] }, "error": { "type": "object", "title": "Error", "description": "The API will return an Error List for a failed request, which will contain one or more Error objects.", "properties": { "type": { "type": "string", "description": "The type is error.list", "example": "error.list" }, "request_id": { "type": "string", "nullable": true, "format": "uuid", "description": "", "example": "f93ecfa8-d08a-4325-8694-89aeb89c8f85" }, "errors": { "type": "array", "description": "An array of one or more error objects", "items": { "properties": { "code": { "type": "string", "description": "A string indicating the kind of error, used to further qualify the HTTP response code", "example": "unauthorized" }, "message": { "type": "string", "nullable": true, "description": "Optional. Human readable description of the error.", "example": "Access Token Invalid" }, "field": { "type": "string", "nullable": true, "description": "Optional. Used to identify a particular field or query parameter that was in error.", "example": "email" } }, "required": [ "code" ] } } }, "required": [ "type", "errors" ] }, "file_attribute": { "title": "File", "type": "object", "description": "The value describing a file upload set for a custom attribute", "properties": { "type": { "type": "string", "example": "upload" }, "name": { "type": "string", "description": "The name of the file", "example": "Screenshot.png" }, "url": { "type": "string", "description": "The url of the file. This is a temporary URL and will expire after 30 minutes.", "example": "https://intercom-attachments-1.com/.../Screenshot.png" }, "content_type": { "type": "string", "description": "The type of file", "example": "image/png" }, "filesize": { "type": "integer", "description": "The size of the file in bytes", "example": 11308309 }, "width": { "type": "integer", "description": "The width of the file in pixels, if applicable", "example": 3024 }, "height": { "type": "integer", "description": "The height of the file in pixels, if applicable", "example": 1964 } } }, "group_content": { "title": "Group Content", "type": "object", "description": "The Content of a Group.", "nullable": true, "properties": { "type": { "type": "string", "description": "The type of object - `group_content` .", "enum": [ null, "group_content" ], "example": "group_content", "nullable": true }, "name": { "type": "string", "description": "The name of the collection or section.", "example": "Collection name" }, "description": { "type": "string", "description": "The description of the collection. Only available for collections.", "example": " Collection description" } } }, "group_translated_content": { "title": "Group Translated Content", "type": "object", "description": "The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.", "nullable": true, "properties": { "type": { "type": "string", "description": "The type of object - group_translated_content.", "nullable": true, "enum": [ null, "group_translated_content" ], "example": "group_translated_content" }, "ar": { "description": "The content of the group in Arabic", "$ref": "#/components/schemas/group_content" }, "bg": { "description": "The content of the group in Bulgarian", "$ref": "#/components/schemas/group_content" }, "bs": { "description": "The content of the group in Bosnian", "$ref": "#/components/schemas/group_content" }, "ca": { "description": "The content of the group in Catalan", "$ref": "#/components/schemas/group_content" }, "cs": { "description": "The content of the group in Czech", "$ref": "#/components/schemas/group_content" }, "da": { "description": "The content of the group in Danish", "$ref": "#/components/schemas/group_content" }, "de": { "description": "The content of the group in German", "$ref": "#/components/schemas/group_content" }, "el": { "description": "The content of the group in Greek", "$ref": "#/components/schemas/group_content" }, "en": { "description": "The content of the group in English", "$ref": "#/components/schemas/group_content" }, "es": { "description": "The content of the group in Spanish", "$ref": "#/components/schemas/group_content" }, "et": { "description": "The content of the group in Estonian", "$ref": "#/components/schemas/group_content" }, "fi": { "description": "The content of the group in Finnish", "$ref": "#/components/schemas/group_content" }, "fr": { "description": "The content of the group in French", "$ref": "#/components/schemas/group_content" }, "he": { "description": "The content of the group in Hebrew", "$ref": "#/components/schemas/group_content" }, "hr": { "description": "The content of the group in Croatian", "$ref": "#/components/schemas/group_content" }, "hu": { "description": "The content of the group in Hungarian", "$ref": "#/components/schemas/group_content" }, "id": { "description": "The content of the group in Indonesian", "$ref": "#/components/schemas/group_content" }, "it": { "description": "The content of the group in Italian", "$ref": "#/components/schemas/group_content" }, "ja": { "description": "The content of the group in Japanese", "$ref": "#/components/schemas/group_content" }, "ko": { "description": "The content of the group in Korean", "$ref": "#/components/schemas/group_content" }, "lt": { "description": "The content of the group in Lithuanian", "$ref": "#/components/schemas/group_content" }, "lv": { "description": "The content of the group in Latvian", "$ref": "#/components/schemas/group_content" }, "mn": { "description": "The content of the group in Mongolian", "$ref": "#/components/schemas/group_content" }, "nb": { "description": "The content of the group in Norwegian", "$ref": "#/components/schemas/group_content" }, "nl": { "description": "The content of the group in Dutch", "$ref": "#/components/schemas/group_content" }, "pl": { "description": "The content of the group in Polish", "$ref": "#/components/schemas/group_content" }, "pt": { "description": "The content of the group in Portuguese (Portugal)", "$ref": "#/components/schemas/group_content" }, "ro": { "description": "The content of the group in Romanian", "$ref": "#/components/schemas/group_content" }, "ru": { "description": "The content of the group in Russian", "$ref": "#/components/schemas/group_content" }, "sl": { "description": "The content of the group in Slovenian", "$ref": "#/components/schemas/group_content" }, "sr": { "description": "The content of the group in Serbian", "$ref": "#/components/schemas/group_content" }, "sv": { "description": "The content of the group in Swedish", "$ref": "#/components/schemas/group_content" }, "tr": { "description": "The content of the group in Turkish", "$ref": "#/components/schemas/group_content" }, "vi": { "description": "The content of the group in Vietnamese", "$ref": "#/components/schemas/group_content" }, "pt-BR": { "description": "The content of the group in Portuguese (Brazil)", "$ref": "#/components/schemas/group_content" }, "zh-CN": { "description": "The content of the group in Chinese (China)", "$ref": "#/components/schemas/group_content" }, "zh-TW": { "description": "The content of the group in Chinese (Taiwan)", "$ref": "#/components/schemas/group_content" } } }, "help_center": { "title": "Help Center", "type": "object", "x-tags": [ "Help Center" ], "description": "Help Centers contain collections", "properties": { "id": { "type": "string", "description": "The unique identifier for the Help Center which is given by Intercom.", "example": "123" }, "workspace_id": { "type": "string", "description": "The id of the workspace which the Help Center belongs to.", "example": "hfi1bx4l" }, "created_at": { "type": "integer", "format": "date-time", "description": "The time when the Help Center was created.", "example": 1672928359 }, "updated_at": { "type": "integer", "format": "date-time", "description": "The time when the Help Center was last updated.", "example": 1672928610 }, "identifier": { "type": "string", "description": "The identifier of the Help Center. This is used in the URL of the Help Center.", "example": "intercom" }, "website_turned_on": { "type": "boolean", "description": "Whether the Help Center is turned on or not. This is controlled in your Help Center settings.", "example": true }, "display_name": { "type": "string", "description": "The display name of the Help Center only seen by teammates.", "example": "Intercom Help Center" }, "url": { "type": "string", "description": "The URL for the help center, if you have a custom domain then this will show the URL using the custom domain.", "example": "https://intercom.help/mycompany" }, "custom_domain": { "type": "string", "nullable": true, "description": "Custom domain configured for the help center", "example": "help.mycompany.com" } } }, "help_center_list": { "title": "Help Centers", "type": "object", "x-tags": [ "Help Center" ], "description": "A list of Help Centers belonging to the App", "properties": { "type": { "type": "string", "description": "The type of the object - `list`.", "enum": [ "list" ], "example": "list" }, "data": { "type": "array", "description": "An array of Help Center objects", "items": { "$ref": "#/components/schemas/help_center" } } } }, "intercom_version": { "description": "Intercom API version.By default, it's equal to the version set in the app package.", "type": "string", "example": "2.8", "default": "2.8", "enum": [ "1.0", "1.1", "1.2", "1.3", "1.4", "2.0", "2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7", "2.8", "Preview" ] }, "merge_contacts_request": { "description": "Merge contact data.", "type": "object", "title": "Merge contact data", "properties": { "from": { "type": "string", "description": "The unique identifier for the contact to merge away from. Must be a lead.", "example": "5d70dd30de4efd54f42fd526" }, "into": { "type": "string", "description": "The unique identifier for the contact to merge into. Must be a user.", "example": "5ba682d23d7cf92bef87bfd4" } } }, "message": { "type": "object", "title": "Message", "x-tags": [ "Messages" ], "description": "Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.", "properties": { "type": { "type": "string", "description": "The type of the message", "example": "user_message" }, "id": { "type": "string", "description": "The id representing the message.", "example": "1488971108" }, "created_at": { "type": "integer", "format": "date-time", "description": "The time the conversation was created.", "example": 1667560812 }, "subject": { "type": "string", "description": "The subject of the message. Only present if message_type: email.", "example": "Greetings" }, "body": { "type": "string", "description": "The message body, which may contain HTML.", "example": "Hello" }, "message_type": { "type": "string", "enum": [ "email", "inapp", "facebook", "twitter" ], "description": "The type of message that was sent. Can be email, inapp, facebook or twitter.", "example": "inapp" }, "conversation_id": { "type": "string", "description": "The associated conversation_id", "example": "64619700005570" } }, "required": [ "type", "id", "created_at", "body", "message_type" ] }, "multiple_filter_search_request": { "title": "Multiple Filter Search Request", "description": "Search using Intercoms Search APIs with more than one filter.", "type": "object", "properties": { "operator": { "type": "string", "enum": [ "AND", "OR" ], "description": "An operator to allow boolean inspection between multiple fields.", "example": "AND" }, "value": { "oneOf": [ { "type": "array", "description": "Add mutiple filters.", "title": "multiple filter search request", "items": { "$ref": "#/components/schemas/multiple_filter_search_request" } }, { "type": "array", "description": "Add a single filter field.", "title": "single filter search request", "items": { "$ref": "#/components/schemas/single_filter_search_request" } } ] } } }, "news_item": { "title": "News Item", "type": "object", "x-tags": [ "News" ], "description": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", "properties": { "type": { "type": "string", "description": "The type of object.", "enum": [ "news-item" ], "example": "news-item" }, "id": { "type": "string", "description": "The unique identifier for the news item which is given by Intercom.", "example": "141" }, "workspace_id": { "type": "string", "description": "The id of the workspace which the news item belongs to.", "example": "t74hdn32" }, "title": { "type": "string", "description": "The title of the news item.", "example": "New feature: News Items" }, "body": { "type": "string", "description": "The news item body, which may contain HTML.", "example": "We are excited to announce the launch of News Items, a new content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers." }, "sender_id": { "type": "integer", "description": "The id of the sender of the news item. Must be a teammate on the workspace.", "example": 123 }, "state": { "type": "string", "description": "News items will not be visible to your users in the assigned newsfeeds until they are set live.", "enum": [ "draft", "live" ], "example": "live" }, "newsfeed_assignments": { "type": "array", "description": "A list of newsfeed_assignments to assign to the specified newsfeed.", "items": { "$ref": "#/components/schemas/newsfeed_assignment" } }, "labels": { "type": "array", "description": "Label names displayed to users to categorize the news item.", "items": { "type": "string", "nullable": true, "description": "The label name.", "example": "Product Update" } }, "cover_image_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL of the image used as cover. Must have .jpg or .png extension.", "example": "https://example.com/cover.jpg" }, "reactions": { "type": "array", "description": "Ordered list of emoji reactions to the news item. When empty, reactions are disabled.", "items": { "type": "string", "nullable": true, "description": "The emoji reaction to the news item.", "example": "👍" } }, "deliver_silently": { "type": "boolean", "description": "When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.", "example": true }, "created_at": { "type": "integer", "format": "timestamp", "description": "Timestamp for when the news item was created.", "example": 1610589632 }, "updated_at": { "type": "integer", "format": "timestamp", "description": "Timestamp for when the news item was last updated.", "example": 1610589632 } } }, "news_item_request": { "description": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", "type": "object", "title": "Create News Item Request", "properties": { "title": { "type": "string", "description": "The title of the news item.", "example": "Halloween is here!" }, "body": { "type": "string", "description": "The news item body, which may contain HTML.", "example": "New costumes in store for this spooky season
" }, "sender_id": { "type": "integer", "description": "The id of the sender of the news item. Must be a teammate on the workspace.", "example": 123 }, "state": { "type": "string", "description": "News items will not be visible to your users in the assigned newsfeeds until they are set live.", "enum": [ "draft", "live" ], "example": "live" }, "deliver_silently": { "type": "boolean", "description": "When set to `true`, the news item will appear in the messenger newsfeed without showing a notification badge.", "example": true }, "labels": { "type": "array", "description": "Label names displayed to users to categorize the news item.", "items": { "type": "string" }, "example": [ "Product", "Update", "New" ] }, "reactions": { "type": "array", "description": "Ordered list of emoji reactions to the news item. When empty, reactions are disabled.", "items": { "type": "string", "nullable": true }, "example": [ "😆", "😅" ] }, "newsfeed_assignments": { "type": "array", "description": "A list of newsfeed_assignments to assign to the specified newsfeed.", "items": { "$ref": "#/components/schemas/newsfeed_assignment" } } }, "required": [ "title", "sender_id" ] }, "newsfeed": { "title": "Newsfeed", "type": "object", "x-tags": [ "News" ], "description": "A newsfeed is a collection of news items, targeted to a specific audience.\n\nNewsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom.\n", "properties": { "id": { "type": "string", "description": "The unique identifier for the newsfeed which is given by Intercom.", "example": "12312" }, "type": { "type": "string", "description": "The type of object.", "enum": [ "newsfeed" ], "example": "newsfeed" }, "name": { "type": "string", "description": "The name of the newsfeed. This name will never be visible to your users.", "example": "My Newsfeed" }, "created_at": { "type": "integer", "format": "timestamp", "description": "Timestamp for when the newsfeed was created.", "example": 1674917488 }, "updated_at": { "type": "integer", "format": "timestamp", "description": "Timestamp for when the newsfeed was last updated.", "example": 1674917488 } } }, "newsfeed_assignment": { "title": "Newsfeed Assignment", "type": "object", "x-tags": [ "News" ], "description": "Assigns a news item to a newsfeed.", "properties": { "newsfeed_id": { "type": "integer", "description": "The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article).", "example": 198313 }, "published_at": { "type": "integer", "format": "timestamp", "description": "Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is \"draft\".", "example": 1674917488 } } }, "note": { "title": "Note", "type": "object", "x-tags": [ "Notes" ], "description": "Notes allow you to annotate and comment on your contacts.", "properties": { "type": { "type": "string", "description": "String representing the object's type. Always has the value `note`.", "example": "note" }, "id": { "type": "string", "description": "The id of the note.", "example": "17495962" }, "created_at": { "type": "integer", "format": "timestamp", "description": "The time the note was created.", "example": 1674589321 }, "contact": { "type": "object", "description": "Represents the contact that the note was created about.", "nullable": true, "properties": { "type": { "type": "string", "description": "String representing the object's type. Always has the value `contact`." }, "id": { "type": "string", "description": "The id of the contact.", "example": "214656d0c743eafcfde7f248" } } }, "author": { "$ref": "#/components/schemas/admin", "description": "Optional. Represents the Admin that created the note." }, "body": { "type": "string", "description": "The body text of the note.", "example": "Text for the note.
" } } }, "note_list": { "title": "Paginated Response", "type": "object", "description": "A paginated list of notes associated with a contact.", "properties": { "type": { "type": "string", "description": "String representing the object's type. Always has the value `list`.", "example": "list" }, "data": { "type": "array", "description": "An array of notes.", "items": { "$ref": "#/components/schemas/note" } }, "total_count": { "type": "integer", "description": "A count of the total number of notes.", "example": 1 }, "pages": { "$ref": "#/components/schemas/cursor_pages" } } }, "open_conversation_request": { "title": "Open Conversation Request", "type": "object", "description": "Payload of the request to open a conversation", "properties": { "message_type": { "type": "string", "enum": [ "open" ], "example": "open" }, "admin_id": { "type": "string", "description": "The id of the admin who is performing the action.", "example": "5017690" } }, "required": [ "message_type", "admin_id" ] }, "pages_link": { "title": "Pagination Object", "type": "object", "description": "The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.\n\nTheir responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.\n", "properties": { "type": { "type": "string", "example": "pages", "enum": [ "pages" ] }, "page": { "type": "integer", "example": 1 }, "next": { "type": "string", "format": "uri", "description": "A link to the next page of results. A response that does not contain a next link does not have further data to fetch.", "nullable": true }, "per_page": { "type": "integer", "example": 50 }, "total_pages": { "type": "integer", "example": 1 } } }, "paginated_response": { "title": "Paginated Response", "type": "object", "description": "Paginated Response", "properties": { "type": { "type": "string", "description": "The type of object", "enum": [ "list", "conversation.list" ], "example": "list" }, "pages": { "$ref": "#/components/schemas/cursor_pages" }, "total_count": { "type": "integer", "description": "A count of the total number of objects.", "example": 1 }, "data": { "type": "array", "description": "An array of Objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/news_item" }, { "$ref": "#/components/schemas/newsfeed" } ] } } } }, "part_attachment": { "title": "Part attachment", "type": "object", "description": "The file attached to a part", "properties": { "type": { "type": "string", "description": "The type of attachment", "example": "upload" }, "name": { "type": "string", "description": "The name of the attachment", "example": "example.png" }, "url": { "type": "string", "description": "The URL of the attachment", "example": "https://picsum.photos/200/300" }, "content_type": { "type": "string", "description": "The content type of the attachment", "example": "image/png" }, "filesize": { "type": "integer", "description": "The size of the attachment", "example": 100 }, "width": { "type": "integer", "description": "The width of the attachment", "example": 100 }, "height": { "type": "integer", "description": "The height of the attachment", "example": 100 } } }, "phone_switch": { "title": "Phone Switch", "type": "object", "description": "Phone Switch Response", "nullable": true, "properties": { "type": { "type": "string", "description": "", "enum": [ "phone_call_redirect" ], "default": "phone_call_redirect", "example": "phone_call_redirect" }, "phone": { "type": "string", "description": "Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger.", "example": "+1 1234567890" } } }, "redact_conversation_request": { "oneOf": [ { "title": "Redact Conversation Part Request", "type": "object", "description": "Payload of the request to redact a conversation part", "properties": { "type": { "type": "string", "enum": [ "conversation_part" ], "description": "The type of resource being redacted.", "example": "conversation_part" }, "conversation_id": { "type": "string", "description": "The id of the conversation.", "example": "19894788788" }, "conversation_part_id": { "type": "string", "description": "The id of the conversation_part.", "example": "19381789428" } }, "required": [ "type", "conversation_id", "conversation_part_id" ] }, { "title": "Redact Conversation Source Request", "type": "object", "description": "Payload of the request to redact a conversation source", "properties": { "type": { "type": "string", "enum": [ "source" ], "description": "The type of resource being redacted.", "example": "source" }, "conversation_id": { "type": "string", "description": "The id of the conversation.", "example": "19894788788" }, "source_id": { "type": "string", "description": "The id of the source.", "example": "19894781231" } }, "required": [ "type", "conversation_id", "source_id" ] } ] }, "reference": { "title": "Reference", "type": "object", "description": "reference to another object", "properties": { "type": { "type": "string", "description": "", "example": "contact" }, "id": { "type": "string", "nullable": true, "description": "", "example": "1a2b3c" } } }, "reply_conversation_request": { "oneOf": [ { "$ref": "#/components/schemas/contact_reply_conversation_request" }, { "$ref": "#/components/schemas/admin_reply_conversation_request" } ] }, "search_request": { "description": "Search using Intercoms Search APIs.", "type": "object", "title": "Search data", "properties": { "query": { "oneOf": [ { "$ref": "#/components/schemas/single_filter_search_request", "title": "Single filter search request" }, { "$ref": "#/components/schemas/multiple_filter_search_request", "title": "multiple filter search request" } ] }, "pagination": { "$ref": "#/components/schemas/starting_after_paging" } }, "required": [ "query" ] }, "section": { "title": "Section", "type": "object", "x-tags": [ "Help Center" ], "description": "Sections are subdivisions of a collection, with a collection potentially having multiple sections.", "properties": { "type": { "type": "string", "description": "The type of object - `section`.", "enum": [ "section" ], "default": "section", "example": "section" }, "id": { "type": "string", "description": "The unique identifier for the section which is given by Intercom.", "example": "6871119" }, "workspace_id": { "type": "string", "description": "The id of the workspace which the section belongs to.", "example": "hfi1bx4l" }, "name": { "type": "string", "description": "The name of the section. For multilingual sections, this will be the name of the default language's content.", "example": "Default language name" }, "created_at": { "type": "integer", "format": "date-time", "description": "The time when the section was created. For multilingual sections, this will be the timestamp of creation of the default language's content.", "example": 1672928359 }, "updated_at": { "type": "integer", "format": "date-time", "description": "The time when the section was last updated. For multilingual sections, this will be the timestamp of last update of the default language's content.", "example": 1672928610 }, "url": { "type": "string", "nullable": true, "description": "The URL of the section. For multilingual help centers, this will be the URL of the section for the default language.", "example": "http://intercom.test/help/section/name" }, "icon": { "type": "string", "nullable": true, "description": "The icon of the section.", "example": "book-bookmark" }, "order": { "type": "integer", "description": "The order of the section in relation to others sections within a collection. Values go from `0` upwards. `0` is the default if there's no order.", "example": "1" }, "parent_id": { "oneOf": [ { "type": "integer", "title": "Integer" }, { "type": "string", "title": "String" } ], "description": "The id of the parent section.", "example": 6871119 }, "default_locale": { "type": "string", "description": "The default locale of the help center. This field is only returned for multilingual help centers.", "example": "en" }, "translated_content": { "nullable": true, "$ref": "#/components/schemas/group_translated_content" } } }, "section_list": { "title": "Sections", "type": "object", "description": "This will return a list of Sections for the App.", "properties": { "type": { "type": "string", "description": "The type of the object - `list`.", "enum": [ "list" ], "example": "list" }, "pages": { "$ref": "#/components/schemas/cursor_pages" }, "total_count": { "type": "integer", "description": "A count of the total number of sections.", "example": 12 }, "data": { "type": "array", "description": "An array of section objects", "items": { "$ref": "#/components/schemas/section" } } } }, "segment": { "title": "Segment", "type": "object", "x-tags": [ "Segments" ], "description": "A segment is a group of your contacts defined by the rules that you set.", "properties": { "type": { "type": "string", "description": "The type of object.", "enum": [ "segment" ], "example": "segment" }, "id": { "type": "string", "description": "The unique identifier representing the segment.", "example": "56203d253cba154d39010062" }, "name": { "type": "string", "description": "The name of the segment.", "example": "Active" }, "created_at": { "type": "integer", "description": "The time the segment was created.", "example": 1394621988 }, "updated_at": { "type": "integer", "description": "The time the segment was updated.", "example": 1394622004 }, "person_type": { "type": "string", "description": "Type of the contact: contact (lead) or user.", "enum": [ "contact", "user" ], "example": "contact" }, "count": { "type": "integer", "description": "The number of items in the user segment. It's returned when `include_count=true` is included in the request.", "example": 3, "nullable": true } } }, "segment_list": { "title": "Segment List", "type": "object", "description": "This will return a list of Segment Objects. The result may also have a pages object if the response is paginated.", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "segment.list" ], "example": "segment.list" }, "segments": { "type": "array", "description": "A list of Segment objects", "items": { "$ref": "#/components/schemas/segment" } }, "pages": { "type": "object", "description": "A pagination object, which may be empty, indicating no further pages to fetch." } } }, "single_filter_search_request": { "title": "Single Filter Search Request", "description": "Search using Intercoms Search APIs with a single filter.", "type": "object", "properties": { "field": { "type": "string", "description": "The accepted field that you want to search on.", "example": "created_at" }, "operator": { "type": "string", "enum": [ "=", "!=", "IN", "NIN", "<", ">", "~", "!~", "^", "$" ], "description": "The accepted operators you can use to define how you want to search for the value.", "example": ">" }, "value": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] } } ], "description": "The value that you want to search on.", "example": "73732934", "nullable": true } } }, "sla_applied": { "title": "Applied SLA", "type": "object", "nullable": true, "description": "The SLA Applied object contains the details for which SLA has been applied to this conversation.\nImportant: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null.\n", "properties": { "type": { "type": "string", "description": "object type", "example": "conversation_sla_summary" }, "sla_name": { "type": "string", "description": "The name of the SLA as given by the teammate when it was created.", "example": "" }, "sla_status": { "type": "string", "enum": [ "hit", "missed", "cancelled", "active" ], "description": "SLA statuses:\n - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation.\n - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies.\n - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events.", "example": "hit" } } }, "snooze_conversation_request": { "title": "Snooze Conversation Request", "type": "object", "description": "Payload of the request to snooze a conversation", "properties": { "message_type": { "type": "string", "enum": [ "snoozed" ], "example": "snoozed" }, "admin_id": { "type": "string", "description": "The id of the admin who is performing the action.", "example": "5017691" }, "snoozed_until": { "type": "integer", "format": "timestamp", "description": "The time you want the conversation to reopen.", "example": 1673609604 } }, "required": [ "message_type", "admin_id", "snoozed_until" ] }, "social_profile": { "title": "Social Profile", "type": "object", "description": "A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile.", "properties": { "type": { "type": "string", "description": "value is \"social_profile\"", "example": "social_profile" }, "name": { "type": "string", "description": "The name of the Social media profile", "example": "Facebook" }, "url": { "type": "string", "format": "uri", "description": "The name of the Social media profile", "example": "http://twitter.com/th1sland" } } }, "starting_after_paging": { "title": "Pagination: Starting After", "type": "object", "nullable": true, "properties": { "per_page": { "type": "integer", "description": "The number of results to fetch per page.", "example": 2 }, "starting_after": { "type": "string", "description": "The cursor to use in the next request to get the next page of results.", "nullable": true, "example": "your-cursor-from-response" } } }, "subscription_type": { "title": "Subscription Types", "type": "object", "x-tags": [ "Subscription Types" ], "description": "A subscription type lets customers easily opt out of non-essential communications without missing what's important to them.", "properties": { "type": { "type": "string", "description": "The type of the object - subscription", "example": "subscription" }, "id": { "type": "string", "description": "The unique identifier representing the subscription type.", "example": "123456" }, "state": { "type": "string", "description": "The state of the subscription type.", "enum": [ "live", "draft", "archived" ], "example": "live" }, "default_translation": { "$ref": "#/components/schemas/translation" }, "translations": { "type": "array", "description": "An array of translations objects with the localised version of the subscription type in each available locale within your translation settings.", "items": { "$ref": "#/components/schemas/translation" } }, "consent_type": { "type": "string", "description": "Describes the type of consent.", "enum": [ "opt_out", "opt_in" ], "example": "opt_in" }, "content_types": { "type": "array", "description": "The message types that this subscription supports - can contain `email` or `sms_message`.", "items": { "type": "string", "enum": [ "email", "sms_message" ], "example": "email" } } } }, "subscription_type_list": { "title": "Subscription Types", "type": "object", "description": "A list of subscription type objects.", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "list" ], "example": "list" }, "data": { "type": "array", "description": "A list of subscription type objects associated with the workspace .", "items": { "$ref": "#/components/schemas/subscription_type" } } } }, "tag": { "title": "Tag", "type": "object", "x-tags": [ "Tags" ], "description": "A tag allows you to label your contacts, companies, and conversations and list them using that tag.", "properties": { "type": { "type": "string", "description": "value is \"tag\"", "example": "tag" }, "id": { "type": "string", "description": "The id of the tag", "example": "123456" }, "name": { "type": "string", "description": "The name of the tag", "example": "Test tag" }, "applied_at": { "type": "integer", "format": "date-time", "nullable": true, "description": "The time when the tag was applied to the object. Only present when the tag is returned as part of a tagging operation on a contact, conversation, or ticket.", "example": 1663597223 }, "applied_by": { "type": "object", "nullable": true, "description": "The admin who applied the tag. Only present when the tag is returned as part of a tagging operation on a contact, conversation, or ticket.", "allOf": [ { "$ref": "#/components/schemas/reference" } ] } } }, "tag_basic": { "title": "Tag", "type": "object", "x-tags": [ "Tags" ], "description": "A tag allows you to label your contacts, companies, and conversations and list them using that tag.", "properties": { "type": { "type": "string", "description": "value is \"tag\"", "example": "tag" }, "id": { "type": "string", "description": "The id of the tag", "example": "123456" }, "name": { "type": "string", "description": "The name of the tag", "example": "Test tag" } } }, "tag_company_request": { "description": "You can tag a single company or a list of companies.", "type": "object", "title": "Tag Company Request Payload", "properties": { "name": { "type": "string", "description": "The name of the tag, which will be created if not found.", "example": "Independent" }, "companies": { "type": "array", "items": { "properties": { "id": { "type": "string", "description": "The Intercom defined id representing the company.", "example": "531ee472cce572a6ec000006" }, "company_id": { "type": "string", "description": "The company id you have defined for the company.", "example": "6" } } }, "description": "The id or company_id of the company can be passed as input parameters." } }, "required": [ "name", "companies" ] }, "tag_list": { "title": "Tags", "type": "object", "description": "A list of tags objects in the workspace.", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "list" ], "example": "list" }, "data": { "type": "array", "description": "A list of tags objects associated with the workspace .", "items": { "$ref": "#/components/schemas/tag" } } } }, "tag_multiple_users_request": { "description": "You can tag a list of users.", "type": "object", "title": "Tag Users Request Payload", "properties": { "name": { "type": "string", "description": "The name of the tag, which will be created if not found.", "example": "Independent" }, "users": { "type": "array", "items": { "properties": { "id": { "type": "string", "description": "The Intercom defined id representing the user.", "example": "5f7f0d217289f8d2f4262080" } } } } }, "required": [ "name", "users" ] }, "tags": { "title": "Tags", "type": "object", "description": "A list of tags objects associated with a conversation", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "tag.list" ], "example": "tag.list" }, "tags": { "type": "array", "description": "A list of tags objects associated with the conversation.", "items": { "$ref": "#/components/schemas/tag" } } } }, "team": { "title": "Team", "type": "object", "x-tags": [ "Teams" ], "description": "Teams are groups of admins in Intercom.", "properties": { "type": { "type": "string", "description": "Value is always \"team\"", "example": "team" }, "id": { "type": "string", "description": "The id of the team", "example": "814865" }, "name": { "type": "string", "description": "The name of the team", "example": "Example Team" }, "admin_ids": { "type": "array", "description": "The list of admin IDs that are a part of the team.", "example": [ 493881 ], "items": { "type": "integer" } }, "admin_priority_level": { "$ref": "#/components/schemas/admin_priority_level" } } }, "team_list": { "title": "Team List", "type": "object", "description": "This will return a list of team objects for the App.", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "team.list" ], "example": "team.list" }, "teams": { "type": "array", "description": "A list of team objects", "items": { "$ref": "#/components/schemas/team" } } } }, "team_priority_level": { "title": "Team Priority Level", "type": "object", "nullable": true, "description": "Admin priority levels for teams", "properties": { "primary_team_ids": { "type": "array", "description": "The primary team ids for the team", "nullable": true, "example": [ 814865 ], "items": { "type": "integer" } }, "secondary_team_ids": { "type": "array", "description": "The secondary team ids for the team", "nullable": true, "example": [ 493881 ], "items": { "type": "integer" } } } }, "translation": { "title": "Translation", "type": "object", "description": "A translation object contains the localised details of a subscription type.", "properties": { "name": { "type": "string", "description": "The localised name of the subscription type.", "example": "Announcements" }, "description": { "type": "string", "description": "The localised description of the subscription type.", "example": "Offers, product and feature announcements" }, "locale": { "type": "string", "description": "The two character identifier for the language of the translation object.", "example": "en" } } }, "untag_company_request": { "description": "You can tag a single company or a list of companies.", "type": "object", "title": "Untag Company Request Payload", "properties": { "name": { "type": "string", "description": "The name of the tag which will be untagged from the company", "example": "Independent" }, "companies": { "type": "array", "items": { "properties": { "id": { "type": "string", "description": "The Intercom defined id representing the company.", "example": "531ee472cce572a6ec000006" }, "company_id": { "type": "string", "description": "The company id you have defined for the company.", "example": "6" }, "untag": { "type": "boolean", "description": "Always set to true", "example": "true" } } }, "description": "The id or company_id of the company can be passed as input parameters." } }, "required": [ "name", "companies" ] }, "update_article_request": { "description": "You can Update an Article", "type": "object", "title": "Update Article Request Payload", "nullable": true, "properties": { "title": { "type": "string", "description": "The title of the article.For multilingual articles, this will be the title of the default language's content.", "example": "Thanks for everything" }, "description": { "type": "string", "description": "The description of the article. For multilingual articles, this will be the description of the default language's content.", "example": "Description of the Article" }, "body": { "type": "string", "description": "The content of the article. For multilingual articles, this will be the body of the default language's content.", "example": "This is the body in html
" }, "author_id": { "type": "integer", "description": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", "example": 1295 }, "state": { "type": "string", "description": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.", "enum": [ "published", "draft" ], "example": "draft" }, "parent_id": { "type": "string", "description": "The id of the article's parent collection or section. An article without this field stands alone.", "example": "18" }, "parent_type": { "type": "string", "description": "The type of parent, which can either be a `collection` or `section`.", "example": "collection" }, "translated_content": { "$ref": "#/components/schemas/article_translated_content" } } }, "update_collection_request": { "description": "You can update a collection", "type": "object", "title": "Update Collection Request Payload", "properties": { "name": { "type": "string", "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content.", "example": "collection 51" }, "description": { "type": "string", "description": "The description of the collection. For multilingual collections, this will be the description of the default language's content.", "example": "English description" }, "translated_content": { "nullable": true, "$ref": "#/components/schemas/group_translated_content" } } }, "update_contact_request": { "description": "You can update a contact", "type": "object", "title": "Update Contact Request Payload", "properties": { "role": { "type": "string", "description": "The role of the contact." }, "external_id": { "type": "string", "description": "A unique identifier for the contact which is given to Intercom" }, "email": { "type": "string", "description": "The contacts email", "example": "jdoe@example.com" }, "phone": { "type": "string", "nullable": true, "description": "The contacts phone", "example": "+353871234567" }, "name": { "type": "string", "nullable": true, "description": "The contacts name", "example": "John Doe" }, "avatar": { "type": "string", "nullable": true, "description": "An image URL containing the avatar of a contact", "example": "https://www.example.com/avatar_image.jpg" }, "signed_up_at": { "type": "integer", "format": "date-time", "nullable": true, "description": "The time specified for when a contact signed up", "example": 1571672154 }, "last_seen_at": { "type": "integer", "format": "date-time", "nullable": true, "description": "The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)", "example": 1571672154 }, "owner_id": { "type": "integer", "nullable": true, "description": "The id of an admin that has been assigned account ownership of the contact", "example": 123 }, "unsubscribed_from_emails": { "type": "boolean", "nullable": true, "description": "Whether the contact is unsubscribed from emails", "example": true }, "custom_attributes": { "type": "object", "nullable": true, "description": "The custom attributes which are set for the contact" } } }, "update_conversation_request": { "title": "Update Conversation Request", "type": "object", "description": "Payload of the request to update a conversation", "properties": { "read": { "type": "boolean", "description": "Mark a conversation as read within Intercom.", "example": true }, "custom_attributes": { "$ref": "#/components/schemas/custom_attributes" } } }, "update_data_attribute_request": { "description": "", "type": "object", "title": "Update Data Attribute Request", "properties": { "archived": { "type": "boolean", "description": "Whether the attribute is to be archived or not.", "example": false }, "description": { "type": "string", "description": "The readable description you see in the UI for the attribute.", "example": "My Data Attribute Description" }, "messenger_writable": { "type": "boolean", "description": "Can this attribute be updated by the Messenger", "example": false } }, "oneOf": [ { "properties": { "options": { "type": "array", "description": "Array of objects representing the options of the list, with `value` as the key and the option as the value. At least two options are required.", "items": { "type": "object", "properties": { "value": { "type": "string" } } }, "example": [ { "value": "1-10" }, { "value": "11-50" } ] } }, "required": [ "options" ], "title": "list attribute" }, { "title": "other type" } ] }, "update_section_request": { "description": "You can update a Section", "type": "object", "title": "Update Section Request Payload", "properties": { "name": { "type": "string", "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content.", "example": "Section 51" }, "parent_id": { "type": "integer", "description": "The id for the collection this section will be within.", "example": 18 }, "translated_content": { "nullable": true, "$ref": "#/components/schemas/group_translated_content" } } }, "update_visitor_request": { "description": "Update an existing visitor.", "type": "object", "title": "Update Visitor Request Payload", "properties": { "id": { "type": "string", "description": "A unique identified for the visitor which is given by Intercom.", "example": "8a88a590-e" }, "user_id": { "type": "string", "description": "A unique identified for the visitor which is given by you.", "example": "123" }, "name": { "type": "string", "description": "The visitor's name.", "example": "Christian Bale" }, "custom_attributes": { "type": "object", "description": "The custom attributes which are set for the visitor.", "additionalProperties": { "type": "string" }, "example": { "paid_subscriber": true, "monthly_spend": 155.5, "team_mates": 9 } } }, "anyOf": [ { "required": [ "id" ] }, { "required": [ "user_id" ] } ] }, "visitor": { "title": "Visitor", "type": "object", "description": "Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete.", "nullable": true, "properties": { "type": { "type": "string", "description": "Value is 'visitor'", "default": "visitor", "example": "visitor" }, "id": { "type": "string", "description": "The Intercom defined id representing the Visitor.", "example": "530370b477ad7120001d" }, "user_id": { "type": "string", "description": "Automatically generated identifier for the Visitor.", "example": "8a88a590-e1c3-41e2-a502-e0649dbf721c" }, "anonymous": { "type": "boolean", "description": "Identifies if this visitor is anonymous.", "example": false }, "email": { "type": "string", "format": "email", "description": "The email of the visitor.", "example": "jane.doe@example.com" }, "phone": { "type": "string", "nullable": true, "description": "The phone number of the visitor.", "example": "555-555-5555" }, "name": { "type": "string", "nullable": true, "description": "The name of the visitor.", "example": "Jane Doe" }, "pseudonym": { "type": "string", "nullable": true, "description": "The pseudonym of the visitor.", "example": "Red Duck from Dublin" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "description": "", "default": "avatar", "example": "avatar" }, "image_url": { "type": "string", "format": "uri", "nullable": true, "description": "This object represents the avatar associated with the visitor.", "example": "https://example.com/avatar.png" } } }, "app_id": { "type": "string", "description": "The id of the app the visitor is associated with.", "example": "hfi1bx4l" }, "companies": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "company.list" ], "example": "company.list" }, "companies": { "type": "array", "items": { "$ref": "#/components/schemas/company" } } } }, "location_data": { "type": "object", "properties": { "type": { "type": "string", "description": "", "default": "location_data", "example": "location_data" }, "city_name": { "type": "string", "description": "The city name of the visitor.", "example": "Dublin" }, "continent_code": { "type": "string", "description": "The continent code of the visitor.", "example": "EU" }, "country_code": { "type": "string", "description": "The country code of the visitor.", "example": "IRL" }, "country_name": { "type": "string", "description": "The country name of the visitor.", "example": "Ireland" }, "postal_code": { "type": "string", "description": "The postal code of the visitor.", "example": "D02 N960" }, "region_name": { "type": "string", "description": "The region name of the visitor.", "example": "Leinster" }, "timezone": { "type": "string", "description": "The timezone of the visitor.", "example": "Europe/Dublin" } } }, "las_request_at": { "type": "integer", "description": "The time the Lead last recorded making a request.", "example": 1663597260 }, "created_at": { "type": "integer", "description": "The time the Visitor was added to Intercom.", "example": 1663597223 }, "remote_created_at": { "type": "integer", "description": "The time the Visitor was added to Intercom.", "example": 1663597223 }, "signed_up_at": { "type": "integer", "description": "The time the Visitor signed up for your product.", "example": 1663597223 }, "updated_at": { "type": "integer", "description": "The last time the Visitor was updated.", "example": 1663597260 }, "session_count": { "type": "integer", "description": "The number of sessions the Visitor has had.", "example": 1 }, "social_profiles": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "social_profile.list" ], "example": "social_profile.list" }, "social_profiles": { "type": "array", "items": { "type": "string" } } } }, "owner_id": { "type": "string", "nullable": true, "description": "The id of the admin that owns the Visitor.", "example": "5169261" }, "unsubscribed_from_emails": { "type": "boolean", "description": "Whether the Visitor is unsubscribed from emails.", "example": false }, "marked_email_as_spam": { "type": "boolean", "description": "Identifies if this visitor has marked an email as spam.", "example": false }, "has_hard_bounced": { "type": "boolean", "description": "Identifies if this visitor has had a hard bounce.", "example": false }, "tags": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "tag.list" ], "example": "tag.list" }, "tags": { "type": "array", "items": { "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "tag" ], "example": "tag" }, "id": { "type": "string", "description": "The id of the tag.", "example": "8482" }, "name": { "type": "string", "description": "The name of the tag.", "example": "tag_name" } } } } } }, "segments": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "segment.list" ], "example": "segment.list" }, "segments": { "type": "array", "items": { "type": "string" } } } }, "custom_attributes": { "type": "object", "description": "The custom attributes you have set on the Visitor.", "additionalProperties": { "type": "string" } }, "referrer": { "type": "string", "nullable": true, "description": "The referer of the visitor.", "example": "https://www.google.com/" }, "utm_campaign": { "type": "string", "nullable": true, "description": "The utm_campaign of the visitor.", "example": "intercom-link" }, "utm_content": { "type": "string", "nullable": true, "description": "The utm_content of the visitor.", "example": "banner" }, "utm_medium": { "type": "string", "nullable": true, "description": "The utm_medium of the visitor.", "example": "email" }, "utm_source": { "type": "string", "nullable": true, "description": "The utm_source of the visitor.", "example": "Intercom" }, "utm_term": { "type": "string", "nullable": true, "description": "The utm_term of the visitor.", "example": "messenger" }, "do_not_track": { "type": "boolean", "nullable": true, "description": "Identifies if this visitor has do not track enabled.", "example": false } } }, "visitor_deleted_object": { "title": "Visitor Deleted Object", "type": "object", "description": "Response returned when an object is deleted", "properties": { "id": { "type": "string", "description": "The unique identifier for the visitor which is given by Intercom.", "example": "530370b477ad7120001d" }, "type": { "type": "string", "description": "The type of object which was deleted", "enum": [ "visitor" ], "example": "visitor" }, "user_id": { "type": "string", "description": "Automatically generated identifier for the Visitor.", "example": "8a88a590-e1c3-41e2-a502-e0649dbf721c" } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } }, "servers": [ { "url": "https://api.intercom.io", "description": "The production API server" }, { "url": "https://api.eu.intercom.io", "description": "The european API server" }, { "url": "https://api.au.intercom.io", "description": "The australian API server" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Admins", "description": "Everything about your Admins" }, { "name": "Articles", "description": "Everything about your Articles" }, { "name": "Companies", "description": "Everything about your Companies" }, { "name": "Contacts", "description": "Everything about your contacts" }, { "name": "Conversations", "description": "Everything about your Conversations", "externalDocs": { "description": "What is a conversation?", "url": "https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation" } }, { "name": "Data Attributes", "description": "Everything about your Data Attributes" }, { "name": "Data Events", "description": "Everything about your Data Events" }, { "name": "Data Export", "description": "Export message delivery and engagement statistics (opens, clicks, replies, completions, dismissals, unsubscribes, bounces) for outbound content such as Emails, Posts, Custom Bots, Surveys, Tours, and Series." }, { "name": "Help Center", "description": "Everything about your Help Center" }, { "name": "Messages", "description": "Everything about your messages" }, { "name": "News", "description": "Everything about your News", "externalDocs": { "description": "News explained", "url": "https://www.intercom.com/help/en/articles/6362251-news-explained" } }, { "name": "Notes", "description": "Everything about your Notes" }, { "name": "Segments", "description": "Everything about your Segments" }, { "name": "Subscription Types", "description": "Everything about subscription types" }, { "name": "Switch", "description": "Everything about Switch", "externalDocs": { "description": "Meet Switch: from on hold to messaging in just a few taps", "url": "https://www.intercom.com/switch" } }, { "name": "Tags", "description": "Everything about tags" }, { "name": "Teams", "description": "Everything about your Teams" }, { "name": "Visitors", "description": "Everything about your Visitors" } ] }