Create Merge Tags

Send your campaigns by addressing your contacts by their first name, last name or anything else you find appropriate. Using this API, you can create merge tags.

Request Type:

  • Get

Scope required

  • ZohoCampaigns.campaign.CREATE

    Other alternative scopes

    • ZohoCampaigns.campaign.CREATE-UPDATE (CREATE + UPDATE)
    • ZohoCampaigns.campaign.WRITE (CREATE + UPDATE + DELETE)
    • ZohoCampaigns.campaign.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/merge/create

    List of Parameters: Version 1.1

    Parameter

    Data Type

    Description

    type*

    String

    xml (or) json

    fieldname*

    String

    Alphanumeric

    tagtype*

    String

    Custom

    fieldtype*

    String

    [Text|Integer|Phone|Date|Picklist|Email|Checkbox|LongInteger|URL|
    textarea|RadioOption|Multiselect|DateTime|Decimal|Percent]

    mailvalue

    String

    Give a default value for the tag to be used in email content.

    socialvalue

    String

    Give a default value for the tag to be used in email content of social campaigns.

    * - Mandatory Parameters

    Sample XML Request

    Copiedhttps://campaigns.zoho.com/api/v1.1/merge/create?type=xml&mergename=providemergetagname&fieldname=providefiledname&tagtype=custom&fieldtype=Text&mailval=providemailval&socialval=providesocialval ​

    Sample Response

    Copied<response>
	<fieldtype>Text</fieldtype>
	<mandatory_check>success</mandatory_check>
	<scope>CampaignsAPI</scope>
	<tagtype>custom</tagtype>
	<code>917</code>
	<mailval>providemailval</mailval>
	<type>xml</type>
	<uri>/api/v1.1/merge/create</uri>
	<fieldname>providefieldname
	</fieldname>
	<message>Duplicate Custom Fields Found</message>
	<authtoken>[API Authentication_Token]</authtoken>
	<mergename>providemergename</mergename>
	<socialval>providesocialval</socialval>
</response>

    Sample JSON Request

    Copiedhttps://campaigns.zoho.com/api/v1.1/merge/create?type=json&mergename=providemergetagname&fieldname=providefiledname&tagtype=custom&fieldtype=Text&mailval=providemailval&socialval=providesocialval ​

    Sample Response

    Copied{
  "response": {
    "fieldtype": "Text",
    "mandatory_check": "success",
    "scope": "CampaignsAPI",
    "ta gtype": "custom",
    "code": "200",
    "mailval": "providemailval",
    "type": "json",
    "uri": "/api/v1.1/merge/create",
    "fieldname": "providefieldname",
    "message": "Success",
    "authtoken": "[API Authentication_Token] ",
    "mergename": "providemergetagname",
    "socialval": "providesocialvalue"
  }
}