companyContactAssignRole

mutation

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.

Arguments

Anchor to companyContactIdcompanyContactId • ID!required: The ID of the contact to assign a role to.
Anchor to companyContactRoleIdcompanyContactRoleId • ID!required: The ID of the role to assign to a contact.
Anchor to companyLocationIdcompanyLocationId • ID!required: The ID of the location to assign a role to a contact.

Was this section helpful?

Anchor to CompanyContactAssignRolePayload returnsCompanyContactAssignRolePayload returns

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

Was this section helpful?

Mutation Reference

mutation companyContactAssignRole($companyContactId: ID!, $companyContactRoleId: ID!, $companyLocationId: ID!) {

companyContactAssignRole(companyContactId: $companyContactId, companyContactRoleId: $companyContactRoleId, companyLocationId: $companyLocationId) {

companyContactRoleAssignment {

# CompanyContactRoleAssignment fields

}

userErrors {

field

message

}

Input

{

"companyContactId": "gid://shopify/<objectName>/10079785100",

"companyContactRoleId": "gid://shopify/<objectName>/10079785100",

"companyLocationId": "gid://shopify/<objectName>/10079785100"

}

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