Delete Custom Field - Birdeye Developer Portal

delete_custom_field

Description

Deletes a custom field from a business. Use it to remove a field that is no longer used or one created by mistake.

This action cannot be undone — the custom field definition (and any values stored under it) is permanently removed. State exactly which field will be deleted and confirm with the user before proceeding.

Parameters

Parameter	Type	Required	Default	Description
`fieldId`	integer	Yes	—	ID of the custom field to delete. Resolve via `get_custom_fields_list`
`businessNumber`	string	Yes	—	Business number that owns the field

Example Usage

Delete custom field 376.

Remove the "Legacy ID" custom field.

Notes

Returns a success response when the field is deleted.
Resolve fieldId via get_custom_fields_list (match the field by name) if the user refers to the field by name rather than ID.