patchSavehackLaunch

PATCH 
/savehack-launches/:id

Update an existing Savehack Launch

Request

Path Parameters

id uuidrequired

application/json

Body

required

savehackLaunch

object

Partial SavehackLaunch, only containing the fields that should be updated. The savehackLaunch.SavehackLaunch schema is re-used for simplicity here, but required fields can be ignored - all fields are optional.

oneOf

savehackLaunch.AutopilotLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [AutopilotLaunch]

savehackLaunch.DailyLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [DailyLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

savehackLaunch.WeeklyLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [WeeklyLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

dayOfWeek integerrequired

Possible values: <= 6

Determines which day of the week the SavehackLaunch should create a Deposit.

savehackLaunch.MonthlyLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [MonthlyLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

dayOfMonth integerrequired

Possible values: >= 1 and <= 31

Determines which day of the month the SavehackLaunch should create a Deposit.

savehackLaunch.ThiefLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [ThiefLaunch]

minCents integerrequired

Possible values: >= 1

The lower boundary (inclusive) for the amount (in cents or the smallest currency subunit) that will be Deposited.

maxCents integerrequired

Possible values: <= 9223372036854776000

The upper boundary (inclusive) for the amount (in cents or the smallest currency subunit) that will be Deposited.

savehackLaunch.RocketLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [RocketLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

savehackLaunch.OneTimeLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [OneTimeLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

savehackLaunch.RouletteLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [RouletteLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

savehackLaunch.MoonstruckLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [MoonstruckLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

savehackLaunch.PercentageLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [PercentageLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

dayOfMonth integerrequired

Possible values: >= 1 and <= 31

Determines which day of the month the launch should happen

savehackLaunch.EverestLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [EverestLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

incrementCents integer

Possible values: >= 1

The amount (in cents or the smallest currency subunit) by which each weekly Deposit grows over the previous one. Optional — when omitted, each weekly Deposit grows by cents instead.

dayOfWeek integerrequired

Possible values: <= 6

Determines which day of the week the launch should happen

savehackLaunch.CalendarChaosLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [CalendarChaosLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

savehackLaunch.SaveLeagueLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [SaveLeagueLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

reference stringrequired

Used in saveleague savehack to determine the selected team.

savehackLaunch.EurocupLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [EurocupLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

savehackLaunch.CopycatLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [CopycatLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

savehackLaunch.RoundupLaunchUnrequired

id uuid

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

type stringrequired

Possible values: [RoundupLaunch]

Responses

200

Update was successful

application/json

Schema

Schema

savehackLaunch

object

oneOf

schemas-savehackLaunch.AutopilotLaunch

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [AutopilotLaunch]

schemas-savehackLaunch.DailyLaunch

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [DailyLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

schemas-savehackLaunch.WeeklyLaunch

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [WeeklyLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

dayOfWeek integerrequired

Possible values: <= 6

Determines which day of the week the SavehackLaunch should create a Deposit.

schemas-savehackLaunch.MonthlyLaunch

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [MonthlyLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

dayOfMonth integerrequired

Possible values: >= 1 and <= 31

Determines which day of the month the SavehackLaunch should create a Deposit.

schemas-savehackLaunch.ThiefLaunch

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [ThiefLaunch]

minCents integerrequired

Possible values: >= 1

The lower boundary (inclusive) for the amount (in cents or the smallest currency subunit) that will be Deposited.

maxCents integerrequired

Possible values: <= 9223372036854776000

The upper boundary (inclusive) for the amount (in cents or the smallest currency subunit) that will be Deposited.

schemas-savehackLaunch.RocketLaunch

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [RocketLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

schemas-savehackLaunch.OneTimeLaunch

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [OneTimeLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

schemas-savehackLaunch.RouletteLaunch

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [RouletteLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

schemas-savehackLaunch.MoonstruckLaunch

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [MoonstruckLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

schemas-savehackLaunch.PercentageLaunch

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [PercentageLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

dayOfMonth integerrequired

Possible values: >= 1 and <= 31

Determines which day of the month the launch should happen

schemas-savehackLaunch.EverestLaunch

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [EverestLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

incrementCents integer

Possible values: >= 1

The amount (in cents or the smallest currency subunit) by which each weekly Deposit grows over the previous one. Optional — when omitted, each weekly Deposit grows by cents instead.

dayOfWeek integerrequired

Possible values: <= 6

Determines which day of the week the launch should happen

schemas-savehackLaunch.CalendarChaosLaunch

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [CalendarChaosLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

schemas-savehackLaunch.SaveLeagueLaunch

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [SaveLeagueLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

reference stringrequired

Used in saveleague savehack to determine the selected team.

team string

SaveLeague team name. Derived from reference and returned for reference — it is not accepted when creating or updating the launch.

schemas-savehackLaunch.EurocupLaunch

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [EurocupLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

schemas-savehackLaunch.CopycatLaunch

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [CopycatLaunch]

cents savehackLaunch.Cents (integer)required

Possible values: >= 1 and <= 9223372036854776000

How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.

savehackLaunch.RoundupLaunch

A SavehackLaunch that rounds each incoming payment up to the nearest unit and deposits the difference, optionally multiplied. Unlike the scheduled launches, it is event-based: a Deposit is created whenever a matching payment is received for the User, rather than on a fixed schedule.

id uuidrequired

dream

object

required

id uuid

targetCents integer

Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

type string

expiresAt datenullable

(Optional) Date before which the User wants to complete this Dream.

achievedAt RFC3339

Represents when the dream was completed

name string

balanceCents integer

Current balance cents for dream

deletedAt RFC3339

Represents when the dream was deleted

imageUrl string

activeSavehacksCount integer

Current count of active savehacks

user

object

type stringrequired

id stringrequired

externalId string

groupDream

object

(Optional) GroupDream this Dream is a part of.

type stringrequired

id stringrequired

account

object

Identifies the account where all money towards this dream is stored

type stringrequired

id stringrequired

externalId string

savehack

object

required

type stringrequired

id stringrequired

guidance_name stringrequired

translated_name

object

required

[locale] string

stoppedAt RFC3339nullable

pausedAt RFC3339nullable

dreamInspiration

object

nullable

(Optional) The Dream Inspiration associated with this launch's Dream.

id uuidrequired

translatedName

object

[locale] string

targetCents integer

Possible values: >= 1 and <= 9223372036854776000

Default value: 0

durationSeconds integer

imageUrl string

type stringrequired

Possible values: [DreamInspiration]

type stringrequired

Possible values: [RoundupLaunch]

multiplier integer

Possible values: >= 1 and <= 10

The factor the rounded-up amount is multiplied by before it is deposited. Configured on the Roundup Savehack and returned here for reference — it is not accepted when creating or updating the launch.

nearestUnit integer

Possible values: >= 1

The unit (in cents or the smallest currency subunit) that each incoming payment is rounded up to before the multiplier is applied. Configured on the Roundup Savehack and returned here for reference — it is not accepted when creating or updating the launch.

Example (from schema)

{}

400

Bad request

application/json

Schema

Schema

errors

object[]

required

Array [

field stringrequired

errors string[]required

]

Example (from schema)

{
  "errors": [
    {
      "field": "string",
      "errors": [
        "string"
      ]
    }
  ]
}

Example

{
  "errors": [
    {
      "field": "savehackLaunch.cents",
      "errors": [
        "can't be negative"
      ]
    }
  ]
}

404

Savehack launch not found

Loading...