Subscribe
Users can subscribe to a list without using the signup form or by getting added by another user. They can subscribe using this API and the user added will be notified. Remember that, using this API, you can update your subscriber details for the existing leads in a private list only.
Scope required
- ZohoMarketingAutomation.lead.CREATE
Other alternative scopes
- ZohoMarketingAutomation.lead.CREATE-UPDATE (CREATE + UPDATE)
- ZohoMarketingAutomation.lead.WRITE (CREATE + UPDATE + DELETE)
- ZohoMarketingAutomation.lead.ALL (CREATE + UPDATE + DELETE + READ)
Header:
Authorization: Zoho-oauthtoken <access_token>
Content-Type: application/x-www-form-urlencoded
Request type:
- Post
Request URL
https://marketingautomation.zoho.com/api/v1/json/listsubscribe
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
| Parameter | Data type | Description |
| listkey* | String | List key of the list to which the lead wants to subscribe. |
| resfmt | String | JSON |
| leadinfo* | JSON | Lead email with other fields. |
| sources | String | Lead source can be added. |
| topic_id | String | Topic ID to subscribe topic to leads in the mailing list. You can pass comma separated IDs as well. |
* - Mandatory parameters
Possible error cases
| Error code | Description |
| 2501 | Listkey is empty or invalid. |
| 2004 | Invalid lead email address. |
| 2005 | Group email address added. |
| 2001 | Please enter correct JSON format. |
If your error code is not listed above, click here.
Sample request
Copiedhttps://marketingautomation.zoho.com/api/v1/json/listsubscribe?resfmt=JSON&listkey=[listkey]&leadinfo=%7BFirst+Name%3Amac%2CLast+Name%3ALast+Name%2CLead+Email%3Apatricia%40zoho.com%7D&sources=[sourceName]Sample Response
Copied{
"message": "A confirmation email is sent to the user. User needs to confirm to successfully subscribe.",
"status": "success",
"code": "0",
"uri": "/api/v1/json/listsubscribe",
"version": "1"
}