Update Modules API
This API is used to update modules in courses or batches in LMS
Request URL: (Self Paced Course)
https://people.zoho.com/api/v1/courses/<courseId>/modules<moduleId>?moduleData={"name" : <name>, "duration" :<duration>, "description" : <description>, "lockType" : <lockType>, "lockUntil" : <lockUntil>}
Request URL: (Blended Learning Course)
https://people.zoho.com/api/v1/courses/<courseId>/batches/<batchId>/modules<moduleId>?moduleData={"name" : <name>, "duration" :<duration>, "description" : <description>, "lockType" : <lockType>, "lockUntil" : <lockUntil>}
Scope:
ZOHOPEOPLE.training.ALL
OR
ZOHOPEOPLE.training.UPDATE
Possible Operation Types:
ALL - Complete access to data
UPDATE - Only to edit data
Method:
PATCH
Request Parameters
| Parameters | Values Allowed | Default Value | Description |
| *moduleData | <parameters in JSON Object> | JSON Input |
| Parameters | Values Allowed | Default Value | Description |
| name | <file name> | <Mandatory> | Specify the module name |
| duration | <Duration in minutes> | - | Specify the duration |
| description | <Description> | - | Specify the description |
| lockType | <0|1|2> | 0 | 0 -> Unlock 1 -> Locked until date 2 -> Locked until previous module completed |
| lockUntil | <lockUntil date in DD-MM-YYYY format> | - | Specify the lockUntil date |
*mandatory parameters
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
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/478346000019328001/modules/478346000019459001";
String jsonPayload = "{\"name\":\"test Module API testing\",\"duration\":10,\"description\":\"Module API description testing\",\"lockType\":1,\"lockUntil\":\"31-12-2022\"}";
RequestBody body = RequestBody.create(jsonPayload, MediaType.get("application/json"));
Request request = new Request.Builder()
.url(url)
.patch(body)
.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/478346000019328001/modules/478346000019459001";
const payload = {
name: "test Module API testing",
duration: 10,
description: "Module API description testing",
lockType: 1,
lockUntil: "31-12-2022"
};
fetch(url, {
method: "PATCH",
headers: {
"Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN",
"Content-Type": "application/json"
},
body: JSON.stringify(payload)
})
.then(response => response.text())
.then(data => console.log(data))
.catch(error => console.error(error));Copiedcurl -X PATCH "https://people.zoho.com/api/v1/courses/478346000019328001/modules/478346000019459001" \
-H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"test Module API testing","duration":10,"description":"Module API description testing","lockType":1,"lockUntil":"31-12-2022"}'Copiedurl = "https://people.zoho.com/api/v1/courses/478346000019328001/modules/478346000019459001";
headers = map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");
payload = map();
payload.put("name", "test Module API testing");
payload.put("duration", 10);
payload.put("description", "Module API description testing");
payload.put("lockType", 1);
payload.put("lockUntil", "31-12-2022");
response = invokeurl
[
url : url
type : PATCH
headers: headers
parameters: payload.toString()
];
info response;Copiedimport requests
url = "https://people.zoho.com/api/v1/courses/478346000019328001/modules/478346000019459001"
payload = {
"name": "test Module API testing",
"duration": 10,
"description": "Module API description testing",
"lockType": 1,
"lockUntil": "31-12-2022"
}
headers = {
"Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)Show full
Show less
Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxfResponse
Copied{
"code": 200,
"module": {
"duration": "100 Mins",
"lockUntil": "27-12-2021",
"isLocked": true,
"moduleName": "Module One",
"description": "Description for module",
"lockType": "1",
"moduleId": "219225000000648001"
},
"message": "success"