Skip to main content
POST
Update client status
Deprecated: This is a v1 endpoint and is deprecated. Please use the v2 API instead. v1 endpoints will be removed in a future release.
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Body

application/json
client_ids
string<uuid>[]

Array of client IDs to update. Refer to Getting the Client ID section for detailed instructions.

status
enum<string>

New status for the client.

Available options:
active,
archived

Response

204

OK - Request succeeded