Delete a custom field

Deletes an archived field with its values and history on every profile. 422 `custom_field_not_archived` when it isn’t archived first.

DELETE

/custom-fields/{id}

Deletes an archived field with its values and history on every profile. 422 custom_field_not_archived when it isn’t archived first.

Authorization

apiKey write

headerAuthorizationBearer <token>

A workspace API key (pf_…), created under Developers → API keys.

Scope: write

id*string

Formatuuid

No content

curl -X DELETE 'https://api.postforge.dev/v1/custom-fields/497f6eca-6276-4993-bfeb-53cbbbba6f08'

Empty

Update a custom field PATCH

Changes the label or description. The key stays as it was made (emails and the API use it); changing the type is a conversion.

Archive a custom field POST

Hides the field and stops every writer, a store’s too: writes to it are refused and recorded. Its values stay until it’s deleted.