POST: https://{env}-api.xebo.ai/v3/survey-management/surveys
Query Params:
Key | Type | Mandatory | Description |
---|---|---|---|
folderId | string | no | Folder id where you want to create your survey |
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
Headers
"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 Body
Payload
{
"title": "New Survey",
"category": "banking"
}
Supported Request Payload
Key | Type | Mandatory | Description |
---|---|---|---|
title | string | yes | Title of the survey |
category | string | no | Category of the survey |
Request Sample
cURL
curl --location 'https://az4-api.xebo.ai/v3/survey-management/surveys' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoi
--data '{
"title": "New Survey",
"category": "banking"
} '
Javascript
var data = JSON.stringify({
"title": "New Survey",
"category": "banking"
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://az4-api.xebo.ai/v3/survey-management/surveys");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tl");
xhr.send(data);
Responses
{
"data": {
"uuid": "86629a8d-db49-4982-bdc0-a81a5ebc862e",
"title": "New Survey",
"org": "ac8f122f-84a1-4225-aec3-7ec731b3d2f7",
"blocks": [
"b1bb6175-93f3-4741-acc1-b26dc831ac2b"
]
}
}
{
"success": false,
"code": 401,
"status": "Unauthorized",
"error": "AUTHENTICATION_ERROR",
"message": "The authorization token was not provided"
}
{
"success": false,
"code": 500,
"status": "Internal Server Error",
"error": "SERVER_ERROR",
"message": "Error in processing your request"
}
Note: Please do not share your tokens in publicly accessible areas or to anyone. Also, this token generated is valid for 24 hours only. After its expiry, you can regenerate the access token from the same API endpoint by passing the username and password or from the refresh token API with the help of refresh token.
Ask a human