GET workflow_rules/trigger

Available from CRM.COM R9.0.0

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the Workflow Rule

number

(semi-optional)

String

The number of the Workflow Rule

name

(semi-optional)

String

The name of the Workflow Rule

entity

(mandatory)

String

The name of the Entity with which the Workflow Rule is related to . The supported entities are the following:

ACCOUNTSRECEIVABLE
ACTIVITIES
CONTACTINFORMATION
CREDITNOTES
INVOICES
INVOICECANCELLATIONS
JOBS
LEADS
PAYMENTS
PAYMENTCANCELLATIONS
REFUNDS
REWARDOFFERS
SERVICEREQUESTS
SUBSCRIPTIONS
WALLETS
WALLETTRANSACTIONS
WRITEOFFS

REWARDOFFERS entity available from CRM.COM R11.0.0
LEADS entity available from CRM.COM R14.0.0
ACCOUNTSRECEIVABLE, CONTACTINFORMATION, CREDITNOTES, INVOICES, INVOICECANCELLATIONS, PAYMENTS, PAYMENTCANCELLATIONS, REFUNDS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R14.1.0

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:

ACCOUNTSRECEIVABLE
ACTIVITIES
CONTACTINFORMATION
FINANCIALTRANSACTIONS
JOBS
LEADS
REWARDOFFERS
SERVICEREQUESTS
SUBSCRIPTIONS
WALLETS
WALLETTRANSACTIONS

REWARDOFFERS entity available from CRM.COM R11.0.0
LEADS entity available from CRM.COM R14.0.0
ACCOUNTSRECEIVABLE, CONTACTINFORMATION, FINANCIALTRANSACTIONS,WALLETS, WALLETTRANSACTIONS are available from CRM.COM R14.1.0

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

workflow_rule object response data

Name	Type	Description
id	String	The ID of the retrieved workflow rule
alternative_code	String	The alternative code of the retrieved workflow rule
name	String	The name of the retrieved workflow rule
life_cycle_state	String	The life cycle state of the retrieved workflow rule. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "entity": "ACTIVITIES",
        "entity_id": "BCE90B30D846400383759910E7CE5D99",
        "workflow_rule":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "9E8A2D055DBA483F8978E5ACB0DE528B",
            "name": "Activity Rule Low",
            "alternative_code": "ACT_RULE_LOW"
        }
    }
}