| Tip |
|---|
Available from CRM.COM R9.0.0 |
| Excerpt |
|---|
This method returns information related with alerts having specific attributes. Multiple alerts are returned by each call. |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| recipient_identifier (semi-optional) | Recipient Identifier | The identifier of the recipient related with the alerts that should be returned as a result. The allowed recipient identifier fields are the following:
| ||||||
alert_definition_identifier (semi-optional) | Alert Definition Identifier | The identifier of the alert definition related with the alerts that should be returned as a result. The allowed alert definition identifier fields are the following:
| ||||||
workflow_rule_identifier (semi-optional) | Workflow Rule Identifier | The identifier of the workflow rule that triggered the alerts that should be returned as a result. The allowed workflow rule identifier fields are the following:
| ||||||
entity (semi-optional) | String | The name of the entity related with the alerts that should be returned as a result. The supported entities are the following:
| ||||||
entity_id (semi-optional) | String | The ID of the entity related with the alerts that should be returned as a result | ||||||
recipient_email_address (optional) | String | The email address of the recipient related with the alerts that should be returned as a result | ||||||
recipient_phone_number (optional) | String | The phone number of the recipient related with the alerts that should be returned as a result | ||||||
life_cycle_state (optional) | String | The life cycle state of the alerts that should be returned as a result. The supported options are SUCCESSFUL or REJECTED | ||||||
created_date (optional) | Date | The created date of the alerts that should be returned as a result. | ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||
fields_set | 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 |
...