🎯 Learning Path CTA Reference
The API provides Call to Action (CTA) objects, which define the actions a user is allowed to perform on a specific Learning Path. These CTAs are dynamic and depend on the user’s current learning state — including enrollment, completion status, score, and access eligibility. Each CTA includes all the necessary argument values required to perform its respective action. The purpose of the action is determined by theactionId.
CTA shows that the corresponding mutation or query can be executed by the current API user, but doesn’t trigger any actions by itself.
📌 Available CTA Types
| CTA action ID | Corresponding query/mutation | Description |
|---|---|---|
VIEW_LP | getLearningPath, example | Grants access to view the Learning Path. |
ENROLL_LP | createLpIndividualMembership | Allows to self-register to the Learning Path. |
LOGIN_AND_ENROLL_LP | createLpIndividualMembership | Available only for anonymous users and will be returned if the training visibility is set to “Limited availability for anonymous users”. Authentication is required to execute the mutation. |
CREATE_LP_ATTEMPT | createLpAttempt | Allows to create a new attempt for the Learning Path. This action is typically available when a user is allowed or required to retake the training from the beginning. |
TAKE_EDGE | getLearningPathContentData | Allows to start a module or activity. Used for navigation between the learning path steps. |
RESTART_EDGE | restartContentAttempt | Allows the to restart a specific module if it was failed, clearing previous answers. |
REVIEW_EDGE | getLearningPathContentData, example | Allows the user to review an activity they have already completed, including their submitted answers. Query should be executed with parameter navigationMode: REVIEW. |
RESULTS_EDGE | getLearningPathContentData, example | Provides access to the results of an edge (e.g., quiz or evaluation outcome). |
EVALUATE_LP | createLearningPathEvaluationSubmission | Allows submission of a Learning Path evaluation. This action is available only after the user has completed the Learning Path |
BACK_TO_LP_HP | - | Optional CTA; indicates that the user can return to the Learning Path homepage after viewing results or reviewing a module. It doesn’t represent any mutation or query. |
TOGGLE_BOOKMARK | toggleBookmark | Allows users to add or remove bookmarks for learning paths. The CTA title dynamically changes between “Add to bookmarks” and “Remove from bookmarks” based on current bookmark status. |