---
title: "Create a user invitation"
method: POST
path: "/v1/user_invitations"
tags: ["User Invitations"]
---

# Create a user invitation

`POST /v1/user_invitations`

## Request

- Base URL: `https://identity-api.paymongo.com`
- URL: `https://identity-api.paymongo.com/v1/user_invitations`
- Auth: none required

Invites a user (by email) to join the authenticated caller's organization with the specified roles.

## Request body

- UserCreateUserInvitationRequestEnvelopeDTO
  - `data` object
    - `attributes` UserCreateUserInvitationRequestDTO
      - `email` string, required
      - `roles` string[], required

## Response `201`

Created

- object: Standard response containing data and its metadata if any
  - `data` object
    - `attributes` UserInvitationAttributesDTO
      - `created_at` integer
      - `email` string
      - `expires_at` integer
      - `organization_id` string
      - `organization_trade_name` string
      - `roles` string[]
      - `status` string
      - `token` string
      - `updated_at` integer
    - `id` string
    - `type` string
  - `has_more` boolean

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `422`: Unprocessable Entity
- `500`: Internal Server Error

---

[API](https://skmtc.dev/paymongo/apis/identity.md) - [All operations](https://skmtc.dev/paymongo/apis/identity/llms.txt) - [OpenAPI document](https://skmtc.dev/paymongo/apis/identity/revisions/cc3056164874?raw)