Skip to main content
POST
Customer Checkin

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.

x-business-number
string

e.g. [Required] User assosiated businessNumber

Content-Type
string
default:application/json

Media type of the JSON request body.

Body

application/json
name
string

Name of the customer.

emailId
string

Email ID of the customer (optional If business has enabled for sms, then either email or phone will be required).

phone
string

Phone number of the customer (optional If business has enabled for sms, then either email or phone will be required).

smsEnabled
number

Whether customer has opted to receive SMS request or not. Valid values are 0(false), 1(true). Default is 1.

additionalParams
object

Custom tags can be added as key value pair.

employees
object[]
externalId
string

Unique external identifier of the contact which could be from the CRM or any external system storing your contacts.

emailPreferences
object

Email communication preference flags.

smsPreferences
object

SMS communication preference flags.

Response

OK

customerId
number

Id of enterprise customer.