Anchor to companyContactRevokeRolecompany
companyContactRevokeRole
mutation
Requires access scope or
access scope. Also: The API client must be installed on a Shopify Plus store.
Revokes a role on a company contact.
Anchor to Arguments
Arguments
- Anchor to companyContactIdcompany•
Contact Id ID!required The ID of the contact to revoke a role from.
- Anchor to companyContactRoleAssignmentIdcompany•
Contact Role Assignment Id ID!required The ID of the role assignment to revoke from a contact.
Was this section helpful?
Anchor to CompanyContactRevokeRolePayload returnsCompanyContactRevokeRolePayload returns
- Anchor to revokedCompanyContactRoleAssignmentIdrevoked•
Company Contact Role Assignment Id The role assignment that was revoked.
- 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 companyContactRevokeRole($companyContactId: ID!, $companyContactRoleAssignmentId: ID!) {
companyContactRevokeRole(companyContactId: $companyContactId, companyContactRoleAssignmentId: $companyContactRoleAssignmentId) {
revokedCompanyContactRoleAssignmentId
userErrors {
field
message
}
}
}
Input
{
"companyContactId": "gid://shopify/<objectName>/10079785100",
"companyContactRoleAssignmentId": "gid://shopify/<objectName>/10079785100"
}
{
"companyContactId": "gid://shopify/<objectName>/10079785100",
"companyContactRoleAssignmentId": "gid://shopify/<objectName>/10079785100"
}