The Budgets endpoints allow listing, creation and modification of user budgets.
With the learner budget feature, learners can buy activities using credits, see Learner budget feature. These endpoints let you grant and update those credits from your own system, instead of setting them per user in Control or through an automation.
Part of Web API v3 for user management. You need a token with the v3:budgets:read or v3:budgets:write scope, see Authenticating with the Web API v3.
đ§ Be careful
The Budget feature should be enabled on the platform in Settings to be able to use this endpoint.
Retrieving budgets
Use the GET /api/v3/public/user_budgets/ endpoint to retrieve a list of all user budgets.
Field | Description |
| The uuid of the user. |
đ Good to know
For the complete list of fields on this endpoint, open the interactive documentation at https://<platform name>.platform.co.nl/api/v3/public/docs/. The schema there is always current.
Creating budgets
POST a user UUID and budget to /api/v3/public/user_budgets/ to add a budget to a user.
Modifying budgets
With a PUT or PATCH request to /api/v3/public/user_budgets/<user_uuid>/ you can modify an existing budget.
The PUT requires all writable fields to be included, while the PATCH only updates provided fields.
âď¸ Tip
Learners are not automatically notified when their credits change. If you grant budget through the API, consider notifying them from your own system or setting up a platform notification.