Close a conversation
Example Request & Response
$ curl https://api.intercom.io/conversations/<id>/parts\n-X POST\n-H 'Authorization:Bearer <Your access token>'\n-H 'Accept:application/json'\n-H 'Content-Type:application/json' -d\n\n{ \n \"message_type\": \"close\",\n \"type\": \"admin\",\n \"admin_id\": 5784329,\n \"body\": \"Closed conversation because of X.\"\n}
{\n \"type\": \"conversation\",\n \"id\": \"1911149811\",\n \"created_at\": 1539897198,\n \"updated_at\": 1540393270,\n \"source\": {\n \"attachments\": [],\n \"author\": {\n \"id\": \"5bc8f7421ae2d96695c18a\",\n \"type\": \"lead\"\n },\n \"body\": \"<p>Hi</p>\",\n \"delivered_as\": \"customer_initiated\",\n \"id\": \"269650473\",\n \"subject\": \"\",\n \"type\": \"conversation\",\n \"url\": \"https://intercom-survey-app.glitch.me/\"\n },\n \"contacts\": [\n {\n \"id\": \"5bc8f7ae2d96695c18a\",\n \"type\": \"lead\"\n }\n ],\n \"teammates\": [\n {\n \"id\": \"814860\",\n \"type\": \"admin\",\n \t\"name\": \"Mark Strong\",\n \t\"email\": \"mk@acmeinc.org\"\n }\n ],\n \"assignee\": {\n {\n \"id\": \"814860\",\n \"type\": \"admin\",\n \t\"name\": \"Mark Strong\",\n \t\"email\": \"mk@acmeinc.org\"\n }\n },\n \"open\": true,\n \"state\": \"open\",\n \"read\": true,\n \"waiting_since\": 64654125776\n \"snoozed_until\": null,\n \"tags\": {\n \"tags\": [],\n \"type\": \"tag.list\",\n },\n \"first_contact_reply\": {\n \t\"created_at\": 1539897198\n \t\"type\": \"conversation\",\n \t\"url\": \"https://intercom-survey-app.glitch.me/\"\n },\n \"priority\": \"not_priority\",\n \"sla_applied\": {\n \t\"sla_name\": \"VIP customer <5m\",\n \"sla_status\": \"missed\",\n },\n \"conversation_rating\": {\n \"created_at\": null,\n \"contact\": {\n \"id\": null,\n \"type\": null\n },\n \"rating\": null,\n \"remark\": null,\n \"teammate\": {\n \"id\": null,\n \"type\": null,\n \"name\": null,\n \"email\": null\n }\n },\n \"statistics\": {\n \"time_to_assignment\": 2310,\n \"time_to_admin_reply\": 2408,\n \"time_to_first_close\": 4915 ,\n \"time_to_last_close\": 5125,\n \"median_time_to_reply\": 321,\n \"first_contacat_reply_at\": 1539897200,\n \"first_assignment_at\": 1539897200,\n \"first_admin_reply_at\": 1539897200,\n \"first_close_at\": 1539897200,\n \"last_assignment_at\": 1539897200,\n \"last_assignment_admin_reply_at\": 1539897200,\n \"last_contact_reply_at\": 1539897200,\n \"last_admin_reply_at\": 1539897200,\n \"last_close_at\": 1539897200,\n \"last_closed_by\": {\n \t\"type\": \"admin\",\n \"id\": \"325432652\",\n \"name\": \"Tom Smith\",\n \"email\": \"tom@example.com\"\n },\n \"count_reopens\": 3,\n \"count_assignments\": 2,\n \"count_conversation_parts\": 67\n }, \n}
You can close a conversation.
Parameter | Type | Required? | Description |
---|---|---|---|
id | String | Yes | The identifier for the conversation as given by Intercom. |
Request Body Parameters
Parameter | Type | Required? | Descripton |
---|---|---|---|
message_type | String | Yes | Always close . |
type | String | Yes | Always admin . |
admin_id | String | Yes | The id of the admin who is performing the action. |
body | String | No | Optionally you can leave a message in the conversation to provide additional context to the user and other teammates. |
Response
This will return the Conversation that has been closed.