Create Menu Metafield
API operation: Open the endpoint in Scalar
Use POST /business/{business_id}/menus/{menu_id}/metafields to create a menu metafield. The operation documented here is MenuMetafield.register.
The documented schema requires administrator or business-manager authentication. Before creating a metafield, verify that menu_id belongs to the route business; do not assume the route enforces this parent relationship.
The supported value_type values are integer, decimal, boolean, text, and json. See List menu metafields.
OpenAPI reference
Operation: POST /business/{business_id}/menus/{menu_id}/metafields
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
business_id | integer | Yes | — |
menu_id | integer | Yes | — |
Request body fields
| Name | Type | Required |
|---|---|---|
model | any | Yes |
object_id | integer | Yes |
value | any | Yes |
value_type | string | Yes |
Responses
| Code | Description |
|---|---|
| 200 | OK (Envelope) |
| 400 | Bad Request (ErrorResponse) |
| 401 | Unauthorized |
| 404 | Not Found |
| 429 | Too Many Requests (ErrorResponse) |
| 500 | Internal Server Error (ErrorResponse) |
| 503 | Service Unavailable (ErrorResponse) |