Custom Fields
Update custom field
This endpoint enables you to update a specific custom field of your organization by specifying its ID. You can update the name, description, slug, constraints, and section assignment of the custom field. However, the type of a custom field cannot be modified. Use the force parameter to apply changes that might conflict with existing business data. PROVIDER users can pass org_id to update a custom field for a managed organization.
put/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.
Request body
Example request
{
"name": "Click and collect",
"description": "Whether the business offers click and collect service",
"type": "BOOLEAN",
"slug": "click-and-collect",
"section_id": 6
}Response
OK