---
title: "Preview a note"
method: POST
path: "/api/v2/itineraries/{externalId}/note"
tags: ["Itineraries (v2)"]
---

# Preview a note

`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

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).

## Request body

- object
  - `note` string, nullable, required: What to change.
  - `editVersion` integer, nullable: Must be at least 0.

## Response `200`

nothing to change

- object
  - `changed` boolean
  - `message` string
  - `skipped` string
  - `ignored_days` integer[]

## Other responses

- `201`
- `401`: unauthenticated: No valid bearer token was sent.
- `422`
- `429`: rate_limited: A throttle or a per-account allowance refused the request; `retry_after` or `remaining` may be present.
- `500`

---

[API](https://skmtc.dev/endlesstravelplans/apis/endless-travel-plans-api.md) · [All operations](https://skmtc.dev/endlesstravelplans/apis/endless-travel-plans-api/llms.txt) · [OpenAPI document](https://skmtc.dev/endlesstravelplans/apis/endless-travel-plans-api/revisions/ae82ed3e4a8f?raw)