Skip to main content
POST
Each team may only have a single onboarding form. The form and its questions are created atomically: if any question fails validation, the entire operation is rejected. Returns 409 DUPLICATE_ERROR if an onboarding form already exists for your team — use PATCH /v1/onboarding-form to modify it instead.

Body Parameters

string
required
Form display name. Between 1 and 200 characters.
string | null
Optional description shown above the form. Maximum 1000 characters.
array
required
Between 1 and 50 questions. Order is preserved by the order field on each question.

Response

Returns the created OnboardingForm object — same shape as GET /v1/onboarding-form.

Notes

  • Required permission: write:program.
  • single_choice and multiple_choice questions must include a non-empty options array.
  • order does not need to be contiguous, but values are used as-is to sort the form.