companyLocationRevokeRoles

mutation

Requires write_customers access scope or write_companies access scope. Also: The API client must be installed on a Shopify Plus store.

Revokes roles on a company location.

Arguments

Anchor to companyLocationIdcompanyLocationId • ID!required: The location whose roles are being revoked.
Anchor to rolesToRevokerolesToRevoke • [ID!]!required: The current roles to revoke.

Was this section helpful?

Anchor to CompanyLocationRevokeRolesPayload returnsCompanyLocationRevokeRolesPayload returns

Anchor to revokedRoleAssignmentIdsrevokedRoleAssignmentIds • [ID!]: A list of role assignment IDs that were removed from the company location.
Anchor to userErrorsuserErrors • [BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation companyLocationRevokeRoles($companyLocationId: ID!, $rolesToRevoke: [ID!]!) {
2  companyLocationRevokeRoles(companyLocationId: $companyLocationId, rolesToRevoke: $rolesToRevoke) {
3    revokedRoleAssignmentIds
4    userErrors {
5      field
6      message
7    }
8  }
9}

Input

1{
2  "companyLocationId": "gid://shopify/<objectName>/10079785100",
3  "rolesToRevoke": [
4    "gid://shopify/<objectName>/10079785100"
5  ]
6}

{
  "companyLocationId": "gid://shopify/<objectName>/10079785100",
  "rolesToRevoke": [
    "gid://shopify/<objectName>/10079785100"
  ]
}