Skip to main content

Create an extra suboption metafield

API operation: Open the endpoint in the API reference

Use POST /business/{business_id}/extras/{extra_id}/options/{option_id}/suboptions/{suboption_id}/metafields to create metadata for one extra suboption. The current public operation is ExtraOptionSuboptionMetafield.register.

The identifiers form one hierarchy: business_id identifies the business, extra_id the extra, option_id the extra option, and suboption_id its suboption. When the operation is available, it verifies this hierarchy before creating the metafield.

If available, the operation derives the literal model identity ExtraOptionSuboption and the metafield object ID from suboption_id. It validates the metafield key, value, and value_type; supported value_type values are integer, decimal, boolean, text, and json. The operation guide specifies the current request contract and unresolved field-level differences.

If available, the operation requires administrator or business-manager authentication. A business manager is scoped through businesses associated with that user.

This exact method/path match establishes operation correspondence only. See list extra suboption metafields for the collection read.

OpenAPI reference​

Operation: POST /business/{business_id}/extras/{extra_id}/options/{option_id}/suboptions/{suboption_id}/metafields

Path parameters

NameTypeRequiredDescription
business_idintegerYes—
extra_idintegerYes—
option_idintegerYes—
suboption_idintegerYes—

Request body fields

NameTypeRequired
modelanyYes
object_idintegerYes
valueanyYes
value_typestringYes

Responses

CodeDescription
200OK (Envelope)
400Bad Request (ErrorResponse)
401Unauthorized
404Not Found
429Too Many Requests (ErrorResponse)
500Internal Server Error (ErrorResponse)
503Service Unavailable (ErrorResponse)
Open this operation in the API reference