Create a Permission Template
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Creates a permission template to control user access (read, write, import and export) to leads and activities.
For more information, please refer to Permission Templates.
API URL
URL
POST
https://{host}/v2/PermissionTemplate.svc/Create?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"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"
}
]
}
]
}
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 –
|
Response
200 OK
Content-Type: application/json
{
"Status":"Success",
"Message":{
"Id":"c9b7429b-0bf7-11ed-b7fd-0218d8753a48"
}
}
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. |
