Archive a contact

Example Request & Response

$ curl https://api.intercom.io/contacts/<id>/archive \
-X POST \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json'

HTTP/1.1 200 OK
{
  "id": "5ba682d23d7cf92bef87bfd4",
  "object": "contact",
  "archived": "true"
}

Example Errors

HTTP/1.1 404 FOUND
{
  "type": "error.list",
  "request_id": "9a3d0816-9707-4598-977e-c009ba630148",
  "errors": [
    {
      "code": "not_found",
      "message": "Contact Not Found"
    }
  ]
}

You can archive a single contact.

Request Path Parameters

Parameter	Type	Required	Description
id	String	Yes	The unique identifier for the contact which is given by Intercom

Response

This will return an object with details on the archived contact.

Attribute	Type	Description
id	String	The unique identifier for the contact which is given by Intercom
object	String	The type of object - `contact`
archived	Boolean	Whether the contact has been archived - `true`