createMetafield

Example Query

1 mutation ExampleMutation($input: CreateMetafieldInput!) {
2   metafield {
3     createMetafield(input: $input) {
4       metafield {
5         id
6         description
7         key
8         namespace
9         permissionSet
10         resourceId
11         value
12         ownerClientId
13         createdAt
14         updatedAt
15       }
16       errors
17     }
18   }
19 }

Variables

1 {
2   "input": {
3     "namespace": "example",
4     "resourceId": "example",
5     "key": "example",
6     "value": "example",
7     "description": "example",
8     "permissionSet": "APP_ONLY"
9   }
10 }

Example response

1 {
2   "data": {
3     "metafield": {
4       "createMetafield": {
5         "metafield": {
6           "id": "example",
7           "description": "example",
8           "key": "example",
9           "namespace": "example",
10           "permissionSet": "APP_ONLY",
11           "resourceId": "example",
12           "value": "example",
13           "ownerClientId": "example",
14           "createdAt": "2026-06-15T17:12:12.435Z",
15           "updatedAt": "2026-06-15T17:12:12.435Z"
16         },
17         "errors": [
18           {
19             "message": "example"
20           }
21         ]
22       }
23     }
24   }
25 }

Create Metafield.

Arguments

inputCreateMetafieldInputRequired

Returns

an optional CreateMetafieldResult

errorslist of CreateMetafieldErrorss

The list of errors that occurred while creating a metafield.

metafieldMetafield

Metafield that was created as a result of mutation.