v1

latestOpenAPI 3.0.12026-07-243407211.3 MB

Purse

Update Purse – Updates the details of a specific purse.

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

put/programs/{programCode}/accounts/{accountIdentifier}/purses/{purseIdentifier}

programCodestring required

The unique code identifying the partner program context.

accountIdentifierstring required

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

purseIdentifierstring required

The unique identifier of the purse to update.

X-GD-RequestIdstring required

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

isHiddenboolean nullable

Indicates whether the purse is hidden.

descriptionstring nullable

The description of the purse.

iconNamestring nullable

The icon name for the purse.

goalAmountstring nullable

The goal amount for the purse.

goalDatestring nullable

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

purseSubTypestring nullable

The sub-type of the purse.

isRoundUpboolean

Indicates whether round-up is enabled for the purse.