P
ProFormsDocs

Delete Client

Archive, restore, or permanently delete a client. Archiving is the default soft-delete.

Archive Client

Toggle a client's archived status. Calling this on an active client archives it; calling it on an archived client restores it.

clients.edit
POST/v1/clients/:id/archive

Example Request

curl
curl -X POST "https://proforms.io/api/v1/clients/c_abc123/archive" \
  -H "Authorization: Bearer pf_your_api_key"

Response

200 OK
{
  "success": true,
  "data": {
    "id": "c_abc123",
    "isArchived": true,
    "archivedAt": "2026-02-17T14:30:00.000Z"
  }
}

Restore Client

Explicitly restore an archived client back to active status.

clients.edit
POST/v1/clients/:id/restore

Example Request

curl
curl -X POST "https://proforms.io/api/v1/clients/c_abc123/restore" \
  -H "Authorization: Bearer pf_your_api_key"

Response

200 OK
{
  "success": true,
  "data": {
    "id": "c_abc123",
    "isArchived": false
  }
}

Permanent Delete

Permanently delete a client. All assigned sites are unlinked (their clientId is set to null) but not deleted.

clients.delete
DELETE/v1/clients/:id/permanent-delete

Example Request

curl
curl -X DELETE "https://proforms.io/api/v1/clients/c_abc123/permanent-delete" \
  -H "Authorization: Bearer pf_your_api_key"

Response

200 OK
{
  "success": true,
  "data": {
    "deleted": true
  }
}
⚠️
Permanent deletion cannot be undone. Sites assigned to the client will be unlinked but preserved. Use archive for a reversible soft-delete.