---
title: "Invite a user to join the platform"
method: POST
path: "/api/v1/users/invitations"
tags: ["Users"]
---

# Invite a user to join the platform

`POST /api/v1/users/invitations`

Required scope - write_user. Assigning a privileged role (e.g. super_admin) additionally requires the caller to hold the root scope.

## Request body

- object
  - `email` string, email, required — The email address to invite
  - `firstName` string — Optional first name
  - `lastName` string — Optional last name
  - `locale` string — Locale for the invitation email
  - `orgSlug` string — Organization slug to assign the user to
  - `roles` string[] — Roles to assign to the invited user
  - `signinUrl` string — URL to redirect the user to after accepting the invitation

## Response `200`

- object
  - `user` UserDetail
    - `id` number, required
    - `authId` string, required
    - `email` string, nullable, required
    - `linkedAuthId` string, nullable
    - `socialAccountId` string, nullable, required
    - `socialAccountType` string, nullable, required
    - `firstName` string, nullable, required
    - `lastName` string, nullable, required
    - `locale` string, required
    - `loginCount` number, required
    - `mfaTypes` string[], required
    - `emailVerified` boolean, required
    - `otpVerified` boolean, required
    - `smsPhoneNumberVerified` boolean, required
    - `isActive` boolean, required
    - `isInviting` boolean, required
    - `invitationExpiresAt` string, nullable
    - `createdAt` string, required
    - `updatedAt` string, required
    - `deletedAt` string, nullable, required
    - `roles` string[], nullable, required
    - `org` object, nullable
      - `id` number
      - `name` string
      - `slug` string
    - `orgGroups` object[], nullable
      - `id` number
      - `name` string
    - `attributes` object, nullable

---

[API](https://skmtc.net/valuemelody/apis/melody-auth-s2s-api.md) · [All operations](https://skmtc.net/valuemelody/apis/melody-auth-s2s-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/valuemelody/melody-auth-s2s-api/versions/2e1471620fd7/schema)