Custom Fields Overview

Tools for creating, reading, updating, and deleting custom fields on a business.

Tools in this category

get_custom_fields_list

List a business’s custom fields with pagination, search, and sorting

get_custom_field

Get a single custom field’s definition (and value, if set) by ID

create_custom_field

Create a new custom field on a business

update_custom_field

Update an existing custom field’s configuration

delete_custom_field

Delete a custom field from a business

Tips

• Field types: TEXT, URL, NUMBER, DATE, DROPDOWN_SINGLE, DROPDOWN_MULTI, TEXT_RAW.
• dropDownOptions is required when the type is DROPDOWN_SINGLE or DROPDOWN_MULTI.
• Resolve a field’s ID with get_custom_fields_list before calling get_custom_field, update_custom_field, or delete_custom_field.
• The field definition is account-level; a field can also carry a per-location value — pass locationBizNumber to read location-specific values.