Skip to content
Home
/
REST API Reference
/
Models
/
Update Section Request Payload

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

Update Data Attribute Request

One of:
optionsArray of objectsrequired

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.

Example: [{"value":"1-10"},{"value":"11-50"}]
options[].​valuestring
archivedboolean

Whether the attribute is to be archived or not.

Example: false
descriptionstring

The readable description you see in the UI for the attribute.

Example: "My Data Attribute Description"
messenger_writableboolean

Can this attribute be updated by the Messenger

Example: false
{
  "options": [
    { … },
    { … }
  ],
  "archived": false,
  "description": "My Data Attribute Description",
  "messenger_writable": false
}

Update Section Request Payload

You can update a Section

namestring

The name of the collection. For multilingual collections, this will be the name of the default language's content.

Example: "Section 51"
parent_idinteger

The id for the collection this section will be within.

Example: 18
translated_contentobject or null(Group Translated Content)

The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.

{
  "name": "Section 51",
  "parent_id": 18,
  "translated_content": {
    "type": "group_translated_content",
    "ar": { … },
    "bg": { … },
    "bs": { … },
    "ca": { … },
    "cs": { … },
    "da": { … },
    "de": { … },
    "el": { … },
    "en": { … },
    "es": { … },
    "et": { … },
    "fi": { … },
    "fr": { … },
    "he": { … },
    "hr": { … },
    "hu": { … },
    "id": { … },
    "it": { … },
    "ja": { … },
    "ko": { … },
    "lt": { … },
    "lv": { … },
    "mn": { … },
    "nb": { … },
    "nl": { … },
    "pl": { … },
    "pt": { … },
    "ro": { … },
    "ru": { … },
    "sl": { … },
    "sr": { … },
    "sv": { … },
    "tr": { … },
    "vi": { … },
    "pt-BR": { … },
    "zh-CN": { … },
    "zh-TW": { … }
  }
}

Update Ticket Request Payload

You can update a Ticket

ticket_attributesobject

The attributes set on the ticket.

Example: {"_default_title_":"example","_default_description_":"having a problem"}
statestring

The state of the ticket.

Enum"in_progress""waiting_on_customer""resolved"
Example: "submitted"
is_sharedboolean

Specify whether the ticket is visible to users.

Example: true
assignmentobject
{
  "ticket_attributes": {
    "_default_title_": "example",
    "_default_description_": "having a problem"
  },
  "state": "submitted",
  "is_shared": true,
  "assignment": {
    "admin_id": "123",
    "assignee_id": "123"
  }
}