Create a Permission Template

Lets you create a permission template to control user access (read, write, import and export) to leads and activities.

For more information on permission templates, look here.

API URL

POST
https://{host}/v2/PermissionTemplate.svc/Create?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

{  
   "Name":"Template Through API",
   "Description":"Template description through API",
   "EntityPermissions":[  
      {  
         "Entity":"Lead",
         "Permissions":[  
            {  
               "Action":"Create",
               "Access":"PartialAccess",
               "Properties":{  
                  "RestrictedFields":[  
                     "FirstName",
                     "LastName"
                  ]
               }
            },
            {  
               "Action":"Update",
               "Access":"PartialAccess",
               "Properties":{  
                  "RestrictedFields":[  
                     "FirstName",
                     "LastName"
                  ]
               }
            },
            {  
               "Action":"Delete",
               "Access":"NoAccess"
            },
            {  
               "Action":"Import",
               "Access":"NoAccess"
            },
            {  
               "Action":"Export",
               "Access":"NoAccess"
            }
         ]
      }
   ]
}

JSON Properties

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

{
    "Status": "Success",https://apidocs.leadsquared.com/wp-admin/post.php?post=1070&action=edit#
    "Message": {
        "Id": "5c2a2354-7040-11e7-9042-22000aa79843"
    }
}

HTTP Response Code

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.