Skip to main content
PATCH
Archive or unarchive a client

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Path Parameters

clientId
string
required

The clientId.

Body

application/json

Archive or unarchive a client (subaccount). When unarchiving, the agency's maxActiveClients limit is enforced.

archived
boolean
required

true to archive the client (hide from the agency dashboard), false to unarchive.

Response

Client archive status updated.

Standard success acknowledgement returned by the agency mutation endpoints. The use-case returns { success: true } and the route wraps it as { data: { success: true } }.

data
object
required