Account Freeze and Unfreeze

Description

Allows you to freeze and unfreeze an account in the admin panel.

Request URL

Method: POST

https://example.com/api/v1.1/admin/accounts/freeze - for account freezing

https://example.com/api/v1.1/admin/accounts/unfreeze - for account unfreezing

Request Parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
id	int	1	Yes	Account identifier
frozen_details	JSON object	{ "payment_url": "https://example.com" }	No	Applies only when freezing an account Contains additional parameters for notification customization: payment_url: URL for payment/unlock (will be shown to the user when the account is frozen)

Request Example

JSON

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "id": 7,
  "frozen_details": {
    "payment_url": "https://example.com"
  }
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <id>7</id>
  <frozen_details>
    <payment_url>https://example.com</payment_url>
  </frozen_details>
</xml>

Response Example

JSON

{
  "error": 0,
  "error_text": "Successful operation"
}

XML

<xml>
  <data/>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Response Parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error message text