Create a new Dream.

POST 
/dreams

Create a new Dream.

Request

application/json

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 RFC3339

(Optional) DateTime 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

201

Dream created

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 RFC3339

(Optional) DateTime 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

dreamInspiration

object

nullable

(Optional) The Dream Inspiration this Dream was created from.

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]

Example (from schema)

{
  "dream": {
    "id": "844830a8-b845-4cbc-b79f-865cd8c8aa8e",
    "targetCents": 102000,
    "type": "Dream",
    "expiresAt": "2006-01-02T15:04:05Z",
    "achievedAt": "2006-01-02T15:04:05Z",
    "name": "Trip to Japan",
    "balanceCents": 12300,
    "deletedAt": "2006-01-02T15:04:05Z",
    "imageUrl": "https://images.com/photo-123-456",
    "activeSavehacksCount": 2,
    "user": {
      "type": "string",
      "id": "string",
      "externalId": "string"
    },
    "groupDream": {
      "type": "string",
      "id": "string"
    },
    "account": {
      "type": "string",
      "id": "string",
      "externalId": "string"
    },
    "dreamInspiration": {
      "id": "844830a8-b845-4cbc-b79f-865cd8c8aa8e",
      "translatedName": {
        "en": "Translated string with %{interpolations} for the `en` locale",
        "xx": "Or any other locale you wish to support"
      },
      "targetCents": 5000,
      "durationSeconds": "string",
      "imageUrl": "string",
      "type": "DreamInspiration"
    }
  }
}

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"
      ]
    }
  ]
}

Loading...