companyContactRevokeRoles

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 contact.

Arguments

Anchor to companyContactIdcompanyContactId • ID!required: The contact whose roles are being revoked.
Anchor to revokeAllrevokeAll • BooleanDefault:false: Flag to revoke all roles on the contact.
Anchor to roleAssignmentIdsroleAssignmentIds • [ID!]: The current role assignment IDs to revoke.

Was this section helpful?

Anchor to CompanyContactRevokeRolesPayload returnsCompanyContactRevokeRolesPayload returns

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

Was this section helpful?

Mutation Reference

1mutation companyContactRevokeRoles($companyContactId: ID!, $revokeAll: Boolean, $roleAssignmentIds: [ID!]) {
2  companyContactRevokeRoles(companyContactId: $companyContactId, revokeAll: $revokeAll, roleAssignmentIds: $roleAssignmentIds) {
3    revokedRoleAssignmentIds
4    userErrors {
5      field
6      message
7    }
8  }
9}

Input

1{
2  "companyContactId": "gid://shopify/<objectName>/10079785100",
3  "revokeAll": true,
4  "roleAssignmentIds": [
5    "gid://shopify/<objectName>/10079785100"
6  ]
7}

{
  "companyContactId": "gid://shopify/<objectName>/10079785100",
  "revokeAll": true,
  "roleAssignmentIds": [
    "gid://shopify/<objectName>/10079785100"
  ]
}