SG Developers Send feedback
This endpoint is deprecated. Please do not use it for new projects. The documentation remains here for legacy API consumers.
Sending feedback
To send a company feedback regarding an application, one uses a POST request with the /applications/{appId}/feedback endpoint:
|
1 |
curl -i -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -X POST "https://api.softgarden.io/api/rest/v2/frontend/applications/{appId}/feedback?name={name}&email={email}&feedback={feedBack}" |
with TOKEN being the user access token of the user in question and {appId} corresponding to the ID of one of his/her applications. {name} and {email} define the sender’s credentials, the actual message equivalent to {feedBack}.
Both the email address and recipient must be set in the configuration of the web-frontend. If either frontend.feedback.to or frontend.feedback.mailTemplateId are not set or invalid, this method will do nothing and no feedback mail will be sent.
No direct feedback regarding the success is given, aside from the fact that a mail using the specified template may be received at the specified address of course.
Path parameters
| Name | Description |
|---|---|
| appId | The ID of the application for which feedback is to be sent. |
Query parameters
| Name | Description | Data Type |
|---|---|---|
| name | Name of sender. | String |
| Email address of sender. | String | |
| feedBack | The actual feedback message sent by the applicant. | String |
Response values
| Upon | Returned value | Description |
|---|---|---|
| failure | 500 – INTERNAL SERVER ERROR | When an error appears while processing your request. |
| authorization error | 401 / 403 | See here for details. |