Retire Application
This endpoint is deprecated. Please do not use it for new projects. The documentation remains here for legacy API consumers. Please use the Frontend API V3.
Retiring an application of a user
By appending an application’s ID to the /applications endpoint in a DELETE-request, one can retire a specified application of the user:
1 |
curl -i -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -X DELETE "https://api.softgarden.io/api/rest/v2/frontend/applications/{applicationId}" |
with TOKEN being the user access token of the user in question and {applicationId} corresponding to the ID of one of his/her applications. This application will subsequently be deleted from the system, along with associated mails.
Path parameters
Name | Description |
---|---|
applicationId | The ID of the application that is to become retired. |
Query parameters
– none –
Response values
Upon | Returned value | Description |
---|---|---|
success | boolean | ‘true’ if deletion was successful, ‘false’ otherwise (e.g. application belongs to different user) |
failure | 500 – INTERNAL SERVER ERROR | When an error appears while processing your request. |
authorization error | 401 / 403 | See here for details. |