Skip to main content

Update Extra Metafield

API operation: Open the endpoint in Scalar

Use PUT /business/{business_id}/extras/{extra_id}/metafields/{metafield_id} to update a metafield on an extra. The operation documented here is ExtraMetafield.update.

The path has no options/{option_id} segment, so this operation updates a metafield on the extra itself.

The documented schema requires administrator or business-manager authentication and scopes manager updates through business ownership. See Extra attributes (Metafields) for shared concepts.

OpenAPI reference​

Operation: PUT /business/{business_id}/extras/{extra_id}/metafields/{metafield_id}

Path parameters

NameTypeRequiredDescription
business_idintegerYes—
extra_idintegerYes—
metafield_idintegerYes—

Request body fields

NameTypeRequired
keystringNo
modelanyYes
object_idintegerNo
valueanyNo
value_typestringNo

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