Get Workflow Rule Configurations
Purpose
To retrieve the complete configuration metadata details for workflows in any Zoho CRM module. This includes the list of available triggers for the module, the actions supported for each trigger, and their limits and properties. You can use this information to configure Workflow rules using the Configure Workflow Rules API.
Endpoints
- GET /workflow_configurations?module={module_API_name}
Request Details
Request URL
{api-domain}/crm/{version}/workflow_configurations?{module_API_name}
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
ZohoCRM.settings.workflow_rules.ALL
(or)
ZohoCRM.settings.workflow_rules.READ
Parameters
- modulestring, mandatory
Specify the API name of the module whose workflow configuration metadata you want to retrieve.
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v8/workflow_configurations?module=Leads"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GETResponse JSON
- workflow_configurationsJSON object
Contains workflow configuration metadata details for the module.
- triggersJSON array
Lists the triggers supported for the module, along with supported actions and whether scheduled actions are allowed or not.
- api_namestring
Represents the API name of the trigger type.
- namestring
Represents the name of the trigger type.
- deprecatedBoolean
Indicates if the trigger type is deprecated or not.
- scheduled_actions_supportedBoolean
Indicates if scheduled actions are supported for the trigger.
- actionsJSON array
Contains the list of supported actions for the trigger.
- actionsJSON array
Contains the list of actions supported for the module, along with limits and other details.
- api_namestring
Represents the API name of the action type.
- namestring
Represents the name of the action type.
- supported_in_scheduled_actionBoolean
Indicates if the action is supported as a scheduled action.
- limitinteger
Indicates the maximum number of times this action type can be added in the instant and scheduled actions of a workflow. For instance, if the value of limit is 5, you can add up to 5 instances to the instant actions section, and up to 5 instances to the scheduled actions section of the same workflow rule.
- limit_per_actionnumber
Specifies the limit within a single action, if applicable. For instance, for add_tags or remove_tags, you can include up to 10 tags in one action. So the value for limit_per_action for those actions will be 10.
- associate_actionBoolean
Indicates whether the action can be created once and associated with multiple Workflow rules, or if it must be created specifically for each Workflow rule.
- is_clickableBoolean
Indicates whether the action can be clicked and edited from the workflow configuration page in the UI.
- related_triggers_detailsJSON array
Lists the triggers supported in related modules, if any.
- api_namestring
Represents the API name of the related module.
- moduleJSON object
Contains the details of the related module including its API name and unique ID.
- namestring
Name of the trigger.
- triggersJSON object
Lists all the triggers that are supported in the related module.
- api_namestring
Represents the API name of the trigger.
- namestring
Name of the trigger.
- deprecatedBoolean
Indicates whether the trigger is deprecated.
- scheduled_actions_supportedBoolean
Indicates whether scheduled actions are supported for this trigger.
- actionsJSON array
Contains the list of supported action types for this trigger.
Possible Errors
- 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. - REQUIRED_PARAM_MISSINGHTTP 400
A required parameter is missing in the request.
Resolution: The details object in the response contains information about the missing parameter. Ensure all required and dependent parameters are included. Refer to the Parameters section for details. - INVALID_MODULEHTTP 400
You have specified an invalid value for the module parameter.
Resolution: Specify a valid module API name. - 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. - 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.
Sample Response
Copied{
"workflow_configurations": {
"related_triggers_details": [
{
"api_name": "Notes",
"module": {
"singular_label": "Note",
"plural_label": "Notes",
"api_name": "Notes",
"name": "Notes",
"id": "4876876000000002197"
},
"name": "Notes",
"triggers": [
{
"api_name": "create",
"deprecated": false,
"name": "Create",
"scheduled_actions_supported": true,
"actions": [
"add_tags",
"remove_tags",
"email_notifications",
"tasks",
"create_record",
"add_meeting",
"schedule_call",
"webhooks",
"functions"
]
},
{
"api_name": "create_or_edit",
"deprecated": false,
"name": "CreateorEdit",
"scheduled_actions_supported": true,
"actions": [
"add_tags",
"remove_tags",
"email_notifications",
"tasks",
"create_record",
"add_meeting",
"schedule_call",
"webhooks",
"functions"
]
},
{
"api_name": "edit",
"deprecated": false,
"name": "Edit",
"scheduled_actions_supported": true,
"actions": [
"add_tags",
"remove_tags",
"email_notifications",
"tasks",
"create_record",
"add_meeting",
"schedule_call",
"webhooks",
"functions"
]
},
{
"api_name": "delete",
"deprecated": false,
"name": "Delete",
"scheduled_actions_supported": false,
"actions": [
"email_notifications",
"webhooks",
"functions"
]
}
]
}
],
"triggers": [
{
"api_name": "create",
"deprecated": false,
"name": "Create",
"scheduled_actions_supported": true,
"actions": [
"field_updates",
"assign_owner",
"add_tags",
"remove_tags",
"email_notifications",
"tasks",
"create_record",
"add_meeting",
"schedule_call",
"convert",
"webhooks",
"functions",
"circuits"
]
},
{
"api_name": "create_or_edit",
"deprecated": false,
"name": "CreateorEdit",
"scheduled_actions_supported": true,
"actions": [
"field_updates",
"assign_owner",
"add_tags",
"remove_tags",
"email_notifications",
"tasks",
"create_record",
"add_meeting",
"schedule_call",
"convert",
"webhooks",
"functions",
"circuits"
]
},
{
"api_name": "edit",
"deprecated": false,
"name": "Edit",
"scheduled_actions_supported": true,
"actions": [
"field_updates",
"assign_owner",
"add_tags",
"remove_tags",
"email_notifications",
"tasks",
"create_record",
"add_meeting",
"schedule_call",
"convert",
"webhooks",
"functions",
"circuits"
]
},
{
"api_name": "field_update",
"deprecated": false,
"name": "FieldUpdate",
"scheduled_actions_supported": true,
"actions": [
"field_updates",
"assign_owner",
"add_tags",
"remove_tags",
"email_notifications",
"tasks",
"create_record",
"add_meeting",
"schedule_call",
"convert",
"webhooks",
"functions",
"circuits"
]
},
{
"api_name": "section_update",
"deprecated": false,
"name": "SectionUpdate",
"scheduled_actions_supported": true,
"actions": [
"field_updates",
"assign_owner",
"add_tags",
"remove_tags",
"email_notifications",
"tasks",
"create_record",
"add_meeting",
"schedule_call",
"convert",
"webhooks",
"functions",
"circuits"
]
},
{
"api_name": "delete",
"deprecated": false,
"name": "Delete",
"scheduled_actions_supported": false,
"actions": [
"email_notifications",
"webhooks",
"functions",
"circuits"
]
},
{
"api_name": "date_or_datetime",
"deprecated": false,
"name": "DateBased",
"scheduled_actions_supported": true,
"actions": [
"field_updates",
"assign_owner",
"add_tags",
"remove_tags",
"email_notifications",
"tasks",
"create_record",
"webhooks",
"functions",
"circuits"
]
},
{
"api_name": "score_increase",
"deprecated": false,
"name": "ScoreIncrease",
"scheduled_actions_supported": false,
"actions": [
"field_updates",
"assign_owner",
"add_tags",
"remove_tags",
"email_notifications",
"tasks",
"webhooks",
"functions",
"circuits"
]
},
{
"api_name": "score_decrease",
"deprecated": false,
"name": "ScoreDecrease",
"scheduled_actions_supported": false,
"actions": [
"field_updates",
"assign_owner",
"add_tags",
"remove_tags",
"email_notifications",
"tasks",
"webhooks",
"functions",
"circuits"
]
},
{
"api_name": "score_update",
"deprecated": false,
"name": "ScoreUpdate",
"scheduled_actions_supported": false,
"actions": [
"field_updates",
"assign_owner",
"add_tags",
"remove_tags",
"email_notifications",
"tasks",
"webhooks",
"functions",
"circuits"
]
},
{
"api_name": "rollup_summary_update",
"deprecated": false,
"name": "RollupSummaryUpdate",
"scheduled_actions_supported": false,
"actions": [
"field_updates",
"assign_owner",
"add_tags",
"remove_tags",
"tasks",
"create_record",
"email_notifications",
"webhooks",
"functions"
]
}
],
"actions": [
{
"is_clickable": true,
"associate_action": true,
"limit_per_action": null,
"api_name": "field_updates",
"supported_in_scheduled_action": true,
"name": "Fieldupdate",
"limit": 5
},
{
"is_clickable": true,
"associate_action": true,
"limit_per_action": null,
"api_name": "email_notifications",
"supported_in_scheduled_action": true,
"name": "Alert",
"limit": 5
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "create_record_email",
"supported_in_scheduled_action": true,
"name": "emailcreaterecord",
"limit": 1
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "assign_owner",
"supported_in_scheduled_action": true,
"name": "AssignOwner",
"limit": 3
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": 10,
"api_name": "add_tags",
"supported_in_scheduled_action": true,
"name": "AddTags",
"limit": 1
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": 10,
"api_name": "remove_tags",
"supported_in_scheduled_action": true,
"name": "RemoveTags",
"limit": 1
},
{
"is_clickable": true,
"associate_action": true,
"limit_per_action": null,
"api_name": "sms",
"supported_in_scheduled_action": true,
"name": "SMS",
"limit": 3
},
{
"is_clickable": true,
"associate_action": true,
"limit_per_action": null,
"api_name": "whatsapp",
"supported_in_scheduled_action": true,
"name": "WhatsApp",
"limit": 3
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "slack_notifications",
"supported_in_scheduled_action": true,
"name": "Slack",
"limit": 5
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "cliq_notifications",
"supported_in_scheduled_action": true,
"name": "Cliq",
"limit": 5
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "cisco_notifications",
"supported_in_scheduled_action": true,
"name": "CiscoTeams",
"limit": 5
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "google_chat_notifications",
"supported_in_scheduled_action": true,
"name": "GoogleChat",
"limit": 5
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "microsoft_teams_notifications",
"supported_in_scheduled_action": true,
"name": "MicrosoftTeams",
"limit": 5
},
{
"is_clickable": true,
"associate_action": true,
"limit_per_action": null,
"api_name": "tasks",
"supported_in_scheduled_action": true,
"name": "Task",
"limit": 5
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "create_record",
"supported_in_scheduled_action": true,
"name": "CreateRecord",
"limit": 1
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "create_connected_record",
"supported_in_scheduled_action": true,
"name": "CreateConnectedRecord",
"limit": 1
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "add_meeting",
"supported_in_scheduled_action": false,
"name": "AddMeeting",
"limit": 1
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "schedule_call",
"supported_in_scheduled_action": true,
"name": "ScheduleCall",
"limit": 1
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "convert",
"supported_in_scheduled_action": false,
"name": "Convert",
"limit": 1
},
{
"is_clickable": true,
"associate_action": true,
"limit_per_action": null,
"api_name": "webhooks",
"supported_in_scheduled_action": true,
"name": "Webhook",
"limit": 1
},
{
"is_clickable": true,
"associate_action": true,
"limit_per_action": null,
"api_name": "functions",
"supported_in_scheduled_action": true,
"name": "Deluge",
"limit": 1
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "comment_to_post",
"supported_in_scheduled_action": true,
"name": "CommentToPost",
"limit": 1
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "reply_to_comment",
"supported_in_scheduled_action": true,
"name": "ReplyToComment",
"limit": 1
},
{
"is_clickable": false,
"associate_action": false,
"limit_per_action": null,
"api_name": "like_to_comment",
"supported_in_scheduled_action": true,
"name": "LikeToComment",
"limit": 1
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "reply_to_message",
"supported_in_scheduled_action": true,
"name": "ReplyToMessage",
"limit": 1
},
{
"is_clickable": false,
"associate_action": false,
"limit_per_action": null,
"api_name": "retweet",
"supported_in_scheduled_action": true,
"name": "Retweet",
"limit": 1
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "reply_to_tweet",
"supported_in_scheduled_action": true,
"name": "ReplyToTweet",
"limit": 1
},
{
"is_clickable": false,
"associate_action": false,
"limit_per_action": null,
"api_name": "circuits",
"supported_in_scheduled_action": true,
"name": "Circuits",
"limit": 1
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "flow",
"supported_in_scheduled_action": true,
"name": "Flow",
"limit": 1
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "PushToDIProcess",
"supported_in_scheduled_action": false,
"name": "PushToDIProcess",
"limit": 1
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "external_share_record",
"supported_in_scheduled_action": true,
"name": "ExternalShareRecord",
"limit": 1
},
{
"is_clickable": true,
"associate_action": false,
"limit_per_action": null,
"api_name": "external_unshare_record",
"supported_in_scheduled_action": true,
"name": "ExternalUnshareRecord",
"limit": 1
}
]
}
}