---
title: "API: Requirement's Course Auto-Enroll Settings"
slug: "api-requirements-course-auto-enroll-settings"
tags: ["enrollment automation"]
updated: 2022-06-15T20:15:50Z
published: 2022-06-15T20:15:50Z
canonical: "support.smarteru.com/api-requirements-course-auto-enroll-settings"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.smarteru.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API: Requirement's Course Auto-Enroll Settings

The following API methods enable you to specify or retrieve the [Auto-Enroll settings for a requirement's courses](/v1/docs/editing-a-blocks-courses#automation-enrollment):

- [createRequirement](/v1/docs/api-createrequirement)
- [getRequirement](/v1/docs/api-getrequirement)
- [listRequirements](/v1/docs/api-listrequirements)
- [updateRequirement](/v1/docs/api-updaterequirement)

Each requirement block's [Auto-Enroll settings](/v1/docs/editing-a-blocks-courses#automation-enrollment) are specified using some combination of the following tags:

- AutoEnroll
- AutoEnrollILT
- AutoEnrollOnFailure

The grid below summarizes the Auto-Enroll option that is used by the course based on the values of the above tags.

|  | TAG AND VALUE |
| --- | --- |
| **AUTO-ENROLL OPTION** | **AutoEnroll** | **AutoEnrollILT** | **AutoEnrollOnFailure** |
| Do Not Auto-Enroll | 0 | null | null |
| Auto-Enroll Once | 1 | null | 2 |
| Auto-Enroll Until Pass | 1 | null | 1 |
| Auto-Enroll to Waiting List | 1 | 2 | 2 |
| Auto-Enroll to Waiting List (Until Pass) | 1 | 2 | 1 |
| Auto-Enroll to First Available Session | 1 | 1 | 2 |
| Auto-Enroll to First Available Session (Until Pass) | 1 | 1 | 1 |

## Related

- [API: createRequirement](/api-createrequirement.md)
- [API: getRequirement](/api-getrequirement.md)
- [API: listRequirements](/api-listrequirements.md)
- [API: updateRequirement](/api-updaterequirement.md)
- [Editing a Block's Courses](/editing-a-blocks-courses.md)