Walletguide
DevelopersAPIReferenceplanItems

Update plan item

Update a plan item with the Walletguide REST API. Parameters, response fields, and a playground you can run.

PATCH
/wallets/{walletId}/planItems/{id}

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

Row uuid

Formatuuid
id*string

Row uuid

Formatuuid

Request Body

application/json
  1. body
scenarioId?|

Row uuid

Formatuuid
month?string
Match^\d{4}-\d{2}$
categoryOrCategoryGroupId?string

Row uuid

Formatuuid
amount?
duration?integer|null
frequency?integer

Response Body

The updated plan item

application/json
  1. response
id*string
Formatuuid
walletId*string
Formatuuid
firestoreId*string|null
scenarioId*|
Formatuuid
month*string
categoryOrCategoryGroupId*string
Formatuuid
amount*string|number|boolean|null||array<unknown>
duration*|
Range-2147483648 <= value <= 2147483647
frequency*integer
Range-2147483648 <= value <= 2147483647
createdTime*|
Formatdate-time
createdUserId*string|null
lastUpdatedTime*|
Formatdate-time
lastUpdatedUserId*string|null
Example Request
curl -X PATCH 'https://api.walletguide.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/planItems/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",  "firestoreId": "string",  "scenarioId": "e28e2f4c-7202-4457-b0d8-c4c537f7bff6",  "month": "string",  "categoryOrCategoryGroupId": "ede83f0b-08f4-4cfa-bc06-98787e881327",  "amount": "string",  "duration": -2147483648,  "frequency": -2147483648,  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}