Add a Custom Field to a Campaign
Creates or updates a custom field scoped to the campaign with the given id. The custom field is available on the campaign's leads and can be populated via the Create or Update a Lead API.
Path Parameters
idnumberrequired
The campaign id to add the custom field to.
HTTP Request Examples
{
"name": "Member Since",
"datatype": "DateTime"
}
HTTP Request Parameters
namestring
Human-readable name of the custom field. Required.
datatypestring
Data type of the custom field. One of: String, Number, DateTime, Boolean, Picklist, Url.
descriptionstring
Optional description shown in the UI.
default_valuestring
Optional default value applied when the field is unset on a lead.
is_requiredboolean
When true, the field must be populated on leads.
HTTP Response Examples
200
{
"Status": true,
"Message": "",
"Response": {
"apiname": "member_since",
"id": 4071
}
}
HTTP Response Parameters
idnumber
Numeric id of the newly-created or updated custom field.
apinamestring
Stable machine-readable identifier for the field (derived from name). Use this when sending the field value on a lead.