Add or invite a user to a client company

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

Path Params
uuid
required

The unique identifier for the agency

uuid
required

The unique identifier for the client company

Body Params
string
required

Email address of the user to invite

uuid

Unique identifier of the company user sending the invitation. The user must be a member of the company with permission to manage users. Defaults to the company owner when omitted, and is required when the company has no owner. The inviter is named in the invitation email and on the page where the invitation is accepted.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json