Latest revision as of 10:28, 20 February 2013

[edit] PUT /accounts/{accountId}

Changes the status of an account. This operation requires elevated permissions.

[edit] Request

PUT /accounts/{accountId}

[edit] Parameters

accountId - string

The Id of the account.

[edit] URI Parameters

None.

[edit] Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

[edit] Request Body

{
  "status": "suspended"
}
 

[edit] Parameters

status - string

The new status of the account. Accepted values are open, closed or suspended.

[edit] Response

[edit] Status Code

204 No Content

Successful account status change

404 Not Found

The account Id was not found.

[edit] Response Body

None.

[edit] 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}

[edit] Parameters

partnerAccountId - string

Partner account Id set via the partner_account_id attribute.

[edit] See also

• Account Management API
• Common Features