Skip to main content
POST
Get opt-out contact data

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.

Path Parameters

businessId
number
required

Id of a business (Long).

Response

OK

emailOptOut
object[]

All the contacts grouped under this field, which were opted out from email in the given duration

textOptOut
object[]

All the contacts grouped under this field, which were opted out from text in the given duration

blocked
object[]

All the contacts grouped under this field, which were blockedl in the given duration.