Itineraries (v2)

Preview a note

The Build step's note box: the note is read for its days and intent, the plan is re-arranged in a proposal, and the proposal is answered with its diff, held for fifteen minutes under proposal_id. Nothing changes until POST .../note/{proposalId} applies it. A note that changes nothing answers 200 with changed: false and the step's words (an out-of-range day is named as skipped).

post/api/v2/itineraries/{externalId}/note

Request

Base URL: https://www.endlesstravelplans.com
URL: https://www.endlesstravelplans.com/api/v2/itineraries/{externalId}/note
Auth: HTTP bearer

Request body

notestring nullable required

What to change.

editVersioninteger nullable

Must be at least 0.

Example request

{
  "note": "More food on day 2, keep day 1 as is",
  "editVersion": 39
}

Response

nothing to change

changedboolean

messagestring

skippedstring

ignored_daysinteger[]

Example response

{
  "changed": false,
  "message": "Your note didn't call for edits on these days.",
  "skipped": "Day 9 isn't in this 5-day trip, so it was skipped.",
  "ignored_days": [
    9
  ]
}

Changes

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