Skip to main content
POST
Fetch Request URL

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
businessId
number
required

Id of a business (Long).

customerId
number
required

Id of the Customer.

surveyId
number

Survey Id, required only for survey requests.

templateId
number

Id of Text template, required except for survey requests.

checkinId
number

Checkin id of customer.

Response

OK

externalUId
number

Id of the requested URL.

url
number

Short link of the requested URL.