Skip to main content
Use this endpoint to archive a contact. Archiving sets the contact’s status to archived and hides it from the default results of GET /v1/contacts. Archived contacts can be retrieved by filtering with status=archived and can be restored to active status at any time using the unarchive endpoint.

​
Base URL

​
Authentication

All requests must include a Bearer token in the Authorization header.

​
Path Parameters

​
contactId
string
required
The unique identifier of the contact to archive.

​
Request Body

This endpoint does not accept a request body.

​
Response

Returns the updated Contact object with HTTP status 200 OK and status: "archived".
​
id
string
Unique identifier for the contact.
​
type
string
The contact type: payee or business.
​
status
string
The contact’s updated status. Will be archived.
​
displayName
string | null
The contact’s display name.
​
emails
string[]
Email addresses associated with the contact.
​
phone
string | null
Phone number for the contact.
​
paymentDirection
string
Allowed payment direction: bidirectional, can_pay, can_be_paid, or none.
​
netTerms
number | null
Net payment terms in days, if configured.
​
bankAccount
object | null
Summary of the contact’s linked bank account.
​
taxInfo
object | null
Tax information for the contact.
​
paymentReady
boolean
Whether this contact can currently receive payments.
​
createdAt
datetime
ISO 8601 timestamp of when the contact was created.
​
updatedAt
datetime | null
ISO 8601 timestamp of the most recent update.
​
archivedAt
datetime | null
ISO 8601 timestamp of when the contact was archived. Populated upon successful archival.

​
Example Request

curl

​
Example Response

200
Archiving is not the same as revoking. An archived contact has been intentionally hidden from your active contact list and can be restored using POST /v1/contacts/{contactId}/unarchive. A revoked contact has had its access removed by Cleo Pay and cannot be restored through the API.
Use archiving to keep your active contact list clean without permanently deleting contact records. Archived contacts — and their associated payable history — remain accessible when filtered explicitly.