Add Custom Fields

Users can create custom fields to store unique information about subscribers using the following API.

Request URL:

https://campaigns.zoho.com/api/custom/add

Request Type: Post

Parameters:

Parameter

Data Type

Description

authtoken*
scope*

String
String

API Authentication Token
CampaignsAPI

type*

String

xml (or) json

fieldname*

String

Alphanumeric

fieldtype*

String

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

* - Mandatory Parameters

Sample Request:

XML/JSON Format:

https://campaigns.zoho.com/api/custom/add?authtoken=[API Authentication_Token]&scope=CampaignsAPI&type=xml&fieldname=FIELD NAME&fieldtype=[Text|Integer|Phone|Date|Picklist|Email|Checkbox|LongInteger|URL|textarea|RadioOption|Multiselect|DateTime|Decimal|Percent] ​

Sample Response:

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

XML Format:

<response><message>Success</message><mandatory_check>success</mandatory_check><fieldtype>Text</fieldtype><authtoken>[API Authentication_Token]</aut htoken><scope>CampaignsAPI</scope><code>200</code><type>xml</type><uri>/api/custom/add</uri><fieldname>FIELDNAME</fieldname></response>​

JSON format:

:{"response":{"message":"Success","fieldtype":"Text","mandatory_check":"success","authtoken":"[API Authentication_Token]","scope":"CampaignsAPI","code":"200","type" :"json","uri":"/api/custom/add","fieldname":"FIELDNAME1"}}​