---
title: "Invite new user"
method: POST
path: "/iam/clients/invite_user"
tags: ["Users"]
---

# Invite new user

`POST /iam/clients/invite_user`

Invite a user to the account.

User will receive an email.
The new user will receive an invitation email with a link to create an account password,
the existing user will be notified about the invitation to the account.

## Request body

- InviteUserRequest
  - `email` string, email, required — User email.
  - `user_role` Group, required
    - `id` integer — Group's ID: Possible values are: - 1 - Administrators* 2 - Users* 5 - Engineers* 3009 - Purge and Prefetch only (API+Web)* 3022 - Purge and Prefetch only (API)
    - `name` 'Users' | 'Administrators' | 'Engineers' | 'Purge and Prefetch only (API)' | 'Purge and Prefetch only (API+Web)' — Group's name.
  - `client_id` integer, required — ID of account.
  - `lang` 'de' | 'en' | 'ru' | 'zh' | 'az' — User's language. Defines language of the control panel and email messages.
  - `name` string — User name.

## Response `200`

OK.

- InviteUserResponseSchema
  - `status` string, required — Status of the invitation.
  - `user_id` integer, required — Invited user ID.

## Other responses

- `400` — Validation error.
- `401` — Authentication credentials were not provided or given token not valid for any token type.
- `403` — You do not have permission to perform this action.

---

[API](https://skmtc.dev/g-core/apis/gcore-openapi.md) · [All operations](https://skmtc.dev/g-core/apis/gcore-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/g-core/gcore-openapi/revisions/09e652815095/schema)