Update a Savings Event

patch

https://api.zylo.com/v2/savingsEvents/{savingsEventId}

Required Permissions

applications:write

Rate Limit

limited

Path Params

savingsEventId

string

required

Stringified UUIDv4.

Body Params

application_id

string | null

Stringified UUIDv4.

description

string | null

Description of the savings event.

event_type

string

Type of the savings event.

exclude_from_event_total

boolean | null

If checked, event will be excluded from aggregated event statistics and total event count.

monetary_value

string | null

Monetary value of the savings event.

name

string

Name of the savings event.

notes

string | null

Notes of the savings event.

numerical_value

string | null

The numerical value of the savings event. This must be not null if the unit of measure is not null.

transaction_date

date

Date of the transaction for the savings event.

unit_of_measure

string | null

enum

The unit of measure for the numerical value of the savings event. This must be not null if the numerical value is not null.

Allowed:

value_type

string | null

enum

The value type category for the savings event.

Allowed:

Response

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok