Delete a List Field

Permanently delete a custom field from a subscriber list using its list UID and field ID. This is useful for cleaning up unused or outdated fields.

🗑️ Delete a List Field

Delete a specific custom field from a subscriber list using its list UID and field ID. This action is permanent and cannot be undone.

🔹 HTTP Request

DELETE API-URL/lists/LIST-UNIQUE-ID/fields/FIELD-ID

🔸 URL Segments

Segment
Required
Description

LIST-UNIQUE-ID

Yes

Unique identifier of the list.

FIELD-ID

Yes

Unique identifier of the list field.

🔐 Authorization Header

X-API-KEY: your-api-key-here

💻 PHP Example

// Delete FIELD
$response = $endpoint->delete('LIST-UNIQUE-ID', 'FIELD-ID');

// DISPLAY RESPONSE
echo '<hr /><pre>';
print_r($response->body);
echo '</pre>';

📦 Sample JSON Response

{
  "status": "success"
}

⚠️ Deleting a field will remove it from all list forms and subscriber records associated with this list.


Last updated