Trigger Leads

Using this API, you can trigger/add your leads into journeys provided you know the particular trigger's key. You can obtain the trigger key using Get Open Journeys API. At a time, you can add 200 leads only.

Scope required

  • ZohoMarketingAutomation.journey.CREATE

Header:

Authorization: Zoho-oauthtoken <access_token>

Content-Type: application/x-www-form-urlencoded

Request type:

  • POST

Request URL

https://marketingautomation.zoho.com/api/v1/journeys/[journeykey]/action/trigger?details={key-value pairs}

API Limit

  • Duration: 5 mins
  • Number of Calls: 100
  • Lock Period: 30 mins

You can send 100 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

ParameterData typeDescription
detailsJSON

It is a JSONObject containing key-value data of the following details:

  • lead_email
  • triggerkey
  • listkey

 

Key-value pair description

ParameterData typeDescription
lead_email*StringEnter the lead email addresses
triggerkey*StringEnter the trigger key
listkey*StringEnter the list key

* - Mandatory parameters

Possible error cases

Error codeDescription
9007Mandatory field is not found
9002Invalid journey key
9006Journey is currently inactive
400Requested resource cannot be found
9004Number of emails exceeded the limit. (limit:200)

If your error code is not listed above, click here.

Sample request

Copiedhttps://marketingautomation.zoho.com/api/v1/journeys/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",
    "url": "/api/v1/journeys/9bb77af841821fa7767e402a0f250219/action/trigger",
    "triggered_leads": [],
    "status": "success"
}