Fields

Update a customer-created subscriber field.

Updates label, required flag, internal visibility, position, and option metadata. Internal fields remain usable for email personalization. Setting internal to true is rejected with SUBSCRIBER_FIELD_USED_IN_FORMS and a form list while the field is used in subscriber forms. Personalization tag name and field type cannot be changed.

put/fields/{fieldId}

Request

  • Base URL: https://api.maildroppa.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.maildroppa.com/fields/{fieldId}
  • Auth: API key in header X-API-Key

Path parameters

fieldIdstring uuid required

Unique identifier of the field to update.

Request body

labelstring

Updated human-readable field label.

requiredboolean

Whether subscribers must provide a value for this field in signup and subscriber edit workflows.

internalboolean

Whether this field is hidden from subscriber-facing forms and subscriber profile editing.

positioninteger

Updated ordering position in the field schema.

removedOptionIdsstring[]

Choice option IDs to remove atomically with this field update. Omit when no options are removed.

Example request

{
  "label": "Favorite topics",
  "position": 3,
  "options": [
    {
      "label": "Email marketing",
      "active": true
    }
  ]
}

Response

Field updated.

type'BUILT_IN' | 'CUSTOM'
builtInField'EMAIL' | 'FIRST_NAME'
fieldIdstring uuid
personalizationTagNamestring

Stable personalization tag name used in imports, forms, personalization, and subscriber field value updates.

labelstring

Human-readable field label shown in the app.

fieldType'TEXT' | 'LONG_TEXT' | 'EMAIL' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'SINGLE_CHOICE' | 'MULTI_CHOICE'
requiredboolean

Whether subscribers must provide a value for this field in signup and subscriber edit workflows.

internalboolean

Whether this field is hidden from subscriber-facing forms and subscriber profile editing.

activeboolean

False when a customer-created field has been archived.

positioninteger

Ordering position in the field schema.

Example response

{
  "personalizationTagName": "favorite_topics",
  "label": "Favorite topics",
  "active": true,
  "position": 3,
  "options": [
    {
      "label": "Email marketing",
      "active": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.