Skip to product menu
Skip to main content

Remove Shared Course API

This API is used to removed shared user from courses in LMS.

Request URL: 

https://people.zoho.com/api/v1/courses/<courseId>/share

Scope:

ZOHOPEOPLE.training.ALL
OR
ZOHOPEOPLE.training.DELETE

Possible Operation Types:

ALL - Complete access to data
DELETE - Only to delete data

Method:

DELETE

Request Parameters

ParametersValues AllowedDefault ValueDescription
sharedUserErecno<employee erecno>-Specify employees erecno

Error Codes and Descriptions

Status CodesDescription
400Invalid parameter value/input parameter missing
403Sorry! You are not authorized to do this operation
404Not found
422Maximum limit exceeded
500Sorry! 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("sharedUserErecno=588882000000212025", mediaType);

        Request request = new Request.Builder()
            .url("https://people.zoho.com/api/v1/courses/588882000000996067/share")
            .delete(body)
            .addHeader("Content-Type", "application/x-www-form-urlencoded")
            .addHeader("Cookie", "CSRF_TOKEN=****; _zcsr_tmp=****; _zpsid=****; zalb_c7cb34e6ac=****")
            .build();

        Response response = client.newCall(request).execute();
        System.out.println(response.body().string());
    }
}
Copiedfetch("https://people.zoho.com/api/v1/courses/588882000000996067/share", {
    method: "DELETE",
    headers: {
        "Content-Type": "application/x-www-form-urlencoded",
        "Cookie": "CSRF_TOKEN=****; _zcsr_tmp=****; _zpsid=****; zalb_c7cb34e6ac=****"
    },
    body: "sharedUserErecno=588882000000212025"
})
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.error(error));
Copiedcurl --location --request DELETE 'https://people.zoho.com/api/v1/courses/588882000000996067/share' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: CSRF_TOKEN=****; _zcsr_tmp=****; _zpsid=****; zalb_c7cb34e6ac=****' \
--data-urlencode 'sharedUserErecno=588882000000212025'
Copiedresponse = invokeurl
[
    url: "https://people.zoho.com/api/v1/courses/588882000000996067/share"
    type: DELETE
    parameters: {
        "sharedUserErecno": "588882000000212025"
    }
    headers: {
        "Content-Type": "application/x-www-form-urlencoded",
        "Cookie": "CSRF_TOKEN=****; _zcsr_tmp=****; _zpsid=****; zalb_c7cb34e6ac=****"
    }
];
info response;
Copiedimport requests

url = "https://people.zoho.com/api/v1/courses/588882000000996067/share"

payload = "sharedUserErecno=588882000000212025"
headers = {
    "Content-Type": "application/x-www-form-urlencoded",
    "Cookie": "CSRF_TOKEN=****; _zcsr_tmp=****; _zpsid=****; zalb_c7cb34e6ac=****"
}

response = requests.delete(url, headers=headers, data=payload)

print(response.text)

Show full

Show less

​Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

Copied{
    "code": "200",
    "sharedUserErecno": "219225000000185023",
    "message": "success",
    "courseId": "219225000000642002"
}