Skip to main content

Delete Custom Field

Delete a custom field.

Request​

DELETE /custom-fields/{uuid}

Path Parameters​

ParameterTypeDescription
uuidstringField's UUID

Example Request​

curl -X DELETE "https://email.easy.tools/api/v1/custom-fields/ac01820d-7686-4a84-baaf-db773a117642" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Response​

Success Response (204 No Content)​

No response body.

Error Responses​

Not Found Error (404)​

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Custom field not found"
  }
}

Referenced By Active Automation Error (409 Conflict)​

Returned when the custom field is used as a trigger condition by one or more active automations. Pause or edit those automations before deleting the field.

{
  "error": {
    "code": "CUSTOM_FIELD_REFERENCED_BY_ACTIVE_AUTOMATION",
    "message": "This custom field is used as a trigger condition by 2 active automation(s). Pause or edit them before deleting."
  }
}

Referenced By Segment Error (409 Conflict)​

Returned when the custom field is used in the filters of one or more segments. Edit those segments so they no longer filter on it before deleting the field.

{
  "error": {
    "code": "CUSTOM_FIELD_REFERENCED_BY_SEGMENT",
    "message": "This custom field is used by 3 segment(s). Edit them before deleting."
  }
}

Referenced By Campaign Error (409 Conflict)​

Returned when the custom field is used in the audience filters of one or more campaigns. Edit those campaigns so they no longer filter on it before deleting the field. A campaign that has already been sent or canceled does not block the deletion.

{
  "error": {
    "code": "CUSTOM_FIELD_REFERENCED_BY_CAMPAIGN",
    "message": "This custom field is used by 1 unsent campaign(s). Edit them before deleting."
  }
}