Trigger Contacts
Using this API, you can trigger/add your contacts into custom workflows provided you know the particular trigger's key. You can obtain the trigger key using Get open custom workflows API. At a time, you can add 200 contacts only.
Request type:
- POST
Scope required
- ZohoCampaigns.workflow.CREATE
Request URL
https://campaigns.zoho.com/api/v1.1/workflow/[custom workflowkey]/action/trigger?details={key-value pairs}
Header:
Authorization: Zoho-oauthtoken <access_token>
Content-Type: application/x-www-form-urlencoded
API Limit
- Duration: 5 mins
- Number of Calls: 500
- Lock Period: 30 mins
You can send 500 API calls per 5 minutes. If you hit this limit, you can't use this API for the next 30 minutes due to security reasons, but you can still use other APIs if their lock period hasn’t been reached.
List of parameters -- Version 1.1
| Parameter | Data type | Description |
| details | JSON | It is a JSONObject containing key-value data of the following details:
|
Key-value pair description
| Parameter | Data type | Description |
| lead_email* | String | Enter the contact email addresses |
| triggerkey* | String | Enter the trigger key |
| listkey* | String | Enter the list key |
* - Mandatory parameters
Possible error cases
| Error code | Description |
| 9007 | Mandatory field is not found |
| 9002 | Invalid custom workflow key |
| 9006 | custom workflow is currently inactive |
| 400 | Requested resource cannot be found |
| 9004 | Number of emails exceeded the limit. (limit:200) |
If your error code is not listed above, click here.
Sample request
Copiedhttps://campaigns.zoho.com/api/v1.1/workflow/9bb77af841821fa7767e402a0f250219/action/trigger?details={"lead_email":"patricia@zylker.com,john@zylker.com,joel.raunch@zylker.com","triggerkey":"9bb77af841821fa704a13363331fd551","listkey":"9bb77af841821fa7d765f293a8830994"}Sample Response
Copied{
"code": "200",
"already_triggered": [
"patricia@zylker.com",
"john@zylker.com"
],
"list_key": "9bb77af841821fa7d765f293a8830994",
"ignored_leads": [
"joel.raunch@zylker.com"
],
"list_name": "list3",
"version": "1.1",
"url": "/api/v1.1/workflow/9bb77af841821fa7767e402a0f250219/action/trigger",
"triggered_leads": [],
"status": "success"
}