academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

Cohort-templates → Update a cohort template

AI-generated

Summary

Updates an academyFIVE cohort template by sending the required template data object to the API. You can also provide attributes and relationships; supplying cohort template schedule semesters replaces the complete schedule, with omitted optional fields on each schedule item persisted as null.

Inputs

  • data (required) — Template object with required type and id. Optionally set attributes: labelTemplate, bookingStartDateType (1 for cohort start date, 2 for booking matriculation date), participant limits, activityNumber, and trialStudyMaxCredits. The activity number and trial study credits require their respective site configurations.
  • relationships — Optionally set related sites and studyProgram using relationship data entries with required type and id. You can also provide cohortTemplateScheduleSemesters as entries with required type and termOfStudy; optional fields are semesterTypeId, studyTypeId, studyMode, and studySection. Providing this schedule replaces the complete schedule, and omitted optional fields on an item are persisted as null. studySection requires the specified site configuration.

Output shape

A list of JSON items returned by the API, paired with their input items.

If continue on fail is enabled, failed input items produce JSON items containing an error message.

Links

Discussion