Choose a version:

metafieldAccessGrant

mutation

Share a Metafield Primitive with a Client or Namespace. Requires the 'share_metafield' client scope and requires that the Client making the request has Admin permission on the Resource.

Anchor to Arguments

Arguments

Anchor to accessaccess

•CustomDataAccessInput!

required

Update the default permission of the resource and/or provide a list of targets to give access to the resource.

Anchor to identifieridentifier

•CustomDataKeyPairInput!

required

Key and namespace pair that together form the path to the resource. Key is required, Namespace defaults to the Client's implicit, reserved namespace if not provided.

Anchor to keykey

•String

Use 'key' to provide a new key for the target when sharing, if desired. Only changes the key for the newly shared resource within the grantee's reserved namespace, not the grantor's.

Was this section helpful?

Anchor to MetafieldAccessGrantPayload returnsMetafieldAccessGrantPayload returns

Anchor to userErrorsuserErrors •[UserError!]! non-null: List of errors that occured while executing the mutation.

Was this section helpful?

Examples

metafieldAccessGrant reference

Mutation Reference

mutation metafieldAccessGrant($access: CustomDataAccessInput!, $identifier: CustomDataKeyPairInput!, $key: String) {

metafieldAccessGrant(access: $access, identifier: $identifier, key: $key) {

userErrors {

field

message

}

Input

{

"access": {

"default": "ADMIN",

"grants": [

{

"grant": "ADMIN",

"grantee": "<your-grantee>",

"granteeId": "<your-granteeId>",

"role": "<your-role>"

}

]

"identifier": {

"key": "<your-key>",

"namespace": "<your-namespace>"

"key": "<your-key>"

}

Variables

{
  "access": {
    "default": "ADMIN",
    "grants": [
      {
        "grant": "ADMIN",
        "grantee": "<your-grantee>",
        "granteeId": "<your-granteeId>",
        "role": "<your-role>"
      }
    ]
  },
  "identifier": {
    "key": "<your-key>",
    "namespace": "<your-namespace>"
  },
  "key": "<your-key>"
}

Schema

input CustomDataAccessInput {
  default: CustomDataAccessPermissionType
  grants: [CustomDataAccessGrantInput!]
}

input CustomDataAccessGrantInput {
  grant: CustomDataAccessPermissionType
  grantee: String
  granteeId: String
  role: String
}

input CustomDataKeyPairInput {
  key: String!
  namespace: String
}