POST /v1/customer-v2/external/saveCustomer
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. |
businessId |
String | Yes |
Id of the business. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Id of enterprise customer. |
email |
String | No |
Email of customer, optional (if phone is provided). |
customFields[] |
Array | No |
List of Custom fields. We currently support 4 types of customfields - text, number, currency, date (in formats - “MM/dd/yyyy” and "MM-dd-yyyy" only), and yes or no (1:"yes", 0:"no"). |
lastName |
String | No |
Last name of the customer. |
emailOptin |
Boolean | No |
Email Opt flag. |
phone |
String | No |
Phone of customer optional (if email is provided). |
tags |
String | No |
List of tags. |
blocked |
Boolean | No |
Contact block flag. |
firstName |
String | No |
First name of the customer. |
businessIds[] |
Array | No |
Business Ids under enterprise account. The Business Ids field is mandatory while creating a new contact. While updating, if no business Ids are provided, the same location mappings are retained. |
countryCode |
String | No |
Country code of the phone number. Default value=US, Other Possible values=AU,CA,MX,PR,VI |
smsOptin |
Boolean | No |
SMS Opt flag. |
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.