← Documentation home
POST/hyax-api/v1/meetings/book

Book meeting

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Request body

FieldRequiredDescription
slotIdYes
emailYes
nameNoUsed when creating person
notesNo

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X POST 'https://platform.hyax.com/hyax-api/v1/meetings/book' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "slotId": "clx_slot_id",
    "email": "[email protected]",
    "name": "Jane Smith",
    "notes": "Looking forward to the call!"
  }'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": {
    "bookingId": "clx…",
    "status": "CONFIRMED",
    "slot": { "id": "clx…", "startTime": "2025-01-20T14:00:00.000Z", "endTime": "2025-01-20T15:00:00.000Z" },
    "product": { "id": "clx…", "title": "Strategy call" },
    "peopleId": "clx…"
  }
}