{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/roletemplates/:roleTemplateId","auth":"required","method":"delete","params":[{"name":"roleTemplateId","type":"string","default":"","desc":"The ID of the role template to be deleted","required":false,"in":"path","ref":"","_id":"54b5926596fe3c0b00d38dbd"}],"results":{"codes":[{"code":"","name":"","status":204,"language":"json"}]},"examples":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Delete Role Template","type":"endpoint","slug":"delete-a-role-template","excerpt":"","body":"This endpoint allows you to delete an existing role template.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Note:\",\n  \"body\": \"You cannot delete a role template that is in use. If you want to delete a role template, you will need to assign a different role to all users who have the role template you want to remove.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Permissions\"\n}\n[/block]\nOnly an ADMINISTRATOR may delete Role Templates.","updates":[],"order":8,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"54b5926596fe3c0b00d38dbc","editedParams2":true,"user":"543532513513400800a144f4","version":{"version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54343531bfaa3d0800c4d4b0","543435b1edce040800409240","543435b9edce040800409241","543435bcedce040800409243","543435bfedce040800409244","543435c2edce040800409245","54370cc426469424002a6dfa","54370cf026469424002a6dfd","5437129d26469424002a6e2f","543712d226469424002a6e30","5480c8fd74904f1a00053c86","54aafc6eefb39016009e4d71","54ac1d36de18cc1400226e01","54ad59369219922100751732","54b41bcf4f25cb1600518d2c","54b533a3a806f40c0050d53c","54b54bbf96fe3c0b00d38d2a","54b688a27379a90c00f53a8a","54b699efbc1a46160005edfa","54b8191691011f0b00068804","54bfb002d03bfc0d0000e814","54bfb33ed03bfc0d0000e816","55a3e94e912a6e2300882cdb","55a56c370f354f0d00fd02a8","55e85ad034516037002e9325","5638ecb62fc5520d001a4cf9","572cba2fc310640e008f63d5","596e6e42c5b53b00509791b1"],"_id":"54343531bfaa3d0800c4d4af","project":"54343170fa5527080064f449","releaseDate":"2014-10-07T18:47:13.086Z","__v":28,"createdAt":"2014-10-07T18:47:13.086Z","forked_from":"54343170fa5527080064f44c"},"project":"54343170fa5527080064f449","__v":1,"parentDoc":null,"createdAt":"2015-01-13T21:47:17.522Z","editedParams":true,"githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":["54b54bf296fe3c0b00d38d2b","54b56fb796fe3c0b00d38d61","54b576742d48f3350040e562","54b592342562600c00e05f2b","54b5926596fe3c0b00d38dbc","54b5938596fe3c0b00d38dc1","54b594722562600c00e05f2f","54c7a95e56f4ff0d00aaabe2","54caa9f7dd5cf30d00c35296"],"title":"Roles","slug":"roles","order":6,"from_sync":false,"reference":false,"_id":"54b54bbf96fe3c0b00d38d2a","__v":9,"createdAt":"2015-01-13T16:45:51.860Z","project":"54343170fa5527080064f449","version":"54343531bfaa3d0800c4d4af"}}

deleteDelete Role Template


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

roleTemplateId:
string
The ID of the role template to be deleted

Documentation

This endpoint allows you to delete an existing role template. [block:callout] { "type": "warning", "title": "Note:", "body": "You cannot delete a role template that is in use. If you want to delete a role template, you will need to assign a different role to all users who have the role template you want to remove." } [/block] [block:api-header] { "type": "basic", "title": "Permissions" } [/block] Only an ADMINISTRATOR may delete Role Templates.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}