Fields

Restore an archived customer-created subscriber field.

Restores an archived customer-created field when field limits and personalization tag name reservation rules allow it.

post/fields/{fieldId}/restore

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

Path parameters

fieldIdstring uuid required

Unique identifier of the field to restore.

Response

Field restored.

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.