Get open custom workflows
Open custom workflows will be open to leads moved from different sources (For eg., other custom workflows). Using this API you can get the list of open custom workflows created in your organization.
Request type:
Get
Scope required
ZohoCampaigns.workflow.READ
Request URL
https://campaigns.zoho.com/api/v1.1/workflow?details={key-value pairs}
Header:
Authorization: Zoho-oauthtoken <access_token>
List of parameters -- Version 1.1
Parameter | Data type | Description |
details | JSON | It is a JSONObjectcontaining key-value data of the following details:
|
Key-value pair description
Parameter | Data type | Description |
page | Number | Provide specific page number |
limit | Number | Number of entities per page. |
sort_order | String | ascending or descending (asc/desc) |
user | String | If you want to list triggers created by
|
trigger_type | String | open |
* - Mandatory parameters
Possible error cases
Error code | Description |
9008 | No such trigger exist |
9001 | No custom workflow matches the given criteria |
If your error code is not listed above, click here.
Sample request
Copiedhttps://campaigns.zoho.com/api/v1.1/workflow?details={"page":"1","limit":"5","sort_order":"asc","user":"all","trigger_type":"open"}
Sample response
Copied{
"workflows": [
{
"created_time": "2019-03-11T11:28:34+05:30",
"workflow_key": "9bb77af841821fa7767e402a0f250219",
"triggerkey": "9bb77af841821fa704a13363331fd551",
"workflow_name": "Latestopentrigger"
},
{
"created_time": "2019-03-08T07:53:14+05:30",
"workflow_key": "9bb77af841821fa73ce137c1970c6a55",
"trigger_key": "9bb77af841821fa7011c34c6de7e985f",
"workflow_name": "opentrigger"
}
],
"code": "200",
"limit": 5,
"sortorder": "asc",
"page": 1,
"message": "Success",
"uri": "/api/v1.1/workflow",
"version": "1.1"
}