---
title: "Create an UMA invitation from a given platform user."
method: POST
path: "/invitations"
tags: ["Invitations"]
---

# Create an UMA invitation from a given platform user.

`POST /invitations`

Create an UMA invitation from a given platform user.

## Request body

- object
  - `inviterUma` string, required — The UMA address of the user creating the invitation
  - `firstName` string — First name of the inviter to show as part of the invite
  - `amountToSend` integer — An amount to send (in the smallest unit of the user's currency) to the invitee when the invitation is claimed. This is optional and if not provided, the invitee will not receive any amount. Note that the actual sending of the amount must be done by the inviter platform once the INVITATION_CLAIMED webhook is received. If the inviter platform either does not send the payment or the payment fails, the invitee will not receive this amount. This field is primarily used for display purposes on the claiming side of the invitation.
  - `expiresAt` string, date-time — When the invitation expires (if at all)

## Response `201`

Invitation created successfully

- UmaInvitation
  - `code` string, required — The unique code of the invitation
  - `createdAt` string, date-time, required — When the invitation was created
  - `claimedAt` string, date-time — When the invitation was claimed if it has been claimed
  - `url` string, required — The URL where this invitation can be claimed.
  - `expiresAt` string, date-time — When the invitation expires (if at all)
  - `inviterUma` string, required — The UMA address of the inviter
  - `inviteeUma` string — The UMA address of the invitee
  - `status` 'PENDING' | 'CLAIMED' | 'EXPIRED' | 'CANCELLED', required — The status of the invitation
  - `firstName` string — The inviter's first name. Will be displayed when the recipient clicks the invite link
  - `amountToSend` CurrencyAmount
    - `amount` integer, required — Amount in the smallest unit of the currency (e.g., cents for USD/EUR, satoshis for BTC)
    - `currency` Currency, required
      - `code` string — Three-letter currency code (ISO 4217) for fiat currencies. Some cryptocurrencies may use their own ticker symbols (e.g. "SAT" for satoshis, "USDC" for USDCoin, etc.)
      - `name` string — Full name of the currency
      - `symbol` string — Symbol of the currency
      - `decimals` integer — Number of decimal places for the currency
  - `inviteeCountryCode` string — The country of the invitee (ISO 3166-1 alpha-2 code). Only available for CLAIMED invitations when provided by the invitee.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `500` — Internal service error

---

[API](https://skmtc.net/lightsparkdev/apis/uma-as-a-service-umaaas-api.md) · [All operations](https://skmtc.net/lightsparkdev/apis/uma-as-a-service-umaaas-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightsparkdev/uma-as-a-service-umaaas-api/revisions/2e2b5ba6d69b/schema)