POST /v1/contact/{businessId}/update-feed
Servers
- https://api.birdeye.com/resources
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
businessId |
Number | Yes |
Id of a business (Long). |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
api_key |
String | No |
e.g. [Required] Partner specific API key provided by Birdeye for data exchange. |
Accept |
String | No |
e.g. application/json |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
end |
Number | Yes |
The end date format should be in milliseconds. If the end date is not set and the start date is provided, we will fetch data for 24 hours after the start date. If both are not provided, the latest 24 hours data will be fetched. |
subscriptionStatus[] |
Array | Yes |
Type of subscription update feed we want the data for. Like opted-out to get email and text optouts, and blocked for contacts getting blocked. If not provided, only opted-out updates will be returned, by default. |
start |
Number | Yes |
The start date format should be in milliseconds. If the start date is not set and the end date is provided, we will fetch data for 24 hours before the end date. If both are not provided, the latest 24 hours data will be fetched. |
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.