setAccountCheckCredit¶
Request Method: PUT
Description: Account check_credit status
URL: https://api.iovox.com:444/Users?v=3&method=setAccountCheckCredit
The following parameters can be sent in the querystring
Parameter | Description | Default Value | Data Type | Mandatory |
v | API version to use | INTEGER | YES |
Payload¶
The following XML payload must be sent with an setAccountCheckCredit request:
<?xml version="1.0" encoding="utf-8"?>
<request>
<sub_account_name></sub_account_name>
<check_credit></check_credit>
</request>
Payload Description¶
Node Name | Description | Default Value | Data Type | Mandatory |
sub_account_name | the subaccount name | STRING | YES | |
check_credit | check credit status to set | STRING | YES |
Result¶
Error Result¶
HTTP Code | Error String | Resolution |
400 | API Version Empty | Add a value for the v parameter in the query string |
400 | API Version Invalid | Correct v parameter |
400 | Request Method must be PUT. x attempted | Switch request method x to PUT |
400 | XML Empty | Add xml to the request body |
400 | XML parse error. x at line y, column z | Correct XML at point x on line y, column z |
400 | Sub Account Name must be set | sub_account_name is empty, it must be set |
400 | Check Credit must be set to TRUE or FALSE | check_credit is not set or set to a not valid value. It should be TRUE or FALSE |
400 | The provided subAccountName is not valid | The sub account does not exists beneath the main account |
400 | The account must have active subscriptions to set credit check. Create a subscription for this account first. | The sub account exists but does not have a subscription |
500 | Internal Server Error | Retry later |