3.1 SUBMIT Feedback
3.1.1 Request
Method: POST
URL: api.feedback.fyi/feedbackapp/[FEEDBACK_CODE]
Path Parameters: FEEDBACK_CODE
Important: The FEEDBACK_CODE is specified in the URL path. Specifying the FEEDBACK_CODE as a parameter after the URL will result in a failure.
Example with Params: api.feedback.fyi/feedbackapp/AUQTWZMF
Headers:
|
Key |
Value Example |
Format |
Req* |
Details |
|
Authorization |
eyJ0eXAiOiJKV1QiL.CJaJ0-XAiabs |
Alpha |
Yes |
The token which received after successful submission of username and password. |
|
X-Client-Key |
Default |
Null |
Yes |
Default value when blank = “Default” |
|
Content-Type |
application/json |
JSON |
Yes |
Body or JSON format. Some tools may populate this value by default when adding raw JSON to Body. |
Body Type: Raw / JSON
Body:
|
Key |
Value Example |
Format |
Req* |
Details |
|
clientKey |
AllSmiles4325 |
Alphanumeric |
Yes |
Default value when blank = “Default” |
|
mobile |
02112345678 |
Numeric |
|
|
|
phoneNumber |
09555555 |
Numeric |
|
|
|
|
example@customerradar.com |
Alphanumeric |
|
|
|
campaignCode |
EXMPLCODE |
Alphanumeric |
Yes |
Feedback code |
|
comment |
This is a test comment! | Alphanumeric | Yes | The accompanying feedback comment provided by the customer leaving feedback |
|
rating |
5 | Numeric | Yes | The rating value for feedback being submitted |
|
Answers |
||||
|
questionType |
EMAIL |
ALPHA |
|
Text must be all capitals and match one of the predetermined question types specified in the programme settings. |
|
questionKey |
|
Alphanumeric |
|
Text is case sensitive and must match the questionKey field specified in the programme settings. |
|
questionText |
What is your email address? |
Alphanumeric |
|
The title text that display in the dashboard details/questions pane. |
|
answer |
example@customerradar.com |
Alphanumeric |
|
The answer text that display in the dashboard details pane. Value must be in format specified for questionType (below). |
Question types:
|
Elements |
Value Example |
Format |
Details |
|
|
address@domain.suffix |
|
|
|
PHONE_WITHOUTCOUNTRY |
021234567 |
Numeric |
|
|
PHONE_WITH_COUNTRY |
+6421234567 |
E.164 |
|
|
DATE |
2018-02-06T00:00:00.000Z |
ISO-8601 |
|
|
DATETIME |
2017-11-02T02:50:12.208Z |
ISO-8601 |
|
|
CUSTOM |
USA |
Alphanumeric |
|
|
HIDDEN |
Customer ID 1234 |
Alphanumeric |
Example of Body:
{
"clientKey":"AllSmiles4325",
"mobile":"02112345678",
"phoneNumber":"09555555",
"email":"example@customerradar.com",
"campaignCode":"EXMPLCODE",
"comment":"This is a test comment!",
"rating":"10",
"answers":[
{
"questionType":"EMAIL",
"questionKey":"email",
"questionText":"Primary Email",
"answer":"test1@customerradar.com"
},
{
"questionType":"HIDDEN",
"questionKey":"hidden",
"questionText":"Hidden",
"answer":"HiddenMessage"
},
{
"questionType":"CUSTOM",
"questionKey":"custom",
"questionText":"Custom",
"answer":"CustomMessage"
},
{
"questionType":"PHONE_WITHOUT_COUNTRY_CODE",
"questionKey":"mobile",
"questionText":"Phone without country code",
"answer":"021234567"
},
{
"questionType":"PHONE_WITH_COUNTRY_CODE",
"questionKey":"phoneNumber",
"questionText":"Phone without country code",
"answer":"+6421234567"
},
{
"questionType":"DATE",
"questionKey":"date",
"questionText":"Date",
"answer":"2018-02-06T00:00:00.000Z"
},
{
"questionType":"DATETIME",
"questionKey":"dateTime",
"questionText":"Date and time",
"answer":"2017-11-02T02:50:12.208Z"
}
],
}
3.1.2 Response
Example Response: