Skip to main content

Update an existing Dream.

PATCH 

/dreams/:id

Update an existing Dream.

Request

Path Parameters

    id uuidrequired

Body

required

Partial Dream, only containing the fields that should be updated.

    dream

    object

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

    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

Responses

Update was successful

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

    DateTime when the dream was completed.

    name string

    user

    object

    type stringrequired
    id stringrequired
    externalId string

    groupDream

    object

    (Optional) GroupDream this Dream is a part of.

    type stringrequired
    id stringrequired

    account

    object

    The Account connected to this Dream.

    type stringrequired
    id stringrequired
    externalId string
Loading...