Quick Start

This guide walks you through importing a boat listing using the Charter Boats API.

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": "Luxury Catamaran - BALI 4.6",
  "description": "Beautiful 46ft catamaran perfect for island hopping.",
  "location_city": "Split",
  "location_country": "Croatia",
  "boat_type": "catamaran",
  "capacity": 10,
  "price_per_day": 2500,
  "owner_email": "captain@example.com",
  "images": [
    "https://example.com/boat-exterior.jpg",
    "https://example.com/boat-interior.jpg"
  ],
  "amenities": ["WiFi", "Air Conditioning", "Snorkeling Equipment"]
}

2. Send the request

curl -X POST https://charter.boats/api/import/boat \
  -H "Content-Type: application/json" \
  -H "X-API-Key: cb_live_your_api_key_here" \
  -d '{
    "title": "Luxury Catamaran - BALI 4.6",
    "location_city": "Split",
    "location_country": "Croatia",
    "boat_type": "catamaran",
    "capacity": 10,
    "price_per_day": 2500,
    "owner_email": "captain@example.com"
  }'

3. Check the response

A successful response returns the created boat:

{
  "success": true,
  "duplicate": false,
  "boat": {
    "id": "abc123-def456-...",
    "title": "Luxury Catamaran - BALI 4.6",
    "boat_type": "catamaran",
    "capacity": 10,
    "is_published": false
  },
  "images_uploaded": 0,
  "images_downloaded": 0,
  "amenities_added": 2,
  "custom_amenities_added": 1,
  "view_url": "https://charter.boats/boats/abc123-def456-..."
}

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.