academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

Modules [Beta] → Update module

AI-generated

Summary

Updates an academyFIVE module by sending its required data object to the Modules [Beta] API. Supply the module type and ID, and optionally change its active status or assign areas.

Inputs

  • data (required) — The module data to update. Requires type, id, and an attributes object.
  • data.attributes.isActive — Boolean active status; defaults to false when included without a value.
  • data.relationships.areas — Area relationship data. Provide area entries with required type and id; multiple areas are allowed if the elective module feature flag is active.
  • current-site-id — Query parameter used to verify that the Modules feature is enabled for the current site. Example: 1.

Output shape

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

With Continue On Fail enabled, a failed input produces an item containing an error message. The request uses the configured academyFIVE API credentials.

Links

Discussion