---
title: "Add or invite a user to a client company"
method: POST
path: "/agencies/{agencyId}/companies/{companyId}/add-or-invite-user"
tags: ["agency-users"]
---

# Add or invite a user to a client company

`POST /agencies/{agencyId}/companies/{companyId}/add-or-invite-user`

## Request

- Base URL: `https://api.bokio.se/v1`
- URL: `https://api.bokio.se/v1/agencies/{agencyId}/companies/{companyId}/add-or-invite-user`
- Auth: HTTP bearer

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`

## Request body

- CompanyUserInvitationWriteModel
  - `email` string, email, required: Email address of the user to invite
  - `inviterUserId` string, 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.

## Response `200`

User added or invited

- AddOrInviteUserGetModel
  - `operation` 'added' | 'invited', required: The operation performed for the requested email address: - `added`: The email belongs to an existing Bokio user who was added to the company. - `invited`: No Bokio user exists for the email, so a pending invitation was created.
  - `id` string, uuid, required: Unique identifier for the user or invitation, depending on the operation
  - `email` string, email, required: Email address of the user or invitation
  - `status` 'active' | 'pendingInvitation', required: Status of the user or invitation

## Other responses

- `400`: Validation error
- `404`: Company client is not found under this agency

---

[API](https://skmtc.dev/bokio/apis/agency-api.md) - [All operations](https://skmtc.dev/bokio/apis/agency-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bokio/apis/agency-api/revisions/2ec5b299f1d5?raw)