Archive Contact — POST /v1/contacts/{contactId}/archive

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

POST https://api.cleo-pay.com/v1/contacts/{contactId}/archive

Authentication

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

Authorization: Bearer <token>

Path Parameters

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".

string

Unique identifier for the contact.

string

The contact type: payee or business.

string

The contact’s updated status. Will be archived.

string | null

The contact’s display name.

string[]

Email addresses associated with the contact.

string | null

Phone number for the contact.

string

Allowed payment direction: bidirectional, can_pay, can_be_paid, or none.

number | null

Net payment terms in days, if configured.

object | null

Summary of the contact’s linked bank account.

Show bankAccount fields

string

Last four digits of the bank account number.

object | null

Tax information for the contact.

Show taxInfo fields

string | null

Legal name associated with the tax ID.

string | null

Type of tax ID: ein or ssn.

string | null

Last four digits of the tax ID.

boolean

Whether this contact can currently receive payments.

datetime

ISO 8601 timestamp of when the contact was created.

datetime | null

ISO 8601 timestamp of the most recent update.

datetime | null

ISO 8601 timestamp of when the contact was archived. Populated upon successful archival.

Example Request

curl

curl --request POST \
  --url "https://api.cleo-pay.com/v1/contacts/cnt_01hq1z2k3m4n5p6q7r8s9t0u/archive" \
  --header "Authorization: Bearer <token>"

Example Response

200

{
  "id": "cnt_01hq1z2k3m4n5p6q7r8s9t0u",
  "type": "payee",
  "status": "archived",
  "displayName": "Acme Supplies LLC",
  "emails": ["billing@acmesupplies.com"],
  "phone": "+15550001234",
  "paymentDirection": "can_be_paid",
  "netTerms": 30,
  "bankAccount": {
    "last4": "7890"
  },
  "taxInfo": {
    "legalName": "Acme Supplies LLC",
    "taxIdType": "ein",
    "taxIdMask": "6789"
  },
  "paymentReady": false,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-04-10T11:00:00Z",
  "archivedAt": "2024-04-10T11:00:00Z"
}

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.

Payables

Bank Accounts

Contacts

Payments

Archive Contact — POST /v1/contacts/{contactId}/archive

Base URL

Authentication

Path Parameters

Request Body

Response

Example Request

Example Response

​Base URL

​Authentication

​Path Parameters

​Request Body

​Response

​Example Request

​Example Response

Base URL

Authentication

Path Parameters

Request Body

Response

Example Request

Example Response