When building with the Travefy API, you'll see a variety of terms used throughout the developer documentation. This guide explains some of the most common definitions to help you better understand how trip data is structured and managed within Travefy.

Travefy trips are organized in a hierarchy:

Trip → TripDay → TripEvent → TripIdea

A TripDay represents a day within an itinerary. A TripDay can have a specific date (for example, January 24, 2027) or simply be labeled as a day number (such as Day 1).

A TripEvent is an activity, reservation, or item that appears on a TripDay.

A TripIdea is additional information associated with a TripEvent, such as a hotel, restaurant, attraction, or point of interest.

For example:

The TripEvent may contain details such as reservation information and timing, while the TripIdea contains supporting information like location, hours, and descriptions.

Important: TripIdeas created through the API are standalone items. They do not connect to Travefy's existing database content or an advisor's Content Library.

Trips in Travefy can be created in one of two formats:

Setting IsProposal = true creates a Proposal, which includes an approval process commonly used for sales, quoting, and client decision-making.

The IsSupplemental parameter determines where content appears within a trip.

Setting IsArchived = true moves a trip into the Archive rather than displaying it in the primary Trips view.

The PartnerIdentifier field allows you to store your own unique identifier for a trip.

For example, if a trip already has an ID in your CRM, booking platform, or internal database, you can save that identifier in the PartnerIdentifier field for future reference and synchronization.

If you come across a term in the developer documentation that is not defined here, please contact APIsupport@Travefy.com and our team can help provide clarification or add it to this guide.