Anchor to companyLocationRevokeRolescompany
companyLocationRevokeRoles
mutation
Requires access scope or
access scope. Also: The API client must be installed on a Shopify Plus store.
Revokes roles on a company location.
Anchor to Arguments
Arguments
- Anchor to companyLocationIdcompany•
Location Id ID!required The location whose roles are being revoked.
- Anchor to rolesToRevokeroles•
To Revoke [ID!]!required The current roles to revoke.
Was this section helpful?
Anchor to CompanyLocationRevokeRolesPayload returnsCompanyLocationRevokeRolesPayload returns
- Anchor to revokedRoleAssignmentIdsrevoked•
Role Assignment Ids A list of role assignment IDs that were removed from the company location.
- Anchor to userErrorsuser•
Errors [BusinessCustomer non-nullUser Error!]! The list of errors that occurred from executing the mutation.
Was this section helpful?
Mutation Reference
mutation companyLocationRevokeRoles($companyLocationId: ID!, $rolesToRevoke: [ID!]!) {
companyLocationRevokeRoles(companyLocationId: $companyLocationId, rolesToRevoke: $rolesToRevoke) {
revokedRoleAssignmentIds
userErrors {
field
message
}
}
}
Input
{
"companyLocationId": "gid://shopify/<objectName>/10079785100",
"rolesToRevoke": [
"gid://shopify/<objectName>/10079785100"
]
}
{
"companyLocationId": "gid://shopify/<objectName>/10079785100",
"rolesToRevoke": [
"gid://shopify/<objectName>/10079785100"
]
}