Update an existing Dream.

PATCH 
/dreams/:id

Update an existing Dream.

Request

Path Parameters

id uuidrequired

application/json

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

200

Update was successful

application/json

Schema

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

Example (from schema)

{
  "dream": {
    "id": "844830a8-b845-4cbc-b79f-865cd8c8aa8e",
    "targetCents": 102000,
    "type": "Dream",
    "expiresAt": "2006-01-02",
    "achievedAt": "2006-01-02T15:04:05Z",
    "name": "Trip to Japan",
    "user": {
      "type": "string",
      "id": "string",
      "externalId": "string"
    },
    "groupDream": {
      "type": "string",
      "id": "string"
    },
    "account": {
      "type": "string",
      "id": "string",
      "externalId": "string"
    }
  }
}

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": "dream.targetCents",
      "errors": [
        "can't be negative"
      ]
    }
  ]
}

404

Dream not found

Loading...