Archive a contact
Example Request & Response
- curl
- http
$ curl https://api.intercom.io/contacts/<id>/archive \\\n-X POST \\\n-H 'Authorization:Bearer <Your access token>' \\\n-H 'Accept:application/json'
Example Errors
Contact not found
HTTP/1.1 404 FOUND\n{\n \"type\": \"error.list\",\n \"request_id\": \"9a3d0816-9707-4598-977e-c009ba630148\",\n \"errors\": [\n {\n \"code\": \"not_found\",\n \"message\": \"Contact Not Found\"\n }\n ]\n}\n
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 |