Get the Rules of a Connected Workflow

Parameters

• modulestring, mandatory

  Specify the API name of the module for which the rules must be retrieved. 

Response JSON

The response contains a rules array which contains the list of rules configured for the specified module in the connected workflow. Each rule object contains:

• idstring

  Unique ID of the rule in the connected workflow.

• moduleJSON object

  Represents the module to which the rule belongs. The module object contains the module API name and the ID of the module.

• execute_whenJSON object

  Represents the trigger configuration that determines when the rule is executed.

  • typestring

    Represents the type of trigger for rule.

  • detailsJSON object

    Contains the detailed information about the trigger, including the criteria and the trigger module.

    • trigger_moduleJSON object

      Represents the module that triggers this rule. This object contains the module API name and the unique ID of the trigger module.

    • criteriaJSON object

      Represents the field based criteria that must be satisfied for the rule to execute. Please note that this doesn't include any module based or other module criteria based on which the trigger executes.

      The criteria object contains the details of the field, the comparator, the value against which it is to be compared, and the type of value.

    • repeatBoolean

      Indicates whether the rule should repeat execution based on the trigger type.
      Behavior by trigger type:
      - field_update: If true, the rule executes every time the specified field is updated; if false, it executes only on the first update.
      - edit: If true, the rule executes on every edit; if false, only on the first edit.
      - create_or_edit: If true, the rule executes on create and every edit; if false, only on create or first edit.

• sourcestring

  Represents the source of the rule creation. 
  Possible values: crm

Possible Errors

• INVALID_DATAHTTP 400

  The given ID seems to be invalid
  Resolution: Provide a valid connected workflow ID in the request URL.

• INVALID_MODULEHTTP 400

  The value provided to the param is Invalid
  Resolution: Provide a valid module API name as the module parameter value.

• REQUIRED_PARAM_MISSINGHTTP 400

  Required param not found
  Resolution: Specify the module parameter in the request URL, with a valid value.

• FEATURE_NOT_SUPPORTEDHTTP 400

  Your edition doesn't support this feature
  Resolution: Upgrade the account to Standard, Professional, Enterprise, or Ultimate edition and then retry the request.

• INVALID_REQUEST_METHODHTTP 400

  The http request method type is not a valid one
  Resolution: This API supports only the GET method. Retry the request using the GET method.

• OAUTH_SCOPE_MISMATCHHTTP 401

  Unauthorized
  Resolution: Client does not have the required OAUTH SCOPE. Create a new token with valid scope. Refer to the Scope section for more details.

• AUTHENTICATION_FAILUREHTTP 401

  Authentication failed
  Resolution: Pass a valid access token along the request to authenticate.

• NO_PERMISSIONHTTP 403

  Permission denied
  Resolution: Ensure that the user making the API call has the Manage Automation or Connected Workflow permission enabled in their CRM profile, and then retry the request.

• INVALID_URL_PATTERNHTTP 404

  Please check if the URL trying to access is a correct one
  Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section for more details.

• INTERNAL_ERRORHTTP 500

  Internal Server Error
  Resolution: Unexpected and unhandled exception in Server. Contact support team.