LeadSquared Developer Centre

ON THIS PAGE

Remove a Permission Template


Removes a permission template from all users, groups and roles it’s applied to.

You have to pass the “TemplateId” in the JSON body as shown below.

Note: If you want to remove a permission template from all levels and delete it permanently as well, use the Delete Permission Template API.

API URL

URL
Icon
POST https://{host}/v2/PermissionTemplate.svc/Apply?accessKey=AccessKey&secretKey=SecretKey&overWriteAll=OverWriteAll

URL Parameters

Parameter Description
OverWriteAll Pass the value "true" here to remove a permission template from all levels.

Request

Content-Type: application/json
JSON Body/Payload Icon
{
	"Id": "4fb25c1c-dbfe-11e7-9f0f-0236dfe9c25a"
	}

Request Parameters

Parameter Description
Id

Id of the permission template.

Response

200 OK
Content-Type: application/json
{
    "Status": "Success",
    "Message": {
        "IsSuccessful": true
    }
}

HTTP Response Codes

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.

On this page

© 2024 by MarketXpander Services Pvt Ltd. All Rights Reserved.