Accounts-accountId:PUT
From Hostway API Documentation
PUT /accounts/{accountId}
Changes the status of an account. This operation requires elevated permissions.
Contents |
Request
PUT /accounts/{accountId}
Parameters
- accountId - string
- The Id of the account.
URI Parameters
None.
Request Headers
- Authorization - HTTP Authorization header [1]
- The Authentication credentials of the client application.
Request Body
{
"status": "suspended"
}
Parameters
- status - string
- The new status of the account. Accepted values are open, closed or suspended.
Response
Status Code
- 204 No Content
- Successful account status change
- 404 Not Found
- The account Id was not found.
Response Body
None.
Alternative with partner Id
As an alternative to using the account Id the client can use a partner-specific Id set via the account attribute partner_account_id. The response to this request is the same as the response to a request using the account Id.
PUT /partnerAccounts/{partnerAccountId}
Parameters
- partnerAccountId - string
- Partner account Id set via the partner_account_id attribute.
See also
