Metadata Update

Authorization

oauth2 metadata:write

AuthorizationBearer <token>

Generate an Access Token through Settings > API Access for single store access or use the Authorization Code flow with your partner App Client ID. Use required permission scopes for API endpoint access. Example Authorization: Bearer 123

In: header

Scope: metadata:write

Path Parameters

id*integer

A unique integer value identifying this definition.

Header Parameters

X-29next-API-Version*"2023-02-10"

Default"2023-02-10"

Value in

"2023-02-10"

Request Body

enable_export?boolean

Defaultfalse

enable_filter?boolean

Defaultfalse

name*string

Lengthlength <= 255

object*string

Source object this metadata is linked to.

attribution - Attribution
customer - Customer
dispute - Dispute
line - Line Item
order - Order
product - Product
variant - Variant
blog - Blog
page - Page

Value in

"attribution"
"customer"
"dispute"
"line"
"order"
"product"
"variant"
"blog"
"page"

validations?array<>

Response Body

`application/json`

curl -X PUT "https://example.com/metadata/0/" \  -H "X-29next-API-Version: 2023-02-10" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "object": "attribution"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "enable_export": true,  "enable_filter": true,  "id": 0,  "key": "string",  "name": "string",  "object": "attribution",  "type": "text",  "updated_at": "2019-08-24T14:15:22Z",  "validations": [    {      "type": "maximum_length",      "value": "string"    }  ]}