LIlightsparkdev
Invitations

Cancel an UMA invitation

Changed on

Cancel a pending UMA invitation. Only the inviter or platform can cancel an invitation.

When an invitation is cancelled:

  1. The invitation status changes from PENDING to CANCELLED
  2. The invitation can no longer be claimed
  3. The invitation URL will show as cancelled when accessed

Only pending invitations can be cancelled. Attempting to cancel an invitation that is already claimed, expired, or cancelled will result in an error.

post/invitations/{invitationCode}/cancel

Request

  • Base URL
    https://api.uma.money/umaaas/2025-05-15
  • URL
    https://api.uma.money/umaaas/2025-05-15/invitations/{invitationCode}/cancel
  • Auth
    HTTP basic

Path parameters

invitationCodestring required

The code of the invitation to cancel

Response

Invitation cancelled successfully

codestring required

The unique code of the invitation

createdAtstring date-time required

When the invitation was created

claimedAtstring date-time

When the invitation was claimed if it has been claimed

urlstring required

The URL where this invitation can be claimed.

expiresAtstring date-time

When the invitation expires (if at all)

inviterUmastring required

The UMA address of the inviter

inviteeUmastring

The UMA address of the invitee

status'PENDING' | 'CLAIMED' | 'EXPIRED' | 'CANCELLED' required

The status of the invitation

firstNamestring

The inviter's first name. Will be displayed when the recipient clicks the invite link

inviteeCountryCodestring

The country of the invitee (ISO 3166-1 alpha-2 code). Only available for CLAIMED invitations when provided by the invitee.

Example response

{
  "code": "019542f5",
  "createdAt": "2023-09-01T14:30:00Z",
  "claimedAt": "2023-09-01T14:30:00Z",
  "url": "https://uma.me/i/019542f5",
  "expiresAt": "2023-09-01T14:30:00Z",
  "inviterUma": "$inviter@uma.domain",
  "inviteeUma": "$invitee@uma.domain",
  "status": "PENDING",
  "firstName": "Jane",
  "amountToSend": {
    "amount": 12550,
    "currency": {
      "code": "USD",
      "name": "United States Dollar",
      "symbol": "$",
      "decimals": 2
    }
  },
  "inviteeCountryCode": "US"
}

Changes

  • aa2c7b1aaf8aRevision changes
    • warning

      added the new CORRIDOR_UNDER_MAINTENANCE enum value to the response property for the response status

  • 53c9091c5ef4Revision changes
    • warning

      added the new SANCTION_BLOCKED enum value to the response property for the response status