Add or invite a user to one of the agency's client companies.

If the email belongs to an existing Bokio user, the user is added directly to the company. Otherwise, a pending invitation is created and an email is sent. The integrator is responsible for ensuring that only users who are valid and authorized in its system are added to the company or sent invitations.

The invitation is sent on behalf of a company user, who is named as the inviter in the email and on the page where the invitation is accepted. By default this is the company owner. Use inviterUserId to send it on behalf of another company user. That user must have permission to manage users in the company, otherwise a 400 validation error is returned. If the company has no owner, inviterUserId is required and a 400 validation error is returned when it is omitted.

Scope: agency-users:write

{
  "email": "user@example.com",
  "inviterUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
}

{
  "operation": "added",
  "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "email": "staff@agency.com",
  "status": "active"
}