POST /v1/messenger/export
Servers
- https://api.birdeye.com/resources
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
endDate |
String | No |
Fetch messages till this date in MM/DD/YYYY format. |
contact |
Object | No |
Contact details |
contact.email |
String | No |
Email Id of the contact. |
contact.phone |
String | No |
Phone number of the contact. |
size |
Number | No |
Number of messages return in the response. |
apiKey |
String | Yes |
Partner specific API key provided by Birdeye for data exchange. |
startDate |
String | No |
Start fetching messages from this date in MM/DD/YYYY format. |
excludeCampaignMessages |
Number | No |
If passed with value 1, It will exclude campaign messages from API response. |
businessNumber |
Number | Yes |
The business number for which the details to be fetched, it can be either enterprise or location business number. |
offset |
Number | No |
Message offset,the start index. |
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.