Create Custom Fields

Custom fields can be used to feed any type of information, set character limit and use them to save specific data.Using this API, you can create custom fields to store unique information about leads.

Scope required

  • ZohoMarketingAutomation.lead.CREATE

Other alternative scopes

  • ZohoMarketingAutomation.lead.CREATE-UPDATE (CREATE + UPDATE)
  • ZohoMarketingAutomation.lead.WRITE (CREATE + UPDATE + DELETE)
  • ZohoMarketingAutomation.lead.ALL (CREATE + UPDATE + DELETE + READ)

Header:

Authorization: Zoho-oauthtoken <access_token>

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

Request type:

  • POST

Request URL

https://marketingautomation.zoho.com/api/v1/custom/add

API Limit

  • Duration: 5 mins
  • Number of Calls: 100
  • Lock Period: 30 mins

You can send 100 API calls per 5 minutes. If you hit this limit, you can't use this API for the next 30 minutes due to security reasons, but you can still use other APIs if their lock period hasn’t been reached.

List of parameters

ParameterData typeDescription
type*Stringjson
fieldname*StringAlphanumeric
fieldtype*String

 

  • Text
  • Integer
  • Phone
  • Date
  • Picklist
  • Email
  • Checkbox
  • LongInteger
  • URL
  • textarea
  • RadioOption
  • Multiselect
  • DateTime
  • Decimal
  • Percent

 

fieldlengthNumberThis lets you to set length of the field. Default value is 20.

* - Mandatory parameters

Possible error cases

Error codeDescription
903Mandatory fields are missing.
910No fields found.
914You cannot add leads as you've reached the maximum limit.
916Duplicate custom field found.

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

Sample request

Copiedhttps://marketingautomation.zoho.com/api/v1/custom/add?type=json&fieldname=FIELD NAME&fieldtype=[Text|Integer|Phone|Date|Picklist|Email|Checkbox|LongInteger|URL|textarea|RadioOption|Multiselect|DateTime|Decimal|Percent]&fieldlength=[number]

Sample response

Copied{
"response": {
"message": "Success",
"fieldtype": "Text",
"mandatory_check": "success",
"scope": "CampaignsAPI",
"code": "200",
"type": "json",
"uri": "/api/v1/custom/add",
"fieldname": "FIELDNAME1",
"fieldlength": "10"
}
}