Blossom icon

Blossom

Interact with Blossom LMS/LXP API - manage users, groups, memberships, and learning data

Group → Attach Instance

AI-generated

Summary

Attach a group or course to a template

Inputs

  • domain (required) — Domain name or ID
  • groupIdentifier (required) — Group to attach, identified by external ID or group ID
  • templateIdentifier (required) — Template to attach the group to, identified by external ID or group ID

Output shape

The Blossom API response for the AttachInstance operation, typically reflecting the updated group-to-template attachment status.

Returned as the JSON payload of the API response.

Examples

Example 1: Attach a group with external ID 'grp_123' to a template with external ID 'tmp_456' in domain '1'.

Set domain to '1', groupIdentifier.identifier to 'group_external_id' with value 'grp_123', and templateIdentifier.identifier to 'group_external_id' with value 'tmp_456'.

Discussion