Walletguide
DevelopersAPIReferenceinvitations

Create invitation

Owner only, and a signed-in person rather than an API key (legacy addInvite; matches the sharing UI, which shows member management to owners only).

POST
/wallets/{walletId}/invitations

Authorization

bearerAuth
Authorization<token>

A Walletguide API key (wg_…) or an OAuth bearer token. Paste the value only. Create a key under Wallet settings → API keys.

In: header

Path Parameters

walletId*string

The wallet row uuid

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/invitations" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "role": "owner"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "firestoreId": "string",  "email": "string",  "role": "owner",  "expiresAt": "2019-08-24T14:15:22Z",  "sentAt": "2019-08-24T14:15:22Z",  "registeredUserId": "9b5bb18a-b942-4bb7-9fc9-1149f4954982"}

List invitations

List a wallet's invitations with the Walletguide REST API. Parameters, response fields, and a playground you can run.

Delete invitation

Owner only, and a signed-in person rather than an API key (legacy deleteInvite).