companyContactAssignRoles

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 contact.

Arguments

Anchor to companyContactIdcompanyContactId • ID!required: The contact whose roles are being assigned.
Anchor to rolesToAssignrolesToAssign • [CompanyContactRoleAssign!]!required: The new roles to assign.

Was this section helpful?

Anchor to CompanyContactAssignRolesPayload returnsCompanyContactAssignRolesPayload 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

1mutation companyContactAssignRoles($companyContactId: ID!, $rolesToAssign: [CompanyContactRoleAssign!]!) {
2  companyContactAssignRoles(companyContactId: $companyContactId, rolesToAssign: $rolesToAssign) {
3    roleAssignments {
4      # CompanyContactRoleAssignment fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "companyContactId": "gid://shopify/<objectName>/10079785100",
3  "rolesToAssign": [
4    {
5      "companyContactRoleId": "gid://shopify/<objectName>/10079785100",
6      "companyLocationId": "gid://shopify/<objectName>/10079785100"
7    }
8  ]
9}

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

input CompanyContactRoleAssign {
  companyContactRoleId: ID!
  companyLocationId: ID!
}