Create a custom field

Important Notes:

  • When the field_type is dropdown, radio, checkbox or listbox, you need to add field options using fieldOption/bulk endpoint.
  • A contact can only see a custom field if the contact is part of a list that this custom field is related to. Use fieldRel endpoint to specify which list gets to see the custom field.

Example POST Body

{
    "field": {
        "type": "textarea",
        "title": "Field Title",
        "descript": "Field description",
        "perstag": "Personalized Tag",
        "defval": "Defaut Value",
        "visible": 1,
        "ordernum": 1
    }
}
{
    "field": {
        "type": "text",
        "title": "Field Title",
        "descript": "Field description",
        "isrequired": 1,
        "perstag": "Personalized Tag",
        "defval": "Defaut Value",
        "visible": 1,
        "ordernum": 1
    }
}
{
    "field": {
        "type": "date",
        "title": "Field Title",
        "descript": "Field description",
        "isrequired": 1,
        "perstag": "Personalized Tag",
        "defval": "2019-01-01",
        "visible": 1,
        "ordernum": 1
    }
}
{
    "field": {
        "type": "dropdown",
        "title": "Field Title",
        "descript": "Field description",
        "isrequired": 1,
        "perstag": "Personalized Tag",
        "visible": 1,
        "ordernum": 1
    }
}
{
    "field": {
        "type": "listbox",
        "title": "Field Title",
        "descript": "Field description",
        "isrequired": 1,
        "perstag": "Personalized Tag",
        "visible": 1,
        "ordernum": 1
    }
}
{
    "field": {
        "type": "radio",
        "title": "Field Title",
        "descript": "Field description",
        "isrequired": 1,
        "perstag": "Personalized Tag",
        "visible": 1,
        "ordernum": 1
    }
}
{
    "field": {
        "type": "checkbox",
        "title": "Field Title",
        "descript": "Field description",
        "isrequired": 1,
        "perstag": "Personalized Tag",
        "visible": 1,
        "ordernum": 1
    }
}
{
    "field": {
        "type": "hidden",
        "title": "Field Title",
        "descript": "Field description",
        "isrequired": 1,
        "perstag": "Personalized Tag",
        "defval": "Defaut Value",
        "visible": 1,
        "ordernum": 1
    }
}
{
    "field": {
        "type": "datetime",
        "title": "Field Title",
        "descript": "Field description",
        "isrequired": 1,
        "perstag": "Personalized Tag",
        "defval": "2020-05-19T02:45:00-05:00",
        "visible": 1,
        "ordernum": 1
    }
}
Language
Authentication
Header
URL