Custom Fields

Delete custom field

This endpoint enables you to delete a specific custom field of your organization by specifying its ID. Use the force parameter to delete fields that have values assigned to businesses. PROVIDER users can pass org_id to delete a custom field for a managed organization.

delete/custom_fields/{custom_field_id}

Path parameters

custom_field_idinteger required

Id of the custom field

Example:42

Query parameters

org_idinteger

Organization ID. Only PROVIDER users can specify a different organization. If not provided, defaults to your own organization.

forceboolean

If true, destructive modification will be performed and businesses values will be deleted accordingly

Response

OK

status'success'

Request status

Changes