Public API v1

Create a new travel goal.

post/v1/goals

Request

  • Base URL: https://api.mynextadventure.cloud (the document declares no server; this is the origin it was published from)
  • URL: https://api.mynextadventure.cloud/v1/goals
  • Auth: API key in header X-API-Key

Request body

namestring required

Display name of the goal exactly as a human would call it (e.g. "See the Northern Lights"). Never embed budget, place, status or commentary here — those belong in estimatedBudget, location and notes.

descriptionstring
notesstring

Free-form commentary: provenance, caveats, trade-offs. Anything without a dedicated field goes here, not in name.

countrystring
regionstring
type'country' | 'region' | 'city' | 'place' | 'experience'

Defaults to "place" if omitted.

priority'someday' | 'soon' | 'must_do'

Defaults to "someday" if omitted.

tagsstring[]
imageUrlstring
userUploadedImageUrlstring
bestTimeToVisitstring[]
estimatedBudgetnumber
currencystring
estimatedDurationstring

Free-form duration string (e.g. "3 days", "1 week").

collectionIdsstring[]

Collection ids this goal will be added to.

Response

idstring required
userIdstring required
namestring required
descriptionstring
notesstring
countrystring
regionstring
type'country' | 'region' | 'city' | 'place' | 'experience' required
status'dreaming' | 'planning' | 'visited' required
priority'someday' | 'soon' | 'must_do' required
tagsstring[]
imageUrlstring
userUploadedImageUrlstring
bestTimeToVisitstring[]
estimatedBudgetnumber
currencystring
estimatedDurationstring
linkedTripIdstring

Trip id this goal is currently linked to (when status=planning or visited).

linkedTripNamestring
visitedDatestring date-time
collectionIdsstring[]
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.