Skip to main content

Create a new Dream.

POST 
/dreams

Create a new Dream.

Request​

Body

required

Dream details

    dream

    object

    targetCents integer

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

    type string

    Possible values: [Dream]

    Default value: Dream

    expiresAt ISO-8601 Date (extended format with separators)

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

    name string
    userId uuidrequired

    This is the owner of the dream

    groupDreamId string

    (Optional) GroupDream this Dream is a part of.

    accountId string

    The Account connected to this Dream. It is not required to create a Dream, but must be added before any deposit can be made.

Responses​

Dream created

Schema

    dream

    object

    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 ISO-8601 Date (extended format with separators)

    (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
Loading...