Intercom API (unofficial showcase)
POST/conversations/attributes/{id}/options

Add an option to a conversation attribute

Adds an option to a list-type conversation attribute. Provide label for the new option; the response includes the full attribute with its updated options.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 1 body field
idintegerrequired
The ID of the list-type conversation attribute to add an option to.
Intercom-Versionstringoptional
The API version to use. Defaults to 2.17 when omitted; supported versions include 1.0–1.4 and 2.0–2.6.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

The label for the option to add.

labelstringrequired
The label for the new option.

4 status codes
200Returns the full conversation attribute with the new option included in its options array.
typestringoptional
Value is `conversation_attribute`.
Allowed:conversation_attribute
idintegeroptional
The unique identifier for the conversation attribute.
namestringoptional
Name of the attribute.
descriptionstringoptional
Readable description of the attribute.
data_typestringoptional
Allowed:string
requiredbooleanoptional
Whether this attribute is required.
visible_to_team_idsarray<string>optional
Team IDs that can see this attribute. Empty array means all teams.
archivedbooleanoptional
Whether this attribute is archived.
created_atintegeroptional
The time the attribute was created as a UTC Unix timestamp.
updated_atintegeroptional
The time the attribute was last updated as a UTC Unix timestamp.
admin_idstringoptional
ID of the admin who created the attribute.
multilinebooleanoptional
Whether this string attribute is multiline.
401Returned when the request is unauthenticated.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the conversation attribute is not found.

One documented failure

  • conversation_attribute_not_found

    Conversation attribute not found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
422Returned when the option request cannot be processed.

One documented failure

  • parameter_invalid

    Options can only be managed on list attributes

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthenticated, a 404 is returned when the conversation attribute is not found, and a 422 is returned when the option cannot be added. The id path parameter must identify a list-type attribute, and label is required.