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

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

`POST /v1/api/invites/create-invite-to-join-service`

## Request body

- CreateInviteToJoinServiceRequest
  - `email` string, email, required
  - `role_name` 'admin' | 'view-and-refund' | 'view-only' | 'view-and-initiate-moto' | 'view-refund-and-initiate-moto' | 'super-admin', 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
  - `is_invite_to_join_service` boolean
  - `otp_key` string
  - `password_set` boolean
  - `role` string
  - `telephone_number` string
  - `user_exist` boolean

## Other responses

- `404` — Service or role not found
- `409` — Invite has already been sent to the corresponding email address
- `412` — User is already registered on the service
- `422` — Missing required fields or invalid values

---

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