Page Comparison

...

Tip

Available from CRM.COM R9.0.0

Deprecated from CRM.COM R18.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:

Include Page

	V4:workflow_rule_request_identifier
	V4:workflow_rule_request_identifier

entity

(mandatory)

String

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

ACCOUNTSRECEIVABLE
ACTIVITIES

SERVICEREQUESTS

JOBS

SUBSCRIPTIONS

REWARDOFFERS

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

Tip
REWARDOFFERS entity available from CRM.COM R11.0.0 LEADS entity available from CRM.COM R14.0.0 ACCOUNTSRECEIVABLE, ADHOCDISCOUNT, CONTACTINFORMATION, CREDITNOTES, INVOICES, INVOICECANCELLATIONS, PAYMENTS, PAYMENTCANCELLATIONS, REFUNDS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R15.0.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

triggered. The supported entities are the following:

ACCOUNTSRECEIVABLE
ACTIVITIES

SERVICEREQUESTS

JOBS

SUBSCRIPTIONS

REWARDOFFERS

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

Tip
REWARDOFFERS entity available from CRM.COM R11.0.0 LEADS entity available from CRM.COM R14.0.0 ACCOUNTSRECEIVABLE, ADHOCDISCOUNT, CREDITNOTES, CONTACTINFORMATION, INVOICES, INVOICECANCELLATIONS, PAYMENTS, PAYMENTCANCELLATIONS, REFUNDS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R15.0.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

Anchor

	workflow rule referred objects
	workflow rule referred objects

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

{
    "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"
        }
    }
}

...

Versions Compared

Old Version 2

New Version Current

Key

Resource URL

Parameters

Restrictions

Response Data