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

Archive a conversation attribute option

Archives an option on a list-type conversation attribute without removing it. Use id and option_id to identify the attribute and option; the response retains the option with archived: true and includes the updated options array.

3 parameters
idintegerrequired
The conversation attribute ID containing the option to archive.
option_idstringrequired
The UUID of the list option to archive, taken from its `id` field in the options array.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted; use a supported version.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

4 status codes
200Returns the full conversation attribute with the updated options array; the archived option remains present with `archived: true`.
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 unauthorized.

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 or option 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 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 unauthorized. A 404 is returned when the conversation attribute or option is not found, and a 422 is returned when the request cannot be processed. The id path parameter identifies the conversation attribute, and option_id identifies the option to archive.