Create Link API
This API is used to create a link in modules of courses or batch in LMS.
Request URL: (Self Paced Course)
https://people.zoho.com/api/v1/courses/<courseId>/modules/<moduleId>/links?linkData={"name" : <name>, "embedURL" : <embedURL>, "description" : <description>, "isMandatory" : <isMandatory>, "lockUntil" : <lockUntil>}
Request URL: (Blended Learning Course)
https://people.zoho.com/api/v1/courses/<courseId>/batches/<batchId>/modules/<moduleId>/links?linkData={"name" : <name>, "embedURL" : <embedURL>, "description" : <description>, "isMandatory" : <isMandatory>, "lockUntil" : <lockUntil>}
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 |
| *linkData | <parameters in JSON Object> | JSON Input |
| Parameters | Values Allowed | Default Value | Description |
| *name | <File name> | <Mandatory> | Specify the file name |
| *embedURL | <File> | <Mandatory> | Specify the file |
| description | <description> | - | Specify the description |
| isMandatory | <true|false> | true | Specify if file is mandatory or not |
| lockUntil | <lockUntil date in DD-MM-YYYY format> | - | Specify the lock until date |
| resources | <files> | - | Specify resources |
*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();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://people.zoho.com/api/v1/courses/478346000019479001/modules/478346000019544017/links?linkData={\"name\":\"Link API Testing 1\",\"embedURL\":\"http://zoho.com\",\"description\":\"API testing\",\"isMandatory\":true,\"lockUntil\":\"03-01-2022\"}")
.post(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/478346000019479001/modules/478346000019544017/links?linkData={\"name\":\"Link API Testing 1\",\"embedURL\":\"http://zoho.com\",\"description\":\"API testing\",\"isMandatory\":true,\"lockUntil\":\"03-01-2022\"}";
fetch(url, {
method: "POST",
headers: {
"Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
}
})
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.error("Error:", error));Copiedcurl -X POST "https://people.zoho.com/api/v1/courses/478346000019479001/modules/478346000019544017/links?linkData={\"name\":\"Link API Testing 1\",\"embedURL\":\"http://zoho.com\",\"description\":\"API testing\",\"isMandatory\":true,\"lockUntil\":\"03-01-2022\"}" \
-H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN"Copiedurl = "https://people.zoho.com/api/v1/courses/478346000019479001/modules/478346000019544017/links?linkData={\"name\":\"Link API Testing 1\",\"embedURL\":\"http://zoho.com\",\"description\":\"API testing\",\"isMandatory\":true,\"lockUntil\":\"03-01-2022\"}";
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/478346000019479001/modules/478346000019544017/links?linkData={\"name\":\"Link API Testing 1\",\"embedURL\":\"http://zoho.com\",\"description\":\"API testing\",\"isMandatory\":true,\"lockUntil\":\"03-01-2022\"}"
headers = {
"Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
}
response = requests.post(url, headers=headers)
print(response.text)Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxfResponse
Copied{
"code": 200,
"link": {
"lockUntil": "26-12-2021",
"linkId": "219225000000648031",
"isMandatoryLink": true,
"canMarkAsComplete": 0,
"isLocked": true,
"link": "http://zoho.com/people",
"description": "Description for Link",
"resources": [],
"canUserEdit": true,
"moduleId": "219225000000648001",
"linkName": "Link One",
"canUserDelete": true
},
"message": "success"
}