---
title: "Creates an invitation to allow a new team member to join an existing service."
method: POST
path: "/v1/api/invites/user"
tags: ["Invites"]
---

# Creates an invitation to allow a new team member to join an existing service.

`POST /v1/api/invites/user`

## Request body

- InviteUserRequest
  - `email` string, required
  - `role_name` string, required
  - `sender` string, required — User external ID
  - `service_external_id` string, required

## Response `201`

Created

- Invite
  - `_links` Link[]
    - `href` string
    - `method` string
    - `rel` string
  - `attempt_counter` integer
  - `disabled` boolean
  - `email` string
  - `expired` boolean
  - `inviteLink` string
  - `otp_key` string
  - `password_set` boolean
  - `role` string
  - `telephone_number` string
  - `type` string
  - `user_exist` boolean

## Other responses

- `404` — Service or role not found
- `422` — Missing required fields or invalid values

## Changes

- **2022-11-21** `229276ff8ff8` — 1 info
  - added the optional property `otp_key` to the response with the `201` status
- **2022-11-21** `e138c649db69` — 1 warning
  - removed the optional property `otp_key` from the response with the `201` status
- **2022-11-21** `c07ac6503216` — 1 info
  - added the optional property `otp_key` to the response with the `201` status
- **2022-11-17** `a80785172230` — 1 warning
  - removed the optional property `otp_key` from the response with the `201` status
- **2022-11-17** `1b5fc1d6d048` — 1 info
  - added the optional property `otp_key` to the response with the `201` status

[Full history](https://skmtc.dev/government-digital-service/apis/adminusers-api/changes/v1/api/invites/user/post.md)

---

[API](https://skmtc.dev/government-digital-service/apis/adminusers-api.md) · [All operations](https://skmtc.dev/government-digital-service/apis/adminusers-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/government-digital-service/adminusers-api/revisions/bfcb778ae13e/schema)