academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

Cohort-templates → Create a new cohort template

AI-generated

Summary

Creates a cohort template in the academyFIVE API using the supplied template data and relationships. The request is sent for each incoming item; the API response is returned as JSON.

Inputs

  • data.type (required) — Type of the cohort-template resource.
  • data.attributes.labelTemplate (required) — Template label.
  • data.attributes.bookingStartDateType (required) — Booking start date rule: 1 uses the cohort start date; 2 uses the booking’s matriculation date.
  • data.attributes.minNumberOfParticipants — Minimum number of participants.
  • data.attributes.maxNumberOfParticipants — Maximum number of participants.
  • data.attributes.activityNumber — Activity number; can be set only if a site associated with the user has the “Activity Nr.” configuration enabled.
  • data.attributes.trialStudyMaxCredits — Trial study maximum credits; can be set only if a site associated with the user has the “Trial Study Max. Credits” configuration enabled.
  • data.relationships.sites.data — One or more site references, each with a required resource type and ID.
  • data.relationships.studyProgram.data — Study program reference with a required resource type and ID.
  • data.relationships.cohortTemplateScheduleSemesters.data — Optional semester schedule entries. Each requires a resource type and term of study; semester type ID, study type ID, study mode, and study section are optional. Study section requires an associated site with the “MODUL_ADMIN_STUDIENVERLAUFSPLANUNG_STUDIENABSCHNITT” configuration enabled.

Output shape

A list of JSON response items, normally one per input item.

The API response is converted to n8n JSON items and paired with the corresponding input item. If Continue On Fail is enabled, failed items instead return a JSON object with an error message.

Examples

Example 1: Create a template for a study program and associate it with sites, optionally including semester schedule entries.

Provide the required template type, labelTemplate, and bookingStartDateType; add the study program reference, and supply site references or semester entries when needed.

Links

Discussion