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

Anchor to section titled 'Arguments'

Arguments

Anchor to companyContactId companyContactId ID! required: The contact whose roles are being assigned.
Anchor to rolesToAssign rolesToAssign [CompanyContactRoleAssign!]! required: The new roles to assign.

Was this section helpful?

Anchor to section titled 'CompanyContactAssignRolesPayload returns'

CompanyContactAssignRolesPayload returns

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

Was this section helpful?

Code examples for MUTATION: companyContactAssignRoles

Query Reference for MUTATION: companyContactAssignRoles

"mutation companyContactAssignRoles($companyContactId: ID!, $rolesToAssign: [CompanyContactRoleAssign!]!) {\n  companyContactAssignRoles(companyContactId: $companyContactId, rolesToAssign: $rolesToAssign) {\n    roleAssignments {\n      # CompanyContactRoleAssignment fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: companyContactAssignRoles

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

Schema Reference for MUTATION: companyContactAssignRoles

"input CompanyContactRoleAssign {\n  companyContactRoleId: ID!\n  companyLocationId: ID!\n}\n"

Display Examples for MUTATION: companyContactAssignRoles

[]

companyContactAssignRolesmutation

Arguments

CompanyContactAssignRolesPayload returns

companyContactAssignRoles
mutation