companyLocationAssignRoles
mutation

Choose a version:

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.

Anchor to section titled 'Arguments'

Arguments

Anchor to companyLocationId companyLocationId ID! required: The location whose roles are being assigned.
Anchor to rolesToAssign rolesToAssign [CompanyLocationRoleAssign!]! required: The roles to assign.

Was this section helpful?

Anchor to section titled 'CompanyLocationAssignRolesPayload returns'

CompanyLocationAssignRolesPayload returns

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

Was this section helpful?

Code examples for MUTATION: companyLocationAssignRoles

Query Reference for MUTATION: companyLocationAssignRoles

"mutation companyLocationAssignRoles($companyLocationId: ID!, $rolesToAssign: [CompanyLocationRoleAssign!]!) {\n  companyLocationAssignRoles(companyLocationId: $companyLocationId, rolesToAssign: $rolesToAssign) {\n    roleAssignments {\n      # CompanyContactRoleAssignment fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: companyLocationAssignRoles

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

Schema Reference for MUTATION: companyLocationAssignRoles

"input CompanyLocationRoleAssign {\n  companyContactId: ID!\n  companyContactRoleId: ID!\n}\n"

Display Examples for MUTATION: companyLocationAssignRoles

[]

companyLocationAssignRolesmutation

Arguments

CompanyLocationAssignRolesPayload returns

companyLocationAssignRoles
mutation