POST /v1/customer-v2/change-permission
Servers
- https://api.birdeye.com/resources
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 |
|---|---|---|---|
permission |
String | No |
unsubscribed (string, required) - Action to be taken. Valid values are both-subscribed, both-unsubscribed, sms-subscribed, and email-subscribed. |
accountNumber |
Number | Yes |
Location id. |
email[] |
Array | No |
Customer email ids. |
phone[] |
Array | No |
Customer phone numbers. |
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.