Using APIs

Using Authentication Token

To access any of our API methods, authentication is mandatory which will be passed to us through our authentication parameter namely "authtoken".

Authentication Parameters

In order to retrieve and push your data in a secure manner, two mandatory parameters are to be used while using APIs.

  • authtoken* - API Authentication Token.
  • scope*

Generate Authentication Token

Every account will carry a general authtoken for the account's API access. Follow the below steps to retrieve your authtoken.

  1. Go to Settings module --> API & Call Back
  2. Copy the API Authentication Token.

Generate List Key

To access list management API methods, in addition to your authentication parameters, a mandatory parameter "listkey" is to be used. The listkey represents the mailing list you're trying to access.

  1. Go to Contacts module --> Mailing Lists
  2. subtab.
  3. In Mailing Lists page, click the Mailing list, you'd like to generate the list key.
  4. Go to List Tools subtab.
  5. Copy the List key.

Note 

  • Follow what is given in this document, keys are sensitive
  • Default responses will always be in XML format.
  • HTTP instead of HTTPS in the request URL is not supported.
  • Custom fields in the request URL can be declared with the field itself.
  • During list subscription, If custom field value limit exceeds, the field will not be recorded even though the contact will be subscribed to the list(s).
  • To subscribe or unsubscribe to and from a list, email address is mandatory.
  • Finally, make sure APIs are not misused. We hold the rights to disable your API access.
  • Avoid any kind of typo, it could result in an error.

For further assistance, please contact us at support@zohocampaigns.com

Top