Home
/
REST API Reference
/
Contacts
/
Archive contact

Archive contact

You can archive a single contact.

SecurityHTTP: bearerAuth
Request
path Parameters
id
required
string

id

Example: 63a07ddf05a32042dffac965
header Parameters
Intercom-Version
string (intercom_version)
Default: 2.10

Intercom API version.
By default, it's equal to the version set in the app package.

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "Unstable"
Example: 2.10
post
/contacts/{id}/archive
Request samples
Responses
200
successful
Response Schema: application/json
type
string 
always contact
 Value: "contact"  
id
string 
The unique identifier for the contact which is given by Intercom.
 
external_id
string or null 
The unique identifier for the contact which is provided by the Client.
 
archived
boolean 
Whether the contact is archived or not.
 
Response samples
application/json
{
"id": "660e72e06abd01bd27af6173",
"external_id": "70",
"type": "contact",
"archived": true
}