Create a Field

Creates a new custom field for your contact data.

POSThttps://api.audienceful.com/v2/fields

curl --location --request POST 'https://api.audienceful.com/v2/fields' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <your-api-key>' \
--data-raw '{
    "name": "Plan",
    "data_name": "plan",
    "type": "string",
    "required": false
}'

{
  "id": "o4i4TNZnWsq2f2ZWVqNNWY",
  "name": "Plan",
  "data_name": "plan",
  "type": "string",
  "editable": true,
  "internal": false,
  "required": false
}

Requires the fields:write scope.

Body

namestringrequired

A human-readable field name.

data_namestringrequired

The key used to set and read this field's value on a contact. Must be unique within the workspace — a duplicate data_name returns a 400.

typestringrequired

The data type of the field. - string - boolean - number - tag - datetime - phone

editablebooleandefault: true

Whether the field can be edited.

requiredbooleandefault: false

Whether a value for this field is required.

The internal flag is system-managed. It's returned in responses to mark built-in fields, but it is read-only and cannot be set via the API.

Response

Returns 201 Created with the created field.

idstring

The id of the field. Used to address the field in the retrieve, update, and delete endpoints.

namestring

The human-readable name of the field.

data_namestring

The key used to set and read this field's value on a contact (in extra_data).

typestring

The type of data stored in the field. One of string, boolean, number, tag, datetime, or phone.

editableboolean

Whether the field can be edited. Default fields such as email or tags are not editable.

internalboolean

Whether the field is a built-in, internally managed field.

requiredboolean

Whether a value for this field is required.