Schedule a meeting (POST /api/public/meetings)

Schedule a meeting. "type" is the location (Online or In person). "meetingType" is the format (Individual or Group).

Authentication

Requires an API key, sent as Authorization: Bearer cp_live_....

API keys carry scopes. Get the catalog of scopes and webhook events lists every scope.

Header parameters

Header parameters
Name	Type	Description
`Idempotency-Key`	`string`	Optional. Send a unique key (e.g. a UUID) to make this POST safe to retry. The same key within 24h returns the original result instead of creating a duplicate.

Request body

application/json, required

Request body fields
Name	Type	Description
`title`required	`string`
`startDate`required	`string`	ISO date-time
`endDate`required	`string`	ISO date-time
`duration`	`number`	Minutes (optional)
`type`required	`string`	Allowed values: `Online` `In person`
`meetingType`	`string`	Allowed values: `Individual` `Group`
`onlineLink`	`string`	Zoom/Meet URL
`address`	`string`	Physical address
`notes`	`string`
`trainees`	`string[]`	Array of trainee ids Maximum items: `500`
`capacity`	`number`	For group meetings

Request examples

cURL

curl --request POST \
  --url 'https://api.coach-platform.com/api/public/meetings' \
  --header 'Authorization: Bearer cp_live_...' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "startDate": "<string>",
  "endDate": "<string>",
  "type": "Online"
}'

JavaScript (fetch)

const response = await fetch('https://api.coach-platform.com/api/public/meetings', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer cp_live_...',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "title": "<string>",
    "startDate": "<string>",
    "endDate": "<string>",
    "type": "Online"
  }),
});

const data = await response.json();

Responses

`201` Created

Example body (application/json)

{
  "data": {
    "id": "<string>",
    "coach": "<string>",
    "title": "<string>",
    "startDate": "<date-time>",
    "endDate": "<date-time>",
    "duration": 123,
    "type": "Online",
    "meetingType": "Individual",
    "onlineLink": "<string>",
    "address": "<string>",
    "notes": "<string>",
    "status": "<string>",
    "capacity": 123,
    "trainees": [
      {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>"
      }
    ],
    "createdAt": "<date-time>"
  },
  "warnings": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Response fields (23)

Response fields
Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.coach`	`string`
`data.title`	`string`
`data.startDate`	`string<date-time>`
`data.endDate`	`string<date-time>`
`data.duration`	`number`
`data.type`	`string`	Allowed values: `Online` `In person`
`data.meetingType`	`string`	Allowed values: `Individual` `Group`
`data.onlineLink`	`string`
`data.address`	`string`
`data.notes`	`string`
`data.status`	`string`
`data.capacity`	`number`
`data.trainees`	`object[]`	Meeting attendees. email and phoneNumber are returned only when the key also has the trainees:read scope.
`data.trainees[].id`	`string`
`data.trainees[].name`	`string`
`data.trainees[].email`	`string`
`data.trainees[].phoneNumber`	`string`
`data.createdAt`	`string<date-time>`
`warnings`	`object[]`	Non-fatal problems with follow-up writes. The resource was created, but each listed field was not applied.
`warnings[].field`	`string`
`warnings[].message`	`string`

Error responses

400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
409 Conflict
429 Too Many Requests
500 Internal Server Error

These statuses share the same response body.

Example body (application/json)

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "fix": "<string>",
    "details": {},
    "retryAfterMs": 123
  }
}

Error fields (6)

Error fields
Name	Type	Description
`error`	`object`
`error.code`	`string`
`error.message`	`string`
`error.fix`	`string \| null`
`error.details`	`object \| null`
`error.retryAfterMs`	`number \| null`

This page is also available as Markdown. Browse it in the interactive explorer or download the OpenAPI spec.