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

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

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

ParametersValues AllowedDefault ValueDescription
*linkData <parameters in JSON Object> JSON Input

 

ParametersValues AllowedDefault ValueDescription
*name<File name><Mandatory>Specify the file name
*embedURL<File><Mandatory>

Specify the file

description<description>-Specify the description
isMandatory<true|false>trueSpecify 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?linkData={"name":"Link API Testing", "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",
        "canUserDelete": true
    },
    "message": "success"
}