---
title: "Invite user"
method: POST
path: "/iam/v1/users/invite"
tags: ["Users"]
---

# Invite user

`POST /iam/v1/users/invite`

Invites a new user to the organization with specified role and organization.

## Request body

- InviteUserRequest — Request body to invite a new user to the organization.
  - `email` string, email, required — The email address of the user.
  - `firstName` string — The first name of the user being invited.
  - `lastName` string — The last name of the user being invited.
  - `jobTitle` 'Data Engineer / Data Analysts' | 'Executive Team' | 'Finance / Accounting' | 'Founder' | 'Legal / Purchasing' | 'Management' | 'Sales / Marketing' | 'Software / Ops Engineer' — The job function of the user being invited.
  - `roleId` string — The ID of the role to assign to the user.
  - `organizationId` string — The ID of the organization to assign the user to.

## Response `201`

Created - User invitation created successfully.

- InviteResponse — Response returned after creating a user invitation.
  - `message` string — Success message
  - `user` InvitedUserBody
    - `id` string — The unique ID of the invited user.
    - `email` string — The email address of the invited user.
    - `firstName` string — The first name of the invited user, if provided during invitation.
    - `lastName` string — The last name of the invited user, if provided during invitation.
    - `displayName` string — The display name of the invited user, if provided during invitation.
    - `jobTitle` string — The job function of the invited user, if provided during invitation.
    - `roleId` string — The ID of the role assigned to the user.
    - `organizationId` string — The ID of the organization assigned to the user.
    - `status` 'invited' — The status of the user (invited)

## Other responses

- `400` — Bad Request - The server cannot process the request, often due to a malformed request.
- `401` — Unauthorized - Invalid API key.
- `403` — Forbidden - The client is not authorized to perform the request.
- `500` — Internal Server Error - Something went wrong with the DoiT API server.

---

[API](https://skmtc.dev/doit/apis/doit-cloud-intelligence.md) · [All operations](https://skmtc.dev/doit/apis/doit-cloud-intelligence/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/doit/doit-cloud-intelligence/revisions/9416402fc119/schema)