Add New List and Contacts

Using this API, you can add new list and contacts in the list without having to do this manually in the product UI.

Request Type

  • Post

Scope required

  • ZohoCampaigns.contact.CREATE

    Other alternative scopes

    • ZohoCampaigns.contact.CREATE-UPDATE (CREATE + UPDATE)
    • ZohoCampaigns.contact.WRITE (CREATE + UPDATE + DELETE)
    • ZohoCampaigns.contact.ALL (CREATE + UPDATE + DELETE + READ)

    Header:

    Authorization: Zoho-oauthtoken <access_token>

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

    Request URL

    https://campaigns.zoho.com/api/v1.1/addlistandcontacts

    List of Parameters -- Version 1.1

    Parameter

    Data Type

    Description

    resfmt

    String

    XML (or) JSON

    emailids*

    String

    Provide maximum of ten (10) EMAILID's comma (,) separately.

    listname*

    String

    Provide your list name.

    signupform*

    String

    public/private.

    mode*

    String

    newlist

    listdescription

    String

    Provide a description for your list.

    * - Mandatory Parameters

    Possible error cases

    Error code Description
    903Mandatory fields are missing.
    2205 Duplicate list name is found.
    2206List has been deleted.
    2302You cannot add contacts as you've reached the maximum limit. 

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

    Sample XML Request

    Copiedhttps://campaigns.zoho.com/api/v1.1/addlistandcontacts?resfmt=XML&listname=[give ur list name]&signupform=[public/private]&mode=newlist&listdescription=[give your list description]&emailids=[email addresses]

    Sample Response

    Copied<?xml version="1.1" encoding="UTF-8" standalone="no"?>
    <response uri="/api/v1.1/addlistandcontacts" version="1.1">
    	<code>0</code>
    	<status>success</status>
    	<listkey>f70c4878c4a471692bb9a99a2d5ed3a7</listkey>
    	<listname>1issst11deed88</listname>
    </response> 

    Sample JSON Request

    Copiedhttps://campaigns.zoho.com/api/v1.1/addlistandcontacts?resfmt=JSON&listname=[give ur list name]&signupform=[public/private]&mode=newlist&listdescription=[give your list description]&emailids=[email addresses]

    Sample Response

    Copied{
      "status": "success",
      "listkey": "f70c4878c4a471691e3931dd52bedc79",
      "code": "0",
      "url": "/api/v1.1/addlistandcontacts",
      "listname": "1issst1oo1deed88",
      "version": "1.1"
    }