Use the users API endpoint with the DELETE method to delete a user account.
Warning:If you delete a user account, you can’t recover it from the ProntoForms server.
Prerequisites
Note the User ID of the user you want to delete.
Note:If you delete a user, the system keeps any forms, form submissions, or other objects that the user created.
Base URL
https://api.prontoforms.com
Endpoint
DELETE
/api/1.1/users/{UserID}
Deletes a user.
URL structure
Copy
https://api.prontoforms.com/api/1.1/users/{userID}
Request parameters
None
Request header
Include the standard authorization header. This includes the username and password, where username is the API Key ID and password is the API Key Secret.
cURL examples
curl -v -k -u {username}:{password} -X DELETE https://api.prontoforms.com/api/1.1/users/{UserID}
where username is the API Key ID and password is the API Key Secret.
Request body
None
Response codes
200—OK
Response examples
This endpoint does not return a response body.
Error codes
Error code | Error message | HTTP response code | Description |
---|---|---|---|
AccessDenied | Access Denied: You are not allowed to access the requested resource. | 403 | The user doesn’t exist in your team. |
ObjectNotFound | Object Not Found: The object you requested could not be found. | 404 | The system couldn’t find the user. Verify that the User ID is correct. |
Comments
0 comments
Please sign in to leave a comment.