Anchor to section titled 'undefined'

companyContactRevokeRole
mutation

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

Revokes a role on a company contact.

Anchor to section titled 'Arguments'

Arguments

Anchor to companyContactId
companyContactId
ID!
required

The ID of the contact to revoke a role from.

Anchor to companyContactRoleAssignmentId
companyContactRoleAssignmentId
ID!
required

The ID of the role assignment to revoke from a contact.

Was this section helpful?
Anchor to section titled 'CompanyContactRevokeRolePayload returns'

CompanyContactRevokeRolePayload returns

Anchor to CompanyContactRevokeRolePayload.revokedCompanyContactRoleAssignmentId
revokedCompanyContactRoleAssignmentId
ID

The role assignment that was revoked.

Anchor to CompanyContactRevokeRolePayload.userErrors
userErrors
[BusinessCustomerUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation companyContactRevokeRole($companyContactId: ID!, $companyContactRoleAssignmentId: ID!) {
  companyContactRevokeRole(companyContactId: $companyContactId, companyContactRoleAssignmentId: $companyContactRoleAssignmentId) {
    revokedCompanyContactRoleAssignmentId
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "companyContactId": "gid://shopify/<objectName>/10079785100",
  "companyContactRoleAssignmentId": "gid://shopify/<objectName>/10079785100"
}