Restore Contact — POST /v1/contacts/{contactId}/unarchive

Use this endpoint to restore an archived contact to active status. Once unarchived, the contact will appear again in the default results of GET /v1/contacts and can be used in new payments.

Base URL

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

Authentication

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

Authorization: Bearer <token>

Path Parameters

contactId

string

required

The unique identifier of the contact to restore.

Request Body

This endpoint does not accept a request body.

This endpoint only works for contacts with status: "archived". Contacts with status: "revoked" cannot be restored through the API. Attempting to unarchive a revoked contact will return an error.

Response

Returns the updated Contact object with HTTP status 200 OK and status: "active".

string

Unique identifier for the contact.

type

string

The contact type: payee or business.

status

string

The contact’s updated status. Will be active.

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.

Show bankAccount fields

last4

string

Last four digits of the bank account number.

taxInfo

object | null

Tax information for the contact.

Show taxInfo fields

legalName

string | null

Legal name associated with the tax ID.

taxIdType

string | null

Type of tax ID: ein or ssn.

taxIdMask

string | null

Last four digits of the tax ID.

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 this update.

archivedAt

datetime | null

Will be null after a successful unarchive.

Example Request

curl

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

Example Response

200

{
  "id": "cnt_01hq1z2k3m4n5p6q7r8s9t0u",
  "type": "payee",
  "status": "active",
  "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": true,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-04-10T14:30:00Z",
  "archivedAt": null
}

After unarchiving, the contact’s archivedAt field is reset to null and the contact resumes appearing in the default results of GET /v1/contacts.

Payables

Bank Accounts

Contacts

Payments

Restore Contact — POST /v1/contacts/{contactId}/unarchive

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