LeadSquared Developer Centre

ON THIS PAGE

Update a Permission Template


Lets you update a permission template.

You have to pass the “TemplateId” in the API URL and the updated permission settings in the JSON body.

For more information, please refer to Permission Templates.

API URL

URL
Icon
POST https://{host}/v2/PermissionTemplate.svc/Update? accessKey=AccessKey&secretKey=SecretKey&Id=TemplateId

URL Parameters

Parameter Description
TemplateId The Id of the permission template you're updating. To get the Id of a template, use the Get Permission Template API.

Request

Content-Type: application/json
JSON Body/Payload Icon
								
							
								
							
								
							

Request Parameters

Parameter Description
Name

Name the permission template here.

Description

Enter a description of the permission template.

EntityPermissions

This parameter lets you define permissions on each entity.

“Entity” – The entity you want to control access to. Can be either “Lead” or “Activity”.

“Permissions” – Lets you define permissions on an entity. It consists of 3 nested nodes –

  • “Action” – Accepted values are “View”, “Create”, “Edit”, “Delete”, “Import” and “Export”.
  • “Access” – Accepted values are “NoAccess”, “PartialAccess” and “FullAccess”. If “PartialAccess” is passed, you have to define the restrictions in the “Properties” node below.
  • “Properties”: Pass the “RestrictedFields” here for “PartialAccess”. For examples “FirstName”, “LastName”, etc.

Response

200 OK
Content-Type: application/json
							
								

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

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