Skip to content
Home/
REST API Reference
/
/
Snooze Conversation Reque...

Intercom API (2.11)

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

SchemasOperations

Articles

Everything about your Articles

SchemasOperations

Companies

Everything about your Companies

SchemasOperations

Contacts

Everything about your contacts

SchemasOperations

Conversations

Everything about your Conversations

SchemasOperations

Data Attributes

Everything about your Data Attributes

SchemasOperations

Data Events

Everything about your Data Events

SchemasOperations

Data Export

Everything about your Data Exports

SchemasOperations

Help Center

Everything about your Help Center

SchemasOperations

Messages

Everything about your messages

SchemasOperations

News

Everything about your News

SchemasOperations

Notes

Everything about your Notes

SchemasOperations

Segments

Everything about your Segments

SchemasOperations

Subscription Types

Everything about subscription types

SchemasOperations

Switch

Everything about Switch

Operations

Tags

Everything about tags

SchemasOperations

Teams

Everything about your Teams

SchemasOperations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

SchemasOperations

Visitors

Everything about your Visitors

Operations

Models

Schemas

Applied SLA

The SLA Applied object contains the details for which SLA has been applied to this conversation. Important: 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.

typestringrequired

object type

Example: "conversation_sla_summary"
sla_namestringrequired

The name of the SLA as given by the teammate when it was created.

Example: ""
sla_statusstringrequired

SLA statuses:

  • hit: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation.
  • 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.
  • 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.
Enum"hit""missed""cancelled""active"
Example: "hit"
{
  "type": "conversation_sla_summary",
  "sla_name": "",
  "sla_status": "hit"
}

Snooze Conversation Request

Payload of the request to snooze a conversation

message_typestringrequired
Value"snoozed"
Example: "snoozed"
admin_idstringrequired

The id of the admin who is performing the action.

Example: "5017691"
snoozed_untilinteger(timestamp)required

The time you want the conversation to reopen.

Example: 1673609604
{
  "message_type": "snoozed",
  "admin_id": "5017691",
  "snoozed_until": 1673609604
}

Social Profile

A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile.

typestringrequired

value is "social_profile"

Example: "social_profile"
namestringrequired

The name of the Social media profile

Example: "Facebook"
urlstring(uri)required

The name of the Social media profile

Example: "http://example.com/th1sland"
{
  "type": "social_profile",
  "name": "Facebook",
  "url": "http://example.com/th1sland"
}