Skip to main content

addPerson

Add Person​

This mutation adds a new user to a company and assigns it the provided roles. If the person is not registered, an invitation email is sent. If the person is not related to the company, an employee relationship is created.

The operation is processed asynchronously via background job. Use processId (the person's party id) in the response to get notifications via subscriptions.

Authentication​

Requires authentication and the products:update_sales_channels permission.

Possible Errors​

  • **Company not found**: The specified company doesn't exist
  • **Party must be a person**: The login identifier does not match a party of type person
  • **Role type not found**: The role type doesn't exist
  • **Role type domain invalid**: The role type domain entity doesn't match the provided company
  • **Invalid role type**: The person already has one of the provided roles
  • **Unauthorized**: User lacks the required permission
addPerson(
  input: AddPersonInput!
): AsynchronousActionResponse!

Arguments​

addPerson.input ● AddPersonInput! non-null input​

Parameters for AddPerson

Type​

AsynchronousActionResponse object​

Asynchronous action response type