API Reference

Update Purse – Updates the details of a specific purse.

put
https://example.com/programs//accounts//purses/

Updates the details of a specific purse, such as description, goal amount, icon, and round-up settings. Returns the updated purse details.

Path Params
string
required

The unique code identifying the partner program context.

string
required

The unique identifier of the account whose purse is being updated.

string
required

The unique identifier of the purse to update.

Body Params

The Gd.Bos.DataTransfer.Request.UpdatePurseRequest object containing updated purse details, such as description, goal amount, and round-up settings.

boolean | null

Indicates whether the purse is hidden.

string | null

The description of the purse.

string | null

The icon name for the purse.

string | null

The goal amount for the purse.

string | null

The goal date for the purse (YYYY-MM-DD).

string | null

The sub-type of the purse.

boolean

Indicates whether round-up is enabled for the purse.

Headers
string
required

The unique request identifier (GUID) for tracking and idempotency. Required in the X-GD-RequestId header.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago