{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/users/{userid}.json","auth":"required","method":"delete","params":[{"name":"userid","type":"string","default":"","desc":"User IDs (comma separated) corresponding to the users who are to be deleted","required":true,"in":"path","ref":"","_id":"57f2023c28de4417006cb67e"}],"results":{"codes":[{"name":"","code":"{\n  \"restResponseVO\": {\n    \"code\": 200,\n    \"message\": \"Success\",\n    \"reason\": null,\n    \"generatedAt\": \"Sep-09-2016, 09:24 AM UTC\",\n    \"currentPage\": null,\n    \"totalPages\": null\n  }\n}","language":"json","status":200}]},"settings":"559288b86bf22f170075b794","examples":{"codes":[]}},"next":{"description":"","pages":[]},"title":"Delete","type":"endpoint","slug":"delete-1","excerpt":"Use this API to delete a user. Multiple users can be deleted in a single API call. The user IDs (comma separated) of the corresponding users must be passed in the API call. You can delete only those users who you have access to edit.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Sample Request\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/users/4c5ca6d7-766a-11e6-ab1e-83092d4c935b.json\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Watch Out!\",\n  \"body\": \"This is an irreversible action.\"\n}\n[/block]\n##API Response Explanation \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"code\",\n    \"1-0\": \"message\",\n    \"2-0\": \"reason\",\n    \"3-0\": \"generatedAt\",\n    \"4-0\": \"currentPage\",\n    \"5-0\": \"totalPages\",\n    \"0-1\": \"API status code\",\n    \"1-1\": \"API Message (Success/Failure)\",\n    \"2-1\": \"Reason for failure\",\n    \"3-1\": \"API generation timestamp in UTC\",\n    \"4-1\": \"Current page of the paginated result\",\n    \"5-1\": \"Total number of pages of the paginated result\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]","updates":[],"order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"57edfccb3b369f0e00469c33","category":{"sync":{"isSync":false,"url":""},"pages":["5630a1f83998420d00a50a09"],"title":"USER","slug":"users","order":4,"from_sync":false,"reference":true,"_id":"5594342f0c33bd0d000595a3","__v":1,"createdAt":"2015-07-01T18:40:47.006Z","project":"55926c913735880d005f7c65","version":"559286c6c39c4b2d00127a71"},"user":"5656a3dd5656350d001d83a0","__v":1,"parentDoc":null,"project":"55926c913735880d005f7c65","githubsync":"","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["559286c7c39c4b2d00127a72","55928a98c39c4b2d00127a83","5592bd7b9a68220d00f1c3db","5593dcaf0e82e81700334e25","5594342f0c33bd0d000595a3","563081713998420d00a509e4","5630941c7581b80d00c51c86","56309f4ff1c0580d00fac666","567923b8239fac0d00c7df25","573306dea6a9c40e00e13875","577a288fd051530e00f65563","579af3982b865e17005a4357","57ee06aa1e42900e0014a374","5951f49a63f39000159e7ef1","5951f4c563f39000159e7ef2","598951542a9dfc000fcacd40","5b3375cc98cb500003e4b363","5bbcd4e29667280003084100"],"_id":"559286c6c39c4b2d00127a71","createdAt":"2015-06-30T12:08:38.768Z","project":"55926c913735880d005f7c65","releaseDate":"2015-06-30T12:08:38.768Z","__v":18,"forked_from":"559286b6c39c4b2d00127a6e"},"createdAt":"2016-09-30T05:48:59.443Z"}

deleteDelete

Use this API to delete a user. Multiple users can be deleted in a single API call. The user IDs (comma separated) of the corresponding users must be passed in the API call. You can delete only those users who you have access to edit.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

userid:
required
string
User IDs (comma separated) corresponding to the users who are to be deleted

Result Format


Documentation

[block:callout] { "type": "info", "title": "Sample Request", "body": "https://api.azuga.com/azuga-ws/v1/users/4c5ca6d7-766a-11e6-ab1e-83092d4c935b.json" } [/block] [block:callout] { "type": "warning", "title": "Watch Out!", "body": "This is an irreversible action." } [/block] ##API Response Explanation [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "code", "1-0": "message", "2-0": "reason", "3-0": "generatedAt", "4-0": "currentPage", "5-0": "totalPages", "0-1": "API status code", "1-1": "API Message (Success/Failure)", "2-1": "Reason for failure", "3-1": "API generation timestamp in UTC", "4-1": "Current page of the paginated result", "5-1": "Total number of pages of the paginated result" }, "cols": 2, "rows": 6 } [/block]

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 }}