companyLocationRevokeRoles

Revokes roles on a company location.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the companyLocationRevokeRoles action (under Company).
Fill in the fields below, then reference the result from later steps as {{companylocationrevokeroles.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 CompanyLocationRevokeRoles($companyLocationId: ID!, $rolesToRevoke: [ID!]!) {
  companyLocationRevokeRoles(
    companyLocationId: $companyLocationId
    rolesToRevoke: $rolesToRevoke
  ) {
    revokedRoleAssignmentIds
    userErrors {
      code
      field
      message
    }
  }
}

Variables

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

companyLocationIdstringrequired

The location whose roles are being revoked.

rolesToRevokearray<string>required

The current roles to revoke.

json

{
  "companyLocationId": "string",
  "rolesToRevoke": [
    "string"
  ]
}

Response

Read the result with {{companylocationrevokeroles.response.data.data.companyLocationRevokeRoles}}. If the API returns errors, the step fails and they are at {{companylocationrevokeroles.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?