☰
Create Response
Views
POST:
https://{{env}}-feedback-api.xebo.ai/v3/survey-participation/{{survey_id}}/response/create-response
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
"Content-Type": "application/json"
Authorization:
type: Bearer type
token: <access token> granted from login API
Or
x-api-key: <api key copied from the platform>
Content-Type: application/json Request Parameters
Request Body
{
"collector_id": "91310b74-13bc-4e16-b0bf-808049460731",
"responses": [
{
"custom_variables": {
"email": "demo_user@example.com",
"fName": "John",
"lName": "Doe",
"mobile": "9999999999",
"gender": "male"
},
"response_status": "partial",
"questions": [
{
"uuid": "eb594a7b-418a-4c36-9b22-4dd676fe072b",
"answer": [
{
"row_id": "c6cc11b1-6655-4790-ba13-519f3fb1ff40",
“col_id”: “c6cc11b1-6655-4790-ba13-519f3fb1ff42”
}
]
}
]
} The flow and methodologies are explained below:
| Key | Type | Mandatory | Description |
| collector_id | string | Yes | Collector Id of the survey in which you want to insert responses |
| responses | object | Yes | Contains answers and eData objects |
| custom_variables | object | No | Key value pair for custom variables |
| response_status | string | Yes | Status of the response. Enum: [‘partial’, ‘disqualified’, ‘complete’] |
| questions | array<object> | Yes | Array contains answer object with question IDs and Option/Answer IDs
|
| questions.$._uuid | string | No | Question Id of the survey |
| questions.$.answer
|
Array<object> | Yes | Array contains answered options/text/additional text
|
| questions.$.answer.$.row_id | string | Yes | Row Id of the question. |
| questions.$.answer.$.col_id | string | No | Column Id of the question. Valid for matrix questions |
| questions.$.answer.$.item_id | string | No | Item Id of the question. Valid for matrix dropdown questions. |
| questions.$.answer.$.text | string | No | Text, that user answered. Valid for open ended questions. |
Each REST API request returns an HTTP status code. For successful requests, it returns HTTP 200 status code. For failed requests, it returns HTTP 4XX or 5XX status codes. The status codes are explained below:
Request Sample
curl --location 'https://az4-feedback-api.xebo.ai/v3/9be04bc0-3e08-4f03-996e-315281bed083/response/create-response' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzI0Mzk2ODA1LCJpYXQiOjE3MjQzMTA0MDUsImp0aSI6IjQ4ZmM1YTIxNDNmODQ5MjdhZWY5YTZmZjlmOWU5ODZjIiwidXNlcl9pZCI6IjJkNWQxMTk5LTY4ZTUtNDMyMC1hMjEyLWM2ZjQ1NWU3ZDljYyIsImN1c3RvbV9jbGFpbSI6Ikg0c0lBSVhqeG1ZQy80MVh1WkxqTmhEOWxTbkZabGtIZFczbXhJbERPMGMxZ1NhRkZRaGdBVkFhemRiOHV4dWtKSkxpTVpPSmVOMUFINjhQL1Y1NDlGNGF6YVJZL0hoYnBBZWU4VndjazN5ZFk1S0NTSlBzdUJISkhuYmIvZUc0MysxVHZ2ampiU0U5QTFGS1RUckJWVWducGRHRnVkK3kyNjN5NDFMa1c3RmNiWFo4bGVmYmZMTmFZdFEwcmdBdFBZVDIwVTI2U3RQMWVwTmtKSldrcSsyYWZtMzN5WUducXd3UGgvMHl5Nk9xSUxWTUlRc08rRm5xZ25SelVENitqcnBHU3ZBdmdFTWZuT1FCQlpPV2JCWjBRQzZUaEs2VUlvRVBvekVhQVI5cGZNTVpGVDkvTDZxcU1XNjFQK3pTN1hxZHJMZTdkWkttUjBpeTFXR1pwSnNEN05JVTErbjJFQlhyY0VoNmpEeTdJTE5RSUFQTzZiVTJSaTh5cjNEbDBiSFNDSm5meGpHQkNzTlFMOW84cFZkakUzcStjaGU4VFIxUFhIaEhiWlVwNlU4RFdJQS9aUWFjbUVFbWJtNEZwaTdubFErbXBFRDhOSlhUMFViUUZPY1NkWmdSK3ZxV2NYc0djaE5oNUVZcDVNRzRBWUlsU01XbWNWLzZHZlI2Z3VEQjJoa1JzSElPcllSRXpYRkdKSmVvQk11Tm01WGl4TmM1K0lrNEpJSUxkSDVvaXdaMSs4REpjM3kzeG9VaGZkRmJvLzAwdlIvNFJHNmtEbGk0cHRrTW9nOEtmZVA2bkZoT2I1d0Urdk9zbERWWFlrb21aNFdDNUdjTTFLQm1rQWxIVzRFSlQxc0I3aEJJd0FjSWxmL0dTOVQvQzQzNHRhU29LTTR3K3pZb3hab3ZQODZpOGNPaXFlQkgwNjRQSCtaRmJGenRFWWxwaWE5Y2JGNnZVVGJSRGUvM2FCbjViZEVSWWFqcjhIR3FFWmRzbUVwaEt6QkQxa1pnV0dFNmwwWGxrQlVVL3lzTUw0ZkdEMG82eGVMdWlxK0tnc1lmTWRGL1MxNXFDc1FwakFxL1kyWVlEV0NPVGs4NUdQdE5ZTXE4MFBzekZoRlJNcHJ2TWRUVFZVTlpUOTMvbkFUMTluZUR2djFMYUx4SEtYTzlHOVc1dlQ1OURvbFg0TW5CVitBWjFVN1hnSnFzMXBuTy9nSzBKN3hUQlZ1andMWG4yblk4TEN0RmJPZ2QwVWYvSXE4a2RjQlhuZGZUWE1hNTdJRHEyUm43Y3A1Vklaak9ibVVwVlZkRGc1R1lqclROakNBbTJHNVg1R0FEUDBFL040WmR5QWpUWFNvZ2swcUdHd3VSSjkzWUVVWGhSa3RUNW9qc3B4NWtiRU1wWW9NbG9SYjRWVFZzR3lJVW9OS0VydjhYb016SGxhMnB2djRJdDA0YVIyWjF6UStHeUJQSFRLOHFpSEQwSUNoMkFRcHczWFc3YWRiQ2xQZGRzejFXeHRpZVF4eWN1OFVoZU8zeHFrNmNJc2tLVk1jMjJWZitWWmtBM1ZaWWR0MXNkZ2dXVHJTa2RCc21saFNnZ0lOdGcvSGhCc0k4ZDlMMjAxTVlVOFRneGVsSnpPOXRVUUh1MDdRWHFaOUd4aTRaRmFqc3U3eC9wM3psK1FqRW5mR2VCY2hHTUlmMXZQYjhoS0pTUTVmYnRhbFRHWlJrV2VLb0dkYWhvRFU5cnNYbnVHbzUrdVZHNUx6aDFERVlyWWNCZForV3BaWkVlYTJ4czNKTnJFcHpPMUl2YW1SRVF4OFl2WFIwZmVvWUs4Nmo5L2JXcWRGbHBkOThhZmUvU0k3ZmIvZmY2L1A5TjBxZ2ZENUwrS3NSTUlJUDB6dWNBd3BpT1JWMTcwZTl1QmZNNHovWVgxN0NuLzhZZFNZT1I0eHFSTmZqZ3Znc3FVVGo4aEhsRnArZi93T08wYVordVE0QUFBPT0ifQ.4h7MKol3jaNyuDU_jOwrSW4FiW-kiGTfnGBjAdbOLJc' \
--data-raw '{
"collector_id": "80cdd40c-dd4f-4c01-bace-33798e7ec65f",
"responses": [
{
"custom_variables": {
"email": "demo_user@example.com",
"fName": "John",
"lName": "Doe",
"mobile": "9999999999",
"gender": "male"
},
"response_status": "partial",
"questions": [
{
"uuid": "9b9c3746-e3fa-4102-bc62-1f4566b97aa7",
"answer": [
{
"row_id": "0e7702e0-5f99-4820-8a61-312575ba520c"
}
]
}
]
}
]
}' var data = JSON.stringify({
"collector_id": "80cdd40c-dd4f-4c01-bace-33798e7ec65f",
"responses": [
{
"custom_variables": {
"email": "demo_user@example.com",
"fName": "John",
"lName": "Doe",
"mobile": "9999999999",
"gender": "male"
},
"response_status": "partial",
"questions": [
{
"uuid": "9b9c3746-e3fa-4102-bc62-1f4566b97aa7",
"answer": [
{
"row_id": "0e7702e0-5f99-4820-8a61-312575ba520c"
}
]
}
]
}
]
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://az4-feedback-api.xebo.ai/v3/9be04bc0-3e08-4f03-996e-315281bed083/response/create-response");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzI0Mzk2ODA1LCJpYXQiOjE3MjQzMTA0MDUsImp0aSI6IjQ4ZmM1YTIxNDNmODQ5MjdhZWY5YTZmZjlmOWU5ODZjIiwidXNlcl9pZCI6IjJkNWQxMTk5LTY4ZTUtNDMyMC1hMjEyLWM2ZjQ1NWU3ZDljYyIsImN1c3RvbV9jbGFpbSI6Ikg0c0lBSVhqeG1ZQy80MVh1WkxqTmhEOWxTbkZabGtIZFczbXhJbERPMGMxZ1NhRkZRaGdBVkFhemRiOHV4dWtKSkxpTVpPSmVOMUFINjhQL1Y1NDlGNGF6YVJZL0hoYnBBZWU4VndjazN5ZFk1S0NTSlBzdUJISkhuYmIvZUc0MysxVHZ2ampiU0U5QTFGS1RUckJWVWducGRHRnVkK3kyNjN5NDFMa1c3RmNiWFo4bGVmYmZMTmFZdFEwcmdBdFBZVDIwVTI2U3RQMWVwTmtKSldrcSsyYWZtMzN5WUducXd3UGgvMHl5Nk9xSUxWTUlRc08rRm5xZ25SelVENitqcnBHU3ZBdmdFTWZuT1FCQlpPV2JCWjBRQzZUaEs2VUlvRVBvekVhQVI5cGZNTVpGVDkvTDZxcU1XNjFQK3pTN1hxZHJMZTdkWkttUjBpeTFXR1pwSnNEN05JVTErbjJFQlhyY0VoNmpEeTdJTE5RSUFQTzZiVTJSaTh5cjNEbDBiSFNDSm5meGpHQkNzTlFMOW84cFZkakUzcStjaGU4VFIxUFhIaEhiWlVwNlU4RFdJQS9aUWFjbUVFbWJtNEZwaTdubFErbXBFRDhOSlhUMFViUUZPY1NkWmdSK3ZxV2NYc0djaE5oNUVZcDVNRzRBWUlsU01XbWNWLzZHZlI2Z3VEQjJoa1JzSElPcllSRXpYRkdKSmVvQk11Tm01WGl4TmM1K0lrNEpJSUxkSDVvaXdaMSs4REpjM3kzeG9VaGZkRmJvLzAwdlIvNFJHNmtEbGk0cHRrTW9nOEtmZVA2bkZoT2I1d0Urdk9zbERWWFlrb21aNFdDNUdjTTFLQm1rQWxIVzRFSlQxc0I3aEJJd0FjSWxmL0dTOVQvQzQzNHRhU29LTTR3K3pZb3hab3ZQODZpOGNPaXFlQkgwNjRQSCtaRmJGenRFWWxwaWE5Y2JGNnZVVGJSRGUvM2FCbjViZEVSWWFqcjhIR3FFWmRzbUVwaEt6QkQxa1pnV0dFNmwwWGxrQlVVL3lzTUw0ZkdEMG82eGVMdWlxK0tnc1lmTWRGL1MxNXFDc1FwakFxL1kyWVlEV0NPVGs4NUdQdE5ZTXE4MFBzekZoRlJNcHJ2TWRUVFZVTlpUOTMvbkFUMTluZUR2djFMYUx4SEtYTzlHOVc1dlQ1OURvbFg0TW5CVitBWjFVN1hnSnFzMXBuTy9nSzBKN3hUQlZ1andMWG4yblk4TEN0RmJPZ2QwVWYvSXE4a2RjQlhuZGZUWE1hNTdJRHEyUm43Y3A1Vklaak9ibVVwVlZkRGc1R1lqclROakNBbTJHNVg1R0FEUDBFL040WmR5QWpUWFNvZ2swcUdHd3VSSjkzWUVVWGhSa3RUNW9qc3B4NWtiRU1wWW9NbG9SYjRWVFZzR3lJVW9OS0VydjhYb016SGxhMnB2djRJdDA0YVIyWjF6UStHeUJQSFRLOHFpSEQwSUNoMkFRcHczWFc3YWRiQ2xQZGRzejFXeHRpZVF4eWN1OFVoZU8zeHFrNmNJc2tLVk1jMjJWZitWWmtBM1ZaWWR0MXNkZ2dXVHJTa2RCc21saFNnZ0lOdGcvSGhCc0k4ZDlMMjAxTVlVOFRneGVsSnpPOXRVUUh1MDdRWHFaOUd4aTRaRmFqc3U3eC9wM3psK1FqRW5mR2VCY2hHTUlmMXZQYjhoS0pTUTVmYnRhbFRHWlJrV2VLb0dkYWhvRFU5cnNYbnVHbzUrdVZHNUx6aDFERVlyWWNCZForV3BaWkVlYTJ4czNKTnJFcHpPMUl2YW1SRVF4OFl2WFIwZmVvWUs4Nmo5L2JXcWRGbHBkOThhZmUvU0k3ZmIvZmY2L1A5TjBxZ2ZENUwrS3NSTUlJUDB6dWNBd3BpT1JWMTcwZTl1QmZNNHovWVgxN0NuLzhZZFNZT1I0eHFSTmZqZ3Znc3FVVGo4aEhsRnArZi93T08wYVordVE0QUFBPT0ifQ.4h7MKol3jaNyuDU_jOwrSW4FiW-kiGTfnGBjAdbOLJc");
xhr.send(data); Responses
{
"data": {
"responses": [
{
"responseId": "d825238e-6573-4982-8a76-77e0394c31a1",
"created": "2024-07-31T06:04:06.193Z"
}
]
"message": "Responses are created"
}
} {
"success": false,
"code": 400,
"status": "Bad Request",
"error": "VALIDATION_ERROR",
"message": "Invalid Responses",
"data": {
"errors": {
"name": [
"Invalid Responses"
]
}
}
} {
"error": {
"name": "Internal Server Error",
"message": "We were not able to process your request"
}
}