POST /v1/survey/external/create/{businessId}
Servers
- https://api.birdeye.com/resources
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
businessId |
String | Yes |
Id of the Business. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | No |
e.g. application/json |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
api_key |
String | Yes |
Partner specific API key provided by Birdeye for data exchange. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
ownerEmailId |
String | No | |
surveyName |
String | No | |
surveyType |
String | No | |
pages[] |
Array | No | |
pages[].questions[] |
Array | Yes | |
pages[].questions[].contactRows[] |
Array | No | |
pages[].questions[].contactRows[].required |
Boolean | Yes | |
pages[].questions[].contactRows[].title |
String | Yes | |
pages[].questions[].contactRows[].type |
String | Yes | |
pages[].questions[].required |
Boolean | Yes | |
pages[].questions[].interval |
Number | No | |
pages[].questions[].showDate |
Boolean | No | |
pages[].questions[].choices[] |
Array | Yes | |
pages[].questions[].reviewSources[] |
Array | No | |
pages[].questions[].showTime |
Boolean | No | |
pages[].questions[].minLabel |
String | Yes | |
pages[].questions[].title |
String | Yes | |
pages[].questions[].type |
String | Yes | |
pages[].questions[].minValue |
String | No | |
pages[].questions[].maxLabel |
String | Yes | |
pages[].questions[].rows[] |
Array | Yes | |
pages[].questions[].contactUsMessage |
String | No | |
pages[].title |
String | Yes | |
thankYouMessage |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.