POST
Archive a client

Authorizations

x-api-key
string
header
required

An API key from Settings → Developers → API keys in Hiresweep.

Path Parameters

id
string
required

The ID of the client.

Minimum string length: 1

Response

200 - application/json

The archived client.

id
string
required

The ID of the client.

name
string
required
email
string | null
required

Where approval links are emailed, when set.

phone
string | null
required
notes
string | null
required

The operator's own notes about the client.

status
enum<string>
required

Active clients count against the plan's seats; archived ones do not.

Available options:
active,
archived
requireApproval
boolean
required

Whether each application waits on the client's approval before it is sent.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
archivedAt
string<date-time> | null
required
counts
object
required