...
...
| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
GET subscriptions/actions/get_scheduled
This method returns the subscription action which are scheduled to be executed in the system. Multiple subscription action types are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
subscription_identifier (mandatory) | Subscription Identifier | The identifier of the subscription related with the actions that will be retrieved. The allowed subscription identifier fields are the following:
| ||||||
behavior_code (optional) | String | The behavior code of the subscription actions that will be retrieved. If specified then only actions having the specified behavior code will be retrieved. The supported behavior codes are the following:
| ||||||
business_classification_code (optional) | String | The business classification code of the subscription actions that will be retrieved along with the action type. If specified then only actions having the specified business classification code will be retrieved. The supported business classification codes, per behavior code are the following:
|
...
| ||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
POST subscriptions/actions/cancel
It This method cancels a scheduled action. This web API method can be used only on actions which are in a scheduled life cycle state. A single subscription action can be cancelled by each call
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
subscription_action_identifier (mandatory) | Subscription Action identifier | The subscription action to be cancelled. The allowed subscription action identifier fields are the following:
|
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|