| Tip |
|---|
Available from CRM.COM R9.0.0 Deprecated from CRM.COM R17R18.0.0 |
| Excerpt |
|---|
This method triggers an existing Workflow Rule. Only one Workflow rule can be triggered in each call. |
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| workflow_rule_identifier (mandatory) | Workflow Rule Identifier | The identifier of the Workflow Rule that should be triggered. The allowed Workflow Rule request identifier fields are the following:
| ||||||
entity (mandatory) | String | The name of the Entity with which the Workflow Rule is related to . The supported entities are the following:
| ||||||
entity_id (mandatory) | String | The ID of the entity instance for which the Workflow Rule is enforced to be triggered. | ||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description | ||
|---|---|---|---|---|
entity | String | The name of the Entity for which the Workflow Rule was triggered. The supported entities are the following:
| ||
entity_id | String | The ID of the entity for which the Workflow Rule was triggered | ||
| workflow_rule | Workflow rule Object | The Workflow Rule which was enforced to be triggered |
Anchor workflow rule referred objects workflow rule referred objects
...