Update a Field

Partially updates an existing custom field.

PATCHhttps://api.audienceful.com/v2/fields/{id}

curl --location --request PATCH 'https://api.audienceful.com/v2/fields/o4i4TNZnWsq2f2ZWVqNNWY' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <your-api-key>' \
--data-raw '{
    "name": "Subscription Plan"
}'

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

Requires the fields:write scope. Send only the fields you want to change.

Path parameters

idstringrequired

The id of the field to update.

Body

namestring

A new human-readable field name.

data_namestring

A new key for setting and reading this field's value. Must remain unique within the workspace.

typestring

The data type of the field (string, boolean, tag, number).

requiredboolean

Whether a value for this field is required.

The internal flag is system-managed and read-only — it cannot be changed via the API.

Response

Returns the updated 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.