cancelSubscription¶
Request Method: PUT
Description: Cancel a subscription
URL: https://api.iovox.com:444/Subscriptions?v=3&method=cancelSubscription
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 updateContacts request:
Payload Description¶
Node Name | Description | Default Value | Data Type | Mandatory |
sub_account_name | Leave empty for cancel the current API user account, if not empty it should be an account name beneath the current API account | "" | STRING | NO |
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 | Request Empty | Add at least one contact to the request |
400 | The provided sub_account_name is not valid | The provided sub_account_name is not valid |
400 | There are no active subscriptions in this account | There are no active subscriptions in this account |
500 | Internal Server Error | Retry later |