Fields

Create a customer-created subscriber field.

Creates a non-built-in subscriber field. If no personalization tag name is provided, the backend derives an available lowercase ASCII personalization tag name from the field label. SINGLE_CHOICE and MULTI_CHOICE require options; scalar fields must not include options.

post/fields

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
  • Auth: API key in header X-API-Key

Request body

personalizationTagNamestring

Optional stable lowercase ASCII personalization tag name used in imports, forms, personalization, and subscriber field value updates. Leave empty to let the backend derive an available name from the field label.

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.

optionsstring[]

Option labels for SINGLE_CHOICE and MULTI_CHOICE fields. Must be empty for scalar fields.

Example request

{
  "personalizationTagName": "favorite_topics",
  "label": "Favorite topics"
}

Response

Field created.

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.