Anchor to companyContactRevokeRolescompany
companyContactRevokeRoles
mutation
Requires access scope or
access scope. Also: The API client must be installed on a Shopify Plus store.
Revokes roles on a company contact.
Anchor to Arguments
Arguments
- Anchor to companyContactIdcompany•
Contact Id ID!required The contact whose roles are being revoked.
- Anchor to revokeAllrevoke•
All BooleanDefault:false Flag to revoke all roles on the contact.
- Anchor to roleAssignmentIdsrole•
Assignment Ids The current role assignment IDs to revoke.
Was this section helpful?
Anchor to CompanyContactRevokeRolesPayload returnsCompanyContactRevokeRolesPayload returns
- Anchor to revokedRoleAssignmentIdsrevoked•
Role Assignment Ids A list of role assignment IDs that were removed from the company contact.
- 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 companyContactRevokeRoles($companyContactId: ID!, $revokeAll: Boolean, $roleAssignmentIds: [ID!]) {
companyContactRevokeRoles(companyContactId: $companyContactId, revokeAll: $revokeAll, roleAssignmentIds: $roleAssignmentIds) {
revokedRoleAssignmentIds
userErrors {
field
message
}
}
}
Input
{
"companyContactId": "gid://shopify/<objectName>/10079785100",
"revokeAll": true,
"roleAssignmentIds": [
"gid://shopify/<objectName>/10079785100"
]
}
{
"companyContactId": "gid://shopify/<objectName>/10079785100",
"revokeAll": true,
"roleAssignmentIds": [
"gid://shopify/<objectName>/10079785100"
]
}