Walletguide
DevelopersAPIReferencescenarioChangeEvents

Create scenario change event

Create a scenario change event with the Walletguide REST API. Parameters, response fields, and a playground you can run.

POST
/wallets/{walletId}/scenarioChangeEvents

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

Row uuid

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/scenarioChangeEvents" \  -H "Content-Type: application/json" \  -d '{    "scenarioId": "e28e2f4c-7202-4457-b0d8-c4c537f7bff6",    "name": "string",    "categoryId": "string",    "startMonth": "string",    "active": true  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",  "scenarioId": "e28e2f4c-7202-4457-b0d8-c4c537f7bff6",  "firestoreId": "string",  "name": "string",  "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",  "startMonth": "string",  "ongoingBase": "string",  "ongoingPercentageChangePerYear": -140737488355328,  "oneTime": "string",  "active": true}

List scenario change events

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

Retrieve scenario change event

Retrieve one scenario change event by id with the Walletguide REST API. Parameters, response fields, and a playground you can run.