Modify status

Description

Activate or deactivate a sub user


 Parameters

Name Data Type Status Description
auth-id Integer Required Authentication parameter
auth-password String Required Authentication parameter
id Integer Required Sub user's ID
status Integer Required 1 for active, 0 for inactive

Return: Array with status and status description.


Errors

When the authentication of API user is not correct, any API request will fail with the following status and statusDescription:

{"status":"Failed","statusDescription":"Invalid authentication, incorrect auth-id or auth-password."}

If the API Sub-User's ID is invalid, the following status will be returned::

{"status":"Failed","statusDescription":"You don't have permission to do that."}/p>

Note: These are example errors in JSON format, and these are not the only errors that can be displayed.


Example

URL JSON: https://api.cloudns.net/sub-users/modify-status.json
POST/GET: auth-id=0&auth-password=password&id=0&status=0

URL XML: https://api.cloudns.net/sub-users/modify-status.xml
POST/GET: auth-id=0&auth-password=password&id=0&status=0


Last modified: 2020-01-13
Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more