Documentation is now available for the Fall 2020 Update release!

Activate or deactivate client

This endpoint is used to activate or deactivate a client.

Leave Feedback

URL

POST https://{api-url}/api/v2/tenants/{varId}/clients/{clientId}/{action}

Sample URLs

The action specified in the URL is the action to be performed on the client profile.

To activate a client:

https://{api-url}/api/v2/tenants/msp_6/clients/client_14/activate

To suspend a client:

https://{api-url}/api/v2/tenants/msp_6/clients/client_14/suspend

To terminate a client:

https://{api-url}/api/v2/tenants/msp_6/clients/client_14/terminate

Supported action types

ActionDescription
activateAll clients operations are activated.
suspendDisable the client account and temporarily stop all client operations.
terminateTerminating the client will stop its operations, remove all agents, and uninstall all integrations.

Status code

200 OK

Sample response

Null