Fields

Check whether a subscriber field can be permanently deleted.

Returns a fresh report for a future permanent-delete flow. This endpoint does not delete the field.

get/fields/{fieldId}/permanent-delete-check

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

Path parameters

fieldIdstring uuid required

Unique identifier of the field.

Response

Field permanent-delete check retrieved.

fieldIdstring uuid
fieldLabelstring

Human-readable field label.

personalizationTagNamestring

Stable subscriber personalization tag name.

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

Subscriber field value assignments for this field. Multi-option rows count once per subscriber and field.

archiveBlockedboolean

True when current write references block archival.

permanentDeleteBlockedboolean

True when current references or running sends block a future permanent delete check.

Example response

{
  "fieldLabel": "Favorite topics",
  "personalizationTagName": "favorite_topics",
  "subscriberValueCount": 42,
  "blockingUsages": [
    {
      "area": "Campaign",
      "artifactName": "Newsletter Signup",
      "status": "ACTIVE"
    }
  ],
  "warningUsages": [
    {
      "area": "Campaign",
      "artifactName": "Newsletter Signup",
      "status": "ACTIVE"
    }
  ],
  "contentMergeTagUsages": [
    {
      "area": "Campaign",
      "artifactName": "Newsletter Signup",
      "status": "ACTIVE"
    }
  ],
  "permanentDeleteBlockingUsages": [
    {
      "area": "Campaign",
      "artifactName": "Newsletter Signup",
      "status": "ACTIVE"
    }
  ],
  "externalHints": [
    {
      "area": "Campaign",
      "artifactName": "Newsletter Signup",
      "status": "ACTIVE"
    }
  ]
}

Changes

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