Quick Start
Start importing boats in under 5 minutes
This guide walks you through importing a boat listing using the Charter Boats API.
Prefer not to write code? You can also add a boat through the dashboard UI at charter.boats/dashboard/boats/new — no API key required. This API guide is for bulk or automated imports.
Prerequisites
- An API key (generate one from your dashboard)
- Boat details ready (title, location, capacity, etc.)
Import Your First Boat
1. Prepare your request
Create a JSON payload with your boat details:
title, boat_type, and capacity are the only required fields. location_state holds the country or region (it maps to the boat's country); location_city and location_address place it on a marina. See the full field list in the Import Boat reference.
2. Send the request
3. Check the response
A successful response returns the created boat:
Imported boats default to is_published: false. Set "is_published": true in your request to make the listing visible immediately, or publish it later from the dashboard.
Boat Types
The following boat_type values are accepted:
| Value | Description |
|---|---|
sailboat | Sailing yacht |
catamaran | Catamaran |
yacht | Motor yacht |
motorboat | Motorboat |
gulet | Traditional wooden gulet |
rib | Rigid inflatable boat |
Set Pricing & Availability
Imported boats need pricing before they can be booked. Seasonal prices, date overrides, and fees are configured from the dashboard — these edits are tied to your logged-in session and aren't exposed as keyed API endpoints. To read the resulting price for specific dates, use Resolve Pricing; for the raw seasonal rules, see Seasonal Pricing.