Intercom API (unofficial showcase)
POST/contacts/{contact_id}/archive

Archive a contact

Archives a single contact. Supply the contact_id of the contact to archive. The response includes the contact reference and an archived flag.

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

2 parameters
contact_idstringrequired
The unique identifier of the contact to archive.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

1 status code
200Returns the contact reference and an `archived` flag indicating whether the contact is archived.
archivedbooleanoptional
Whether the contact is archived or not.
typestringoptional
always contact
Allowed:contact
idstringoptional
The unique identifier for the contact which is given by Intercom.
external_idstringoptional
The unique identifier for the contact which is provided by the Client.

Error handling

The contact_id path parameter must identify the contact to archive.