companyContactRevokeRoles

Revokes roles on a company contact.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the companyContactRevokeRoles action (under Company).
Fill in the fields below, then reference the result from later steps as {{companycontactrevokeroles.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation CompanyContactRevokeRoles($companyContactId: ID!, $roleAssignmentIds: [ID!], $revokeAll: Boolean) {
  companyContactRevokeRoles(
    companyContactId: $companyContactId
    roleAssignmentIds: $roleAssignmentIds
    revokeAll: $revokeAll
  ) {
    revokedRoleAssignmentIds
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

companyContactIdstringrequired

The contact whose roles are being revoked.

roleAssignmentIdsarray<string>

The current role assignment IDs to revoke.

revokeAllboolean

Flag to revoke all roles on the contact.

json

{
  "companyContactId": "string",
  "roleAssignmentIds": [
    "string"
  ],
  "revokeAll": false
}

Response

Read the result with {{companycontactrevokeroles.response.data.data.companyContactRevokeRoles}}. If the API returns errors, the step fails and they are at {{companycontactrevokeroles.response.data.errors}}.

revokedRoleAssignmentIdsarray<string>

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?