POST /v1/customer/checkin
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. |
bid |
String | Yes |
Id of the business. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
emailId |
String | No |
Email ID of the customer (optional If business has enabled for sms, then either email or phone will be required). |
name |
String | No |
Name of the customer. |
employees[] |
Array | No | |
phone |
String | No |
Phone number of the customer (optional If business has enabled for sms, then either email or phone will be required). |
additionalParams |
Object | No |
Custom tags can be added as key value pair. |
smsEnabled |
Number | No |
Whether customer has opted to receive SMS request or not. Valid values are 0(false), 1(true). Default is 1. |
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.