createMetafield

Example Query

mutation ExampleMutation($input: CreateMetafieldInput!) {
  metafield {
    createMetafield(input: $input) {
      metafield {
        id
        description
        key
        namespace
        permissionSet
        resourceId
        value
        ownerClientId
        createdAt
        updatedAt
      }
      errors
    }
  }
}

Variables

{
  "input": {
    "namespace": "example",
    "resourceId": "example",
    "key": "example",
    "value": "example",
    "description": "example",
    "permissionSet": "APP_ONLY"
  }
}

Example response

{
  "data": {
    "metafield": {
      "createMetafield": {
        "metafield": {
          "id": "example",
          "description": "example",
          "key": "example",
          "namespace": "example",
          "permissionSet": "APP_ONLY",
          "resourceId": "example",
          "value": "example",
          "ownerClientId": "example",
          "createdAt": "2026-10-30T22:30:43.442Z",
          "updatedAt": "2026-10-30T22:30:43.442Z"
        },
        "errors": [
          {
            "message": "example"
          }
        ]
      }
    }
  }
}

Create Metafield.

Arguments

inputCreateMetafieldInputRequired

Returns

an optional CreateMetafieldResult

errorslist of CreateMetafieldErrorses

The list of errors that occurred while creating a metafield.

metafieldMetafieldOptional

Metafield that was created as a result of mutation.