Enroll Learner To Batch API

This API is used to enroll learner to a batch in LMS.

Request URL: 

https://people.zoho.com/api/v1/courses/<courseId>/batches/<batchId>/enroll?erecnosList=<erecnosList>

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Scope:

ZOHOPEOPLE.training.ALL
OR
ZOHOPEOPLE.training.CREATE

Possible Operation Types:

ALL - Complete access to data
CREATE - Only to create data

Method:

POST

Request Parameters

ParametersValues AllowedDefault ValueDescription
*erecnosList<parameters in JSONArray><Mandatory>Specify the employee erec no's

*mandatory parameters

Request

Copiedhttps://people.zoho.com/api/v1/courses/219225000000642002/batches/219225000000645215/enroll?erecnosList=[219225000000185023]

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

Copied{
    "code": "200",
    "learners": [
        {
            "erecno": "219225000000185023",
            "learnerId": "219225000000653009",
            "enrollmentStatus": "enrolled",
            "batchId": "219225000000645203",
            "courseId": "219225000000645203"
        }
    ],
    "message": "success"
}