academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Cohort-templates → Update a cohort template

AI-generated

Summary

Updates a cohort template by sending the required data object to the academyFIVE API. You can also provide its attributes, site and study program relationships, and a complete replacement schedule of semesters.

Inputs

  • data (required) — Template data with required type and id. Optional attributes include labelTemplate, bookingStartDateType (1 for cohort start date, 2 for booking matriculation date), participant limits, activityNumber, and trialStudyMaxCredits. The latter two depend on the corresponding site configuration being enabled.
  • relationships — Optional relationships: sites accepts multiple entries, each with required type and id; studyProgram accepts one entry with required type and study program id; cohortTemplateScheduleSemesters accepts multiple semester entries. Each schedule entry requires type and termOfStudy, and may include semesterTypeId, studyTypeId, studyMode, and studySection. Providing the schedule replaces it completely; omitted optional fields on an entry are persisted as null. studySection depends on a site configuration being enabled.

Output shape

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

If the API response is a JSON array, its entries become separate output items. With Continue On Fail enabled, a failed input produces an item containing an error message.

Links

Discussion