Withdraw an Application
As soon as an applicant submitted the application finally, you can’t just delete it. But it can be withdrawn using the application ID.
HTTP-Method
POST
Path
/api/rest/v3/frontend/applications/{applicationId}/withdraw
Authentification
Path Parameter
applicationId
Query Parameter
-none-
Responses
Action | Response | Description |
---|---|---|
success | 204 | The application has been withdrawn successfuly |
authorization error | 401 / 403 | See here and here for details. |
error | 400 – { “code”: “application_access_error”, “message”: “Application does not exist” } | No application was found for the provided ID or the applicant does not own it. |
error | 400 – { “code”: “application_access_error”, “message”: “Application was never submitted. Use delete instead.” } | The application has not been finalized yet and therefore can’t be withdrawn. You should use the delete endpoint instead. |
error | 400 – { “code”: “application_access_error”, “message”: “Was not able to withdraw the application” } |
Example call with curla and user access token
1 |
curl -i -H "Authorization: Bearer a88a95e3-c7ed-4619-abfe-de84165a6ba6" -X DELETE "https://api.softgarden.io/api/rest/v3/frontend/applications/xxxxxx-62eb-413a-bb55-d868d2da9ac6/withdraw" |