companyLocationAssignRoles

mutation

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

Assigns roles on a company location.

Arguments

Anchor to companyLocationIdcompanyLocationId • ID!required: The location whose roles are being assigned.
Anchor to rolesToAssignrolesToAssign • [CompanyLocationRoleAssign!]!required: The roles to assign.

Was this section helpful?

Anchor to CompanyLocationAssignRolesPayload returnsCompanyLocationAssignRolesPayload returns

Anchor to roleAssignmentsroleAssignments • [CompanyContactRoleAssignment!]: A list of newly created assignments of company contacts to a company location.
Anchor to userErrorsuserErrors • [BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation companyLocationAssignRoles($companyLocationId: ID!, $rolesToAssign: [CompanyLocationRoleAssign!]!) {

companyLocationAssignRoles(companyLocationId: $companyLocationId, rolesToAssign: $rolesToAssign) {

roleAssignments {

# CompanyContactRoleAssignment fields

}

userErrors {

field

message

}

Input

{

"companyLocationId": "gid://shopify/<objectName>/10079785100",

"rolesToAssign": [

{

"companyContactId": "gid://shopify/<objectName>/10079785100",

"companyContactRoleId": "gid://shopify/<objectName>/10079785100"

}

]

}

{
  "companyLocationId": "gid://shopify/<objectName>/10079785100",
  "rolesToAssign": [
    {
      "companyContactId": "gid://shopify/<objectName>/10079785100",
      "companyContactRoleId": "gid://shopify/<objectName>/10079785100"
    }
  ]
}

input CompanyLocationRoleAssign {
  companyContactId: ID!
  companyContactRoleId: ID!
}