Update Link | LMS | Zoho People API

Update Link API

This API is used to update 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/<linkId>?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/<linkId>?linkData={"name" : <name>, "embedURL" : <embedURL>, "description" : <description>, "isMandatory" : <isMandatory>, "lockUntil" : <lockUntil>}

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

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
*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

Request

Copiedhttps://people.zoho.com/api/v1/courses/219225000000642002/modules/219225000000648001/links/219225000000648031?linkData={"name":"Link API Testing_Update", "embedURL" : "http://zoho.com/people", "description" : "API testing", "isMandatory" : true, "lockUntil" : "27-12-2021"}

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

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_Update",
        "canUserDelete": true
    },
    "message": "success"
}