---
title: "Invite a user, or add an existing SoloFire user to this company"
method: POST
path: "/users"
tags: ["Users"]
---

# Invite a user, or add an existing SoloFire user to this company

`POST /users`

## Request

- Base URL: `https://developer.solofire.com/v1`
- URL: `https://developer.solofire.com/v1/users`
- Auth: HTTP bearer

Requires the `people.write` scope.

## Query parameters

- `role` string
- `status` string
- `q` string
- `limit` integer
- `cursor` string

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `email` string, required: Email address. If it already belongs to a SoloFire user they are added directly, with no invite email.
  - `first_name` string: Given name.
  - `last_name` string: Family name.
  - `role` string: One of user, contributor, manager, admin. Defaults to user. Granting admin or manager requires an admin-bound credential.
  - `team_ids` unknown[]: Teams to place them in. Applied on acceptance for invited users.
    - unknown
  - `send_email` boolean: Send the branded invite email. Defaults to true.

## Response `201`

Created

- object

## Other responses

- `401`: `unauthorized` No credential was presented. `invalid_token` The API key is unknown, revoked or malformed. `token_expired` The API key has passed its expiry.
- `403`: `insufficient_scope` The credential does not carry the required scope. `forbidden` The member this credential acts as lacks the permission. `feature_not_enabled` API access is not enabled for this company.
- `405`: `method_not_allowed` The path exists but not for this method.
- `409`: `conflict` The request conflicts with the current state.
- `413`: `payload_too_large` The request body is too large.
- `422`: `validation_failed` A parameter or body field is invalid.
- `429`: `rate_limited` The credential is over its request budget.
- `500`: `internal_error` Something went wrong on our side.

---

[API](https://skmtc.dev/solofire/apis/solofire-api.md) · [All operations](https://skmtc.dev/solofire/apis/solofire-api/llms.txt) · [OpenAPI document](https://skmtc.dev/solofire/apis/solofire-api/revisions/23e387532175?raw)