academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Cohort-templates → Create a new cohort template

AI-generated

Summary

Create a new cohort template by submitting required data attributes, mandatory relationships to sites and a study program, and optional schedule semesters. Provide details such as label template, booking start date type, participant limits, and optionally activity number and trial study max credits depending on user site configurations.

Inputs

  • data (required) — Includes the type string and required attributes such as labelTemplate (string), bookingStartDateType (number: 1 for cohort start date, 2 for bookings matriculation date), and optional minNumberOfParticipants, maxNumberOfParticipants, activityNumber, and trialStudyMaxCredits as numbers.
  • relationships — Includes mandatory sites data (an array of objects each with type and id) and a required studyProgram (with type and id). Optionally includes cohortTemplateScheduleSemesters data specifying multiple semesters with details like termOfStudy, semesterTypeId, studyTypeId, studyMode, and studySection.

Output shape

a JSON object representing the created cohort template record(s).

Outputs the JSON response from the academyFIVE API upon successful creation. No pagination is involved. If the API returns binary data, it is handled properly, but this operation typically returns JSON.

Links

Discussion