Create Merge Tags

Users can create merge tags using the following API.

Request URL:

https://campaigns.zoho.com/api/merge/create

Request Type: Post

Parameters:

Parameter

Data Type

Description

authtoken*
scope*

String
String

API Authentication Token
CampaignsAPI

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 Request:

XML/JSON Format

https://campaigns.zoho.com/api/merge/create?authtoken=[API Authentication_Token]&scope=CampaignsAPI&type=xml&mergename=providemergetagname& fieldname=providefiledname&tagtype=custom&fieldtype=Text&mailval=providemailval&socialval=providesocialval ​

Sample Response:

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

XML Format:

<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/merge/create</uri><fieldname>providefieldname</ fieldname><message>Duplicate Custom Fields Found</message><authtoken>[API Authentication_Token]</authtoken><mergename>providemergename</mergename><socialval>providesocialval</socialval></response> ​

JSON format:

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