Home
/
REST API Reference
/
Models
/
Close Conversation Request

Intercom API (2.9)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL

https://developers.intercom.com

License

MIT

Languages
Servers
The production API server

https://api.intercom.io/

The european API server

https://api.eu.intercom.io/

The australian API server

https://api.au.intercom.io/

Admins

Everything about your Admins

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models

Assign Conversation Request

Payload of the request to assign a conversation

admin_idstring

The id of the admin who is adding the new participant.

Example: "12345"
customerIntercom User ID (object) or User ID (object) or Email (object)
One of:
{
  "admin_id": "12345",
  "customer": {
    "intercom_user_id": "6329bd9ffe4e2e91dac76188",
    "customer": { … }
  }
}

Close Conversation Request

Payload of the request to close a conversation

message_typestringrequired
Value"close"
Example: "close"
typestringrequired
Value"admin"
Example: "admin"
admin_idstringrequired

The id of the admin who is performing the action.

Example: "12345"
bodystring

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!"
{
  "message_type": "close",
  "type": "admin",
  "admin_id": "12345",
  "body": " This conversation is now closed!"
}

Collections

This will return a list of Collections for the App.

typestring

The type of the object - list.

Value"list"
Example: "list"
pagesobject or null(Cursor based pages)

Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "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.

total_countinteger

A count of the total number of collections.

Example: 1
dataArray of objects(Collection)

An array of collection objects

{
  "type": "list",
  "pages": {
    "type": "pages",
    "page": 1,
    "next": { … },
    "per_page": 2,
    "total_pages": 13
  },
  "total_count": 1,
  "data": [
    { … }
  ]
}