POST /v1/listing/{businessNumber}/create

Business Number.

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

e.g. application/json

Default value: "application/json"

This section is only applicable if you have purchased the health care listings plan and have been onboarded on the same.

Insurance Accepted of the provider/practice. Must be less than 50 characters

University of the provider/practice. Must be less than 25 characters

Immunologist > Allergy, Allergist-Immunologist > General (array) - This is the doctor specific category your business belongs to. Please refer to the sheet "Doctor Specific Categories" to get the possible values.

First name of the provider.

If provider then select value true. If practice then select value false. This is a true/false toggle for determining if the location is a provider or not.

University of the provider/practice. Must be less than 255 characters

National Provider Identifier - NPI. Must be 10 digits

Hospital Affiliations of the provider/practice. Must be less than 150 characters

Name of the practice.Must be less than 191 characters.

Middle name of the provider.

Surname of the provider

Provide this data for updating any COVID specific information you want to share with your customers.

This information is posted and updated on your Google business profile page and your FB business page.

Should be a valid url virtual care link

Should be a valid covid19 support url

Business Information

Business Email ID.

Name of the Business/Location. Should be Max 1000 characters long.

If your business doesn’t have a place for your customers to visit, then you can hide your street address.

If you deliver or provide service at customer locations.

Business address

Zip Code.

Address of the business.

Address of the business.

State (2 character state code).

Country Code (2 character country code).

City (Max 1000 character long).

Your official Business Phone number. Format is (xxx) xxx-xxxx.

Business website url.

Locations where you deliver or provide service (applicable if isServiceAreaProvider is 'Yes').NOTE: Maximum service areas that can be provided are 10.

This data will be used to update your Bing listing.

You can add a maximum of up to 3 categories.

You can provide a phone number which will be pushed only to your Bing listing site and will override the primary phone number set.

An ‘About the business description’. Bing description cannot be more than 4096 characters.

Primary category of bing.

This data will be used to update your Facebook business page/ listing.

An ‘about your business’ description. Facebook description cannot be more than 255 characters.

You can add up to 3 categories.

Phone number for facebook profile. This phone number will override the main phone number on your Facebook business page

Business Additional Information

Year established

Tollfree number.

Services offered by the business. Useful in SEO. (Comma separated list of services offered) Business services cannot be more than 1000 characters.

Payment Type (Max 250 character long).

Regular hours: Regular working hours of the business for each day from Monday to Sunday.

Languages.

Let customers place delivery and pick-up orders by linking them to your ordering page.

Timezone of the business.

Whether your business is open 24/7, Possible Values - 0 or 1.

For special holiday days, where you may have limited hours of operation and don’t want to change your preset regular hours. These would only be applicable only for the dates they are set for.

Important keywords related to the business. Useful in SEO. (Comma separated list of important keywords) Business keywords cannot be more than 1000 characters.

Show customers what you serve by linking them to your menu.

Products about the business. Useful in SEO and Business products cannot be more than 1000 characters.

In certain countries (like Austria, Germany and Switzerland), businesses may be required by law to include a statement of ownership on their web presence.

Local phone number.

Android app url.

Reopen date is applicable only when the status is "temporarily closed". It should be "MM/DD/YYYY" format.

Let customers reserve tables by linking them to your reservations page.

IOS app url.

Google more hours for specific services you offer such as delivery, takeout, drive-through, and pickup (see: Supported More Hours). Google more hours can only be added if google primary category is added. To get specific types of more hours, please refer to Get supported more hours type api. NOTE: In more hours, day 0 denotes Monday, day 1 denotes Tuesday, …, day 6 denotes Sunday.

Please refer /listing/get-more-hours-type/get-more-hours-type api to get google more hours type. Possible Values Breakfast, Lunch, Pickup, etc.

It will update your business status on lisitng page and If business will choose "Temporarily closed" then Reopen date is mandatry. [Open, Temporarily closed, Permanently closed]

This data will be used to update your Google Business Profile/ listing.

You can provide a phone number which will be pushed only to your google listing site and will override the primary phone number set.

Google my business attributes are highly visible statements about your business that appear on your Google My Business listing. Supported attributes are

Accessibility,Amenities,Crowd,Dining options,Highlights,Planning,Offerings,Health & safety.

Primary category of google.

You can add up to 5 subcategories.

Enter the redirect URL where customers can place delivery orders.This field is applicable for hospitality business and is category dependent.Example http://www.ubereats.com

Enter the redirect URL where customers can place 'takeout' food orders. This field is applicable for hospitality business and is category dependent.Example : http://www.ubereats.com

Website url will update on google listing. This website URL will override your existing website URL on your Google business profile.

Store id for google.

An ‘about your business’ description. Google description cannot be more than 750 characters.

Profile URLs for business on top rated social sites

Business Youtube URL.

Business LinkedId URL.

Business Lending Tree URL.

Facebook URL.

US (string)- Business Google URL.

Business Pinterest URL.

Business Twitter URL.

Business BB URL.

Media details.

This logo will pushed to your listings sites such as Google, Facebook, Bing, Birdeye and all the other secondary listings sites. Format: JPG, JPEG, PNG. Minimum 250 x 250px. Recommended: 720 X 720 px. 10 KB min.

Facebook Cover Image Url.

This cover photo will pushed to your listings sites such as Birdeye and all the other secondary listings sites. Cover image URL for business will be displayed on custom review site. Format: JPG, JPEG, PNG. Minimum 1110 x 374px. 10 KB min.

Google Cover Image Url.

This data will be used to update your secondary listings sites.

Additional sub categories. You can set a maximum of 3 sub categories. Note: This is a Mandatory field if thirdPartyCategory is available.

Primary business category for third party listings. Note: This is a Mandatory field if vendor is applicable.

Provide data for microsite listing purpose.

You can add up to 3 subcategories.

Primary category of business.

Choose one of the category either from primary category or from sub categories.

An ‘about your business’ description. Business description cannot be more than 5000 characters and cannot be less than 200 characters.

This data will be used to update your Google Business Profile/ listing.

Primary category of apple ,This is a mandatory field. Please pass an acceptable category name/ id by first getting the approved list using the Get category API.

You can add upto 5 additional categories most suitable for your business.

This will be shown as the primary phoneNumber on your Apple maps place card and will replace/ override your business info phone number.

Apple actionLinks are shown on the Apple maps place card which helps users to access or redirect to some website or app store. These are typical CTA’s that you would like to expose to your potential customers. Apple action links can only be selected from pre-defined set of action links which you can get using the GET Action links API.

Apple connect attributes are highly visible statements about your business that appear on your Apple Business listing. Few Apple Supported attributes are:

crossbusiness.family_kids.kids_playarea, crossbusiness.barservice.happyhour Crossbusiness.attire.casual .These help your potential customers understand more about your business.

Opt out section

Opt out from the business profile section.

                                        Select ‘true’ if you want to opt out from updating NAP information on your Google Business Profile page.
                                        Select ‘false’ if you want to opt in to updating NAP information on your Google Business Profile page.

Update profile photo on your google my business page.

                                Select ‘true’ if you want to opt out from updating the logo on your GBP page.
                                Select ‘false’ if you want to opt in to updating the logo on your GBP page.

Update cover photo on your google my business page.

                                Select ‘true’ if you want to opt out from updating the cover photo on your GBP page.
                                Select ‘false’ if you want to opt in to updating the cover photo on your GBP page.

Update cover photo on your facebook profile.

                                Select ‘true’ if you want to opt out from updating the cover photo on your FB business page.
                                Select ‘false’ if you want to opt in to updating the cover photo on your FB business page.

Update profile photo on your facebook profile.

                                Select ‘true’ if you want to opt out from updating the logo on your FB business page.
                                Select ‘false’ if you want to opt in to updating the logo on your FB business page.

Opt out from the google specific section on the profile page.

                                    Select ‘true’ if you want to opt out from updating information such as category and related attributes and more hours on your Google Business Profile page.
                                    Select ‘false’ if you want to opt in to updating information such as category and related attributes and more hours on your Google Business Profile page.