CreateTrainingEventRequest

A request or response body; the type column links to the schemas it refers to.

CreateTrainingEventRequest

FieldTypeRequiredDescription
orgstringyes

Organization UUID id or slug the event belongs to.

at least 1 character

departmentstringno

UUID id or slug of the owning department within the organization; omit for an event owned by the organization directly.

at least 1 character

titlestringyes

1–200 characters

description_markdownstringno

Omit or send empty for no description.

at most 50000 characters

meeting_urlstring (uri)no

Video meeting link, for remote or hybrid sessions.

at most 2000 characters

locationstringno

Free-text venue, for in-person sessions.

1–500 characters

credit_hoursnumberno

Hours an attendance credits toward subject-hours rules. Omit to credit the event's wall-clock duration instead.

maximum 10000

subject_matter_idsarray of string (uuid)no

Subjects the event (and every attendance record it produces) is filed under. Subjects of the event's own organization only.

at most 50 items

starts_atstring (date-time)no

When the event starts. Omit both starts_at and ends_at for an event whose time is not yet known; it is listed as unscheduled until PATCHed with a window.

ends_atstring (date-time)no

When the event ends; required exactly when starts_at is given.

jsonExample
{
  "org": "acme-corporation",
  "department": "string",
  "title": "string",
  "description_markdown": "string",
  "meeting_url": "https://meet.example.com/abc-defg-hij",
  "location": "Simulator bay 2, Building C",
  "credit_hours": 8,
  "subject_matter_ids": [
    "1b671a64-40d5-491e-99b0-da01ff1f3341"
  ],
  "starts_at": "2026-01-01T00:00:00.000Z",
  "ends_at": "2026-01-01T00:00:00.000Z"
}