Walletguide
DevelopersAPIReferenceinvitations

Create invitation

Needs users:manage, in a signed-in session (legacy addInvite). Send a role for its preset, or a role plus an exact permissions list; the grant may not…

POST
/wallets/{walletId}/invitations

Authorization

bearerAuth
headerAuthorization<token>

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

Path Parameters

walletId*string

The wallet row uuid

Formatuuid

Request Body

application/json
  1. body
role*string

The role to grant: editor (read and write everything, connect banks) or viewer (read everything). The owner role is never granted: a wallet has exactly one owner. With permissions the role is derived from the list instead.

Value in"editor""viewer"
permissions?array<>|

An exact permission list instead of the role's preset. A list equal to a preset is stored as that role. Omit or send null for the preset.

Items1 <= items
email*string
Length3 <= length

Response Body

The created invitation

application/json
  1. response
id*string
Formatuuid
firestoreId*string|null
email*string
role*string

A member's role in a wallet. The owner is the account holder: exactly one per wallet, full access, and the wallet follows their billing and account. An editor can view and edit the wallet's data; a viewer can only view it. Editor and viewer are also permission presets: a member or API key whose permissions is null holds its role's preset (see PermissionSchema).

Value in"owner""editor""viewer"
permissions*array<>|

The invited permission list; null means the role's preset.

expiresAt*string
Formatdate-time
sentAt*|
Formatdate-time
registeredUserId*|
Formatuuid
Example Request
curl -X POST 'https://api.walletguide.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/invitations' \  -H 'Content-Type: application/json' \  -d '{  "role": "editor",  "email": "string"}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "firestoreId": "string",  "email": "string",  "role": "owner",  "permissions": [    "assets:read"  ],  "expiresAt": "2019-08-24T14:15:22Z",  "sentAt": "2019-08-24T14:15:22Z",  "registeredUserId": "9b5bb18a-b942-4bb7-9fc9-1149f4954982"}