Choose a version:

companyLocationAssignRoles

mutation

Requires write_customers access scope or write_companies access scope. Also: The shop must have access to B2B. Some operations may require additional plan capabilities.

Assigns roles on a company location.

Anchor to Arguments

Arguments

Anchor to companyLocationIdcompanyLocationId

•ID!

required

The location whose roles are being assigned.

Anchor to rolesToAssignrolesToAssign

•[CompanyLocationRoleAssign!]!

required

The roles to assign.

Show input fields

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.

Show fields
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

companyLocationAssignRoles reference

Mutation Reference

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

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

roleAssignments {

# CompanyContactRoleAssignment fields

}

userErrors {

field

message

}

Input

{

"companyLocationId": "gid://shopify/CompanyLocation/10079785100",

"rolesToAssign": [

{

"companyContactId": "gid://shopify/CompanyContact/10079785100",

"companyContactRoleId": "gid://shopify/CompanyContactRole/10079785100"

}

]

}

Variables

{
  "companyLocationId": "gid://shopify/CompanyLocation/10079785100",
  "rolesToAssign": [
    {
      "companyContactId": "gid://shopify/CompanyContact/10079785100",
      "companyContactRoleId": "gid://shopify/CompanyContactRole/10079785100"
    }
  ]
}

Schema

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