---
title: "Create Wallet Invite"
method: POST
path: "/wallet/{walletId}/invite"
tags: ["Invites"]
---

# Create Wallet Invite

`POST /wallet/{walletId}/invite`

This API method allows the calling application to create new Wallet Invite for a specific wallet.

## Path parameters

- `walletId` string, string, required

## Request body

- WalletInviteCreatePayload
  - `description` string — Invite description
  - `reference` string — Invite reference
  - `state` string — Invite state
  - `type` string — Type of the Invite
  - `status` 'ACTIVE' | 'EXPIRED' | 'CANCELLED' | 'ACCEPTED' | 'REJECTED' — Wallet Transaction status
  - `meta` MetaEntity
    - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value
    - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value
  - `validFrom` string — Date this invite is valid from
  - `validTo` string — Date this invite is valid to

## Response `201`

Created

- WalletInviteEntity
  - `walletInviteId` string — Invite ID
  - `walletId` string — The Wallet ID
  - `guid` string — Invite GUID
  - `description` string — Invite description
  - `reference` string — Invite reference
  - `status` 'ACTIVE' | 'CANCELLED' | 'EXPIRED' | 'ACCEPTED' | 'REJECTED' — Invite status
  - `state` string — Invite state
  - `type` string — Type of the Invite
  - `meta` MetaEntity
    - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value
    - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value
  - `validFrom` string — Date this invite is valid from
  - `validTo` string — Date this invite is valid to
  - `dateCreated` string — Date this invite was created
  - `lastUpdated` string — Date this invite was last updated

## Other responses

- `400` — Bad Request.
- `401` — Unauthorized.
- `404` — Not Found.
- `409` — Conflict
- `415` — Unsupported Media Type
- `423` — Locked
- `429` — Too Many Requests
- `500` — Server Error

---

[API](https://skmtc.net/eagleeye/apis/wallet-api.md) · [All operations](https://skmtc.net/eagleeye/apis/wallet-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeye/wallet-api/versions/90a122bb14cc/schema)