Manage And Connect Using APIs

Contact Subscribe

Users can subscribe to a list without using the signup form nor by getting added by a contact. They can subscribe using our API Authentication Token and the user added will be notified.

For public list, you cannot update an already existing contact using API.
However, you can use this API to update your contact details for the existing contacts in the private list.

Request URL:

You've an option of using either the XML (or) JSON format at the time of request.

XML: https://campaigns.zoho.com/api/xml/listsubscribe

JSON: https://campaigns.zoho.com/api/json/listsubscribe

Request Type: Post

Parameters:

Parameter

Data Type

Description

authtoken*
scope*

String
String

API Authentication Token
CampaignsAPI

listkey*

String

List Key to send a subscription mail to contacts

version

String

This will fetch responses based on the current API version

resfmt

String

XML (or) JSON

contactinfo*

XML (or) JSON

Contact email with other fields. Format of this value depends on the request URL.

* - Mandatory Parameters

Sample Request:

XML:

https://campaigns.zoho.com/api/xml/listsubscribe?authtoken=[API Authentication Token]&scope=CampaignsAPI&version=1&resfmt=[XML/JSON]&listkey=[listkey]&contactinfo=<xml><fl val="First Name">mac</fl><fl val="Contact Email">jai@zoho.com</fl></xml>

JSON:

https://campaigns.zoho.com/api/json/listsubscribe?authtoken=[API Authentication Token]&scope=CampaignsAPI&version=1&resfmt=[XML/JSON]&listkey=[listkey]&contactinfo={First Name:mac,Last Name:Last Name,Contact Email:jai@zoho.com}

Sample Response:

Our API response will let you know of the following be it in the XML or JSON format.

XML Format:

<response uri="/api/xml/listsubscribe" version="1">
<code>0</code>
<status>success</status>
<message>A confirmation email is sent to the user. User needs to confirm to successfully subscribe.</message>
</response>

JSON format:

{"message":"A confirmation email is sent to the user. User needs to confirm to successfully subscribe.","status":"success","code":"0","uri":"/api/json/listsubscribe","version":"1"}

Top