Skip to product menu
Skip to main content

Remove Learner From Batch API

This API is used to remove learner from a batch in LMS.

Request URL: 

https://people.zoho.com/api/v1/courses/<courseId>/batches/<batchId>/learners/<LearnerId>

Scope:

ZOHOPEOPLE.training.ALL
OR
ZOHOPEOPLE.training.DELETE

Possible Operation Types:

ALL - Complete access to data
DELETE - Only to delete data

Method:

DELETE

Error Codes and Descriptions

Status CodesDescription
400Invalid parameter value/input parameter missing
403Sorry! You are not authorized to do this operation
404Not found
422Maximum limit exceeded
500Sorry! Server error occured

View complete list of LMS API error codes

Threshold Limit: 30 requests | Lock period: 5 minutes

Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.

Request

Copiedimport okhttp3.*;

public class Main {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://people.zoho.com/api/v1/courses/478346000019479103/batches/478346000019479115/learners/478346000019558209")
            .delete()
            .addHeader("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
            .build();

        Response response = client.newCall(request).execute();
        System.out.println(response.body().string());
    }
}
Copiedfetch("https://people.zoho.com/api/v1/courses/478346000019479103/batches/478346000019479115/learners/478346000019558209", {
    method: "DELETE",
    headers: {
        "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
    }
})
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.error(error));
Copiedcurl --location --request DELETE 'https://people.zoho.com/api/v1/courses/478346000019479103/batches/478346000019479115/learners/478346000019558209' \
--header 'Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN'
Copiedurl = "https://people.zoho.com/api/v1/courses/478346000019479103/batches/478346000019479115/learners/478346000019558209";
headers = map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
response = invokeurl
[
    url : url
    type : DELETE
    headers: headers
];
info response;
Copiedimport requests

url = "https://people.zoho.com/api/v1/courses/478346000019479103/batches/478346000019479115/learners/478346000019558209"

headers = {
    "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
}

response = requests.delete(url, headers=headers)

print(response.text)

Show full

Show less

Request

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

Copied{
    "code": "200",
    "learnerId": "219225000000654043",
    "message": "success"
}