For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create on-demand release

Generate complete guidebook structure and release in a single API call using flexible JSON payload with inline content or library references.

On-demand releases vs guidebook releases

Guidebook Release

Creates a personalized release for a specific booking based on an existing guidebook. Use this if your trip structure is the same for all bookings. Note that you still have the possibility to personalize the release to add content specific for a booking (e.g., additional content, accommodations).

On-demand Release

Creates a guidebook and release simultaneously via JSON payload. Use this if the trip structure differs from booking to booking and you need to create highly individual releases (e.g., tailor-made trips created in a third-party system).

On-demand releases are created in two phases:

  1. Validation (synchronous) – All library references (if present) are validated immediately. Missing references return an error in the HTTP response.

  2. Creation (asynchronous) – After validation, the complete release is generated in the background. Any errors during this phase are logged in the Audit Logs (visible in the Release Dashboard for this release).

Create/Update on-demand release

Creating and Updating Entities Use the same object schema for both creation and updates.

  • To Create: Use POST.

  • To Update: Use PUT.

Update Requirements:

  • Identity: Updates are targeted using a composite key: metadata.operator and metadata.operatorCode.

  • Deadline: Entities can only be modified until the day before the publish.startDate. After this window, the entity is locked.

Last updated