companyContactAssignRole
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 a role to a contact for a location.

Anchor to section titled 'Arguments'

Arguments

Anchor to companyContactId companyContactId ID! required: The ID of the contact to assign a role to.
Anchor to companyContactRoleId companyContactRoleId ID! required: The ID of the role to assign to a contact.
Anchor to companyLocationId companyLocationId ID! required: The ID of the location to assign a role to a contact.

Was this section helpful?

Anchor to section titled 'CompanyContactAssignRolePayload returns'

CompanyContactAssignRolePayload returns

Anchor to CompanyContactAssignRolePayload.companyContactRoleAssignment companyContactRoleAssignment CompanyContactRoleAssignment: The company contact role assignment.
Anchor to CompanyContactAssignRolePayload.userErrors userErrors [BusinessCustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: companyContactAssignRole

Query Reference for MUTATION: companyContactAssignRole

"mutation companyContactAssignRole($companyContactId: ID!, $companyContactRoleId: ID!, $companyLocationId: ID!) {\n  companyContactAssignRole(companyContactId: $companyContactId, companyContactRoleId: $companyContactRoleId, companyLocationId: $companyLocationId) {\n    companyContactRoleAssignment {\n      # CompanyContactRoleAssignment fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: companyContactAssignRole

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

Schema Reference for MUTATION: companyContactAssignRole

""

Display Examples for MUTATION: companyContactAssignRole

[]

companyContactAssignRolemutation

Arguments

CompanyContactAssignRolePayload returns

companyContactAssignRole
mutation