Process Rules

Returns a list of all workflow rules. If a rule has actions, the actions will be listed under the rule. Can also be used to trigger all workflow rules that are associated with a specified record. The actions for a rule are only fired if the rule’s criteria is met. When using a POST request, if anything fails, the whole transaction is rolled back.

Cross-object workflow rules cannot be invoked using the REST API. When doing POST method invocation, the contextID in the request body must use the 15–character ID.

Syntax

URI

To get a list of the workflow rules or to trigger one or more workflow rules, the URI is: /vXX.X/process/rules/

To get the rules for a particular object: /vXX.X/process/rules/SObjectName

To get the metadata for a particular rule: /vXX.X/process/rules/SObjectName/workflowRuleId

Available since release

30.0

Formats

JSON, XML

HTTP methods

HEAD, GET, POST

Authentication

Authorization: Bearer token

Request parameters

None required

Request body

The request body contains an array of context IDs:

Name	Type	Description
contextId	ID	The ID of the item that is being acted upon.

Examples

• See Get a List of Process Rules.
• See Get a Particular Process Rule.
• See Trigger Process Rules.