Publish Batch API

This API is used to publish a batch in LMS.

Request URL: (Blended Learning Course)

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

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

Parameters	Values Allowed	Default Value	Description
notifyApplicableUsers	<True\|False>	true	Notify applicable users

Error Codes and Descriptions

Status Codes	Description
400	Invalid parameter value/input parameter missing
403	Sorry! You are not authorized to do this operation
404	Not found
422	Maximum limit exceeded
500	Sorry! 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

Java JavaScript Curl Deluge Python

Copiedimport okhttp3.*;

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

        String url = "https://people.zoho.com/api/v1/courses/588882000001018001/batches/588882000001019001/publish?notifyApplicableUsers=True";

        Request request = new Request.Builder()
            .url(url)
            .post(RequestBody.create(new byte[0])) // Empty payload
            .addHeader("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
            .build();

        Response response = client.newCall(request).execute();
        System.out.println(response.body().string());
    }
}

Copiedconst url = "https://people.zoho.com/api/v1/courses/588882000001018001/batches/588882000001019001/publish?notifyApplicableUsers=True";

fetch(url, {
    method: "POST",
    headers: {
        "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
    },
    body: null // Empty payload
})
.then(response => response.text())
.then(data => console.log(data))
.catch(error => console.error(error));

Copiedcurl -X POST "https://people.zoho.com/api/v1/courses/588882000001018001/batches/588882000001019001/publish?notifyApplicableUsers=True" \
-H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN"

Copiedurl = "https://people.zoho.com/api/v1/courses/588882000001018001/batches/588882000001019001/publish?notifyApplicableUsers=True";

headers = map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");

response = invokeurl
[
    url : url
    type : POST
    headers: headers
];

info response;

Copiedimport requests

url = "https://people.zoho.com/api/v1/courses/588882000001018001/batches/588882000001019001/publish?notifyApplicableUsers=True"

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

response = requests.request("POST", url, headers=headers)

print(response.text)

Show full

Show less

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

Copied{
    "code": "200",
    "batch": {
        "batchId": "219225000000645215",
        "status": "published"
    },
    "message": "success"
}