Skip to main content
POST
Subscribe/Unsubscribe Customer

Headers

Accept
string
default:application/json

e.g. application/json

x-api-key
string

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

Content-Type
string
default:application/json

Media type of the JSON request body.

Body

application/json
permission
string
required

Action to be taken. Valid values are both-subscribed, both-unsubscribed, sms-subscribed, and email-subscribed.

accountNumber
number
required

Location id.

email
any[]

Customer email ids.

phone
any[]

Customer phone numbers.

Response

OK