This section is only applicable if you have purchased the health care listings plan and have been onboarded on the same.
Show child attributes
Response
OK
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Birdeye Developer Portal","colors":{"primary":"#007AFF","light":"#3395FF","dark":"#0055CC"},"logo":{"light":"https://mintcdn.com/birdeye-0229a3ce/UGWhTcR8ROU1U6UM/images/birdeye-vector-logo.svg?fit=max\u0026auto=format\u0026n=UGWhTcR8ROU1U6UM\u0026q=85\u0026s=2a909a704f4e2bbfdc09801f660a2265","dark":"https://mintcdn.com/birdeye-0229a3ce/fd4F54fLnDLtDWF0/images/birdeye-vector-logo-dark.svg?fit=max\u0026auto=format\u0026n=fd4F54fLnDLtDWF0\u0026q=85\u0026s=8c188d7bcbf3c5140059fc0044e4d385"},"favicon":"https://mintcdn.com/birdeye-0229a3ce/hPnwFq14OPbAVJLt/images/birdeye-favicon.svg?fit=max\u0026auto=format\u0026n=hPnwFq14OPbAVJLt\u0026q=85\u0026s=e82b5184dbaedf10e12df434049ed2e6","api":{"examples":{"prefill":true}},"navbar":{"links":[{"href":"https://birdeye.com","label":"Birdeye"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/birdeye"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"birdeye-0229a3ce","hasAudioNarration":false,"actualSubdomain":"birdeye-0229a3ce","customDomains":["docs.birdeye.com"],"gitSource":{"type":"github","owner":"birdeyeinc","repo":"birdeye-api-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"0bc25e83-7973-474d-98c9-a13f1ed6cd33","liveDeploymentHistoryId":"6adb43a225769d6ebcdbd033","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb43a225769d6ebcdbd033"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adb43a225769d6ebcdbd033","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":213},{"language":"default","tag":"Reference","count":207},{"language":"default","tag":"MCP","count":107},{"language":"default","tag":"Tools","count":102},{"language":"default","tag":"Business","count":25},{"language":"default","tag":"Reviews","count":23},{"language":"default","tag":"Insight AI","count":18},{"language":"default","tag":"Report","count":18},{"language":"default","tag":"Contact","count":17},{"language":"default","tag":"Listing","count":17}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":".nav-tabs-item{font-weight:600!important}.nav-tabs-item[aria-current=location],.nav-tabs-item[data-active=true]{font-weight:700!important}[class*=branding],[class*=powered],a[href*=\"mintlify.com\"]{display:none!important}"}],"page":{"pagePath":"api/listing/update-listing","slug":"/api/listing/update-listing","pageMetadata":{"title":"Update Listing","openapi":"api/openapi.yaml PUT /v1/listing/{businessNumber}/update","description":"The Update Listing API will update the location details on all your listings sites.","href":"/api/listing/update-listing"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"The Update Listing API will update the location details on all your listings sites.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update Listing","openapi":"api/openapi.yaml PUT /v1/listing/{businessNumber}/update","description":"The Update Listing API will update the location details on all your listings sites.","href":"/api/listing/update-listing"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"responses":{"200":"11194ccb-6389-43bf-89c5-d089f48903df","400":"8f5cd228-23e1-4112-b381-cf68521aaf80","401":"134c5b61-1de7-4e38-9fd8-c8d5625ece26","429":"30113ddd-e664-4261-b5b4-ec09fc24b43f"},"summary":"Update Listing","operationId":"updateListing","description":"The Update Listing API will update the location details on all your listings sites.","tags":["Listing"],"parameters":["997dda30-1653-45e3-a8b0-dab5291b18ea","d1f10439-253a-4f05-9e49-71cdc440ffea","4c962b41-4277-4100-a3ab-c882ed6e4c62","bbe97d71-ee2b-4f97-92a9-15984c423086"],"requestBody":"245beb1e-b72a-4d23-9980-2915472439db","method":"put","type":"path","servers":["f50b9d30-5cd5-4d34-9445-d1b5377cec53"],"security":[],"path":"/v1/listing/{businessNumber}/update","baseUrlOptions":["https://api.birdeye.com/resources"],"title":"Update Listing","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.businessInfo.name":"Dieci Lifestyle Spa","body.businessInfo.phone":"(973) 716-0007","body.businessInfo.websiteUrl":"http://www.diecispa.org/","body.businessInfo.emailId":"test@example.com","body.businessInfo.isAddressHidden":false,"body.businessInfo.isServiceAreaProvider":false,"body.businessInfo.mainBusinessDescription":"A cozy neighborhood café serving freshly roasted coffee, artisan teas, and homemade pastries in a friendly atmos","body.businessInfo.serviceAreas.items.0.description":"Van An, Berryessa Road, San Jose, CA, USA","body.businessInfo.serviceAreas.items.1.description":"Santa Clara, CA, USA","body.businessInfo.location.zip":7039,"body.businessInfo.location.address1":"90 W Mount Pleasant Ave","body.businessInfo.location.address2":"(btwn Preston Dr. \u0026amp; N. Mitchell Ave.)","body.businessInfo.location.subLocality":"Auckland CBD","body.businessInfo.location.city":"Livingston","body.businessInfo.location.state":"NJ","body.businessInfo.location.countryCode":"US","body.additionalInfo.hoursOfOperations.items.0.day":0,"body.additionalInfo.hoursOfOperations.items.0.workingHours.items.0.startHour":32400,"body.additionalInfo.hoursOfOperations.items.0.workingHours.items.0.endHour":48600,"body.additionalInfo.hoursOfOperations.items.0.workingHours.items.1.startHour":52200,"body.additionalInfo.hoursOfOperations.items.0.workingHours.items.1.endHour":68400,"body.additionalInfo.hoursOfOperations.items.0.isOpen":1,"body.additionalInfo.hoursOfOperations.items.1.day":1,"body.additionalInfo.hoursOfOperations.items.1.workingHours.items.0.startHour":32400,"body.additionalInfo.hoursOfOperations.items.1.workingHours.items.0.endHour":48600,"body.additionalInfo.hoursOfOperations.items.1.workingHours.items.1.startHour":52200,"body.additionalInfo.hoursOfOperations.items.1.workingHours.items.1.endHour":68400,"body.additionalInfo.hoursOfOperations.items.1.isOpen":1,"body.additionalInfo.hoursOfOperations.items.2.day":2,"body.additionalInfo.hoursOfOperations.items.2.workingHours.items.0.startHour":32400,"body.additionalInfo.hoursOfOperations.items.2.workingHours.items.0.endHour":48600,"body.additionalInfo.hoursOfOperations.items.2.workingHours.items.1.startHour":52200,"body.additionalInfo.hoursOfOperations.items.2.workingHours.items.1.endHour":68400,"body.additionalInfo.hoursOfOperations.items.2.isOpen":1,"body.additionalInfo.hoursOfOperations.items.3.day":3,"body.additionalInfo.hoursOfOperations.items.3.workingHours.items.0.startHour":32400,"body.additionalInfo.hoursOfOperations.items.3.workingHours.items.0.endHour":48600,"body.additionalInfo.hoursOfOperations.items.3.workingHours.items.1.startHour":52200,"body.additionalInfo.hoursOfOperations.items.3.workingHours.items.1.endHour":68400,"body.additionalInfo.hoursOfOperations.items.3.isOpen":1,"body.additionalInfo.hoursOfOperations.items.4.day":4,"body.additionalInfo.hoursOfOperations.items.4.workingHours.items.0.startHour":32400,"body.additionalInfo.hoursOfOperations.items.4.workingHours.items.0.endHour":48600,"body.additionalInfo.hoursOfOperations.items.4.workingHours.items.1.startHour":52200,"body.additionalInfo.hoursOfOperations.items.4.workingHours.items.1.endHour":68400,"body.additionalInfo.hoursOfOperations.items.4.isOpen":1,"body.additionalInfo.hoursOfOperations.items.5.day":5,"body.additionalInfo.hoursOfOperations.items.5.workingHours.items.0.startHour":32400,"body.additionalInfo.hoursOfOperations.items.5.workingHours.items.0.endHour":48600,"body.additionalInfo.hoursOfOperations.items.5.workingHours.items.1.startHour":52200,"body.additionalInfo.hoursOfOperations.items.5.workingHours.items.1.endHour":68400,"body.additionalInfo.hoursOfOperations.items.5.isOpen":1,"body.additionalInfo.hoursOfOperations.items.6.day":6,"body.additionalInfo.hoursOfOperations.items.6.workingHours.items.0.startHour":32400,"body.additionalInfo.hoursOfOperations.items.6.workingHours.items.0.endHour":48600,"body.additionalInfo.hoursOfOperations.items.6.workingHours.items.1.startHour":52200,"body.additionalInfo.hoursOfOperations.items.6.workingHours.items.1.endHour":64800,"body.additionalInfo.hoursOfOperations.items.6.isOpen":1,"body.additionalInfo.services":"BeautySalon,HairSpa","body.additionalInfo.establishedYear":"2022","body.additionalInfo.timezone":"America/Los_Angeles","body.additionalInfo.languages.items.0":"English","body.additionalInfo.languages.items.1":"Hindi","body.additionalInfo.wholeWeekOperating":0,"body.additionalInfo.specialHours.items.0.specialDate":"12/31/2020","body.additionalInfo.specialHours.items.0.startHour":32400,"body.additionalInfo.specialHours.items.0.endHour":43200,"body.additionalInfo.specialHours.items.0.isOpen":0,"body.additionalInfo.specialHours.items.1.specialDate":"01/01/2021","body.additionalInfo.specialHours.items.1.startHour":"","body.additionalInfo.specialHours.items.1.endHour":"","body.additionalInfo.specialHours.items.1.isOpen":1,"body.additionalInfo.businessStatus":"Open","body.additionalInfo.reopenDate":"01/01/2021","body.additionalInfo.keywords":"HairSalons,DaySpas,BeautySalon,BeautySalons,Salons, MassageTherapists","body.additionalInfo.products":"LivingProofDryShampoo,KevinMurphyBlondeAngelWash","body.additionalInfo.appointmentLink":"http://www.gmail.com","body.additionalInfo.reservationLink":"http://www.gmail.com","body.additionalInfo.menuLink":"http://www.gmail.com","body.additionalInfo.orderAheadLink":"http://www.gmail.com","body.additionalInfo.impressum":"Thisissampleimpressum","body.additionalInfo.paymentTypes.items.0":"China Union Pay","body.additionalInfo.paymentTypes.items.1":"Bitcoin","body.additionalInfo.paymentTypes.items.2":"Cash Accepted","body.additionalInfo.paymentTypes.items.3":"MasterCard","body.additionalInfo.paymentTypes.items.4":"PayPal","body.additionalInfo.paymentTypes.items.5":"Check / Cheque","body.additionalInfo.paymentTypes.items.6":"Contactless Payment","body.additionalInfo.paymentTypes.items.7":"Debit Card","body.additionalInfo.paymentTypes.items.8":"Diners Club","body.additionalInfo.paymentTypes.items.9":"JCB","body.additionalInfo.paymentTypes.items.10":"Financing","body.additionalInfo.paymentTypes.items.11":"Visa","body.additionalInfo.paymentTypes.items.12":"American Express","body.additionalInfo.paymentTypes.items.13":"Cash Only","body.additionalInfo.paymentTypes.items.14":"Rupay","body.additionalInfo.paymentTypes.items.15":"Credit Card","body.additionalInfo.paymentTypes.items.16":"Discover","body.additionalInfo.additionalPaymentTypes":"Visa,MasterCard,AmericanExpress,DebitCards,Check","body.additionalInfo.localPhoneNumber":"(973)716-0102","body.additionalInfo.tollFreePhoneNumber":"","body.additionalInfo.androidAppURL":"http://www.gmail.com","body.additionalInfo.iosAppURL":"http://www.gmail.com","body.media.logoUrl":"https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082646457/2816b900140211eb870e7bf4ed6bc766.png","body.media.coverImageUrl":"https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082720956/GustavKlimtExpectationTreeoflifeArboldelaVidaFulfilment.jpeg","body.media.gmbCover":"https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082807649/41cdeb014d36cb35f936152d44c4c77d.jpeg","body.media.facebookCover":"https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082871068/IJ8Sa5.jpeg","body.optOut.gmbLogoOptOut":true,"body.optOut.fbLogoOptOut":false,"body.optOut.gmbCoverOptOut":true,"body.optOut.fbCoverOptOut":false,"body.optOut.gmbProfileOptOut":false,"body.optOut.businessProfileOptOut":false,"body.covidInfo.postDescription":"SampleCovidDesc","body.covidInfo.covid19SupportLink":"http://www.covidInfo.com","body.covidInfo.virtualCareLink":"http://www.covidInfo.com","body.bingListing.primaryCategoryBing":"Art Restoration Service","body.bingListing.bingCategories.items.0":"Art Restoration Service","body.bingListing.bingPhoneNumber":"(415) 673-0868","body.bingListing.bingDescription":"Sample Bing Description","body.internalListing.category":"Beauty","body.internalListing.subCategories.items.0":"Eyelash Service","body.internalListing.subCategories.items.1":"Nail Salons","body.internalListing.description":"ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic","body.internalListing.displayCategory":"Eyelash Service","body.facebookListing.facebookPhoneNumber":"(415) 673-0868","body.facebookListing.categories.items.0":"Science","body.facebookListing.categories.items.1":"Sports","body.facebookListing.facebookDescription":"This is sample facebook description","body.facebookListing.facebookPrivacyAndLegalDescription":"This is sample privacy and legal description for the business.","body.gmbListing.googleWebsiteUrl":"http://www.gmail.com","body.gmbListing.googlePhoneNumber":"(973) 716-0007","body.gmbListing.googleStoreId":"1232133","body.gmbListing.primaryCategoryGmb":"Fast Food Restaurant","body.gmbListing.additionalCategories.items.0":"Snack bar","body.gmbListing.googleDescription":"This is sample description for google","body.gmbListing.attributes":{"Accessibility":[{"attributeId":"has_wheelchair_accessible_elevator","attributeName":"Wheelchair accessible elevator","value":false}],"Crowd":[{"attributeId":"welcomes_families","attributeName":"Family-friendly","value":true}]},"body.gmbListing.hotelAttributes":{"business":{"business":{"meetingRoomsCount":{"attributeId":"meetingRoomsCount","attributeName":"Number of meeting rooms","value":20}}},"policies":{"policies":{"checkinTime":{"attributeId":"checkinTime","attributeName":"Check-In Time","value":"14:00"},"checkoutTime":{"attributeId":"checkoutTime","attributeName":"Check-Out Time","value":"11:00"}}},"property":{"property":{"builtYear":{"attributeId":"builtYear","attributeName":"Built Year","value":2010}}},"services":{"services":{"frontDesk":{"attributeId":"frontDesk","attributeName":"Front desk","value":true},"giftShop":{"attributeId":"giftShop","attributeName":"Gift shop","value":false},"languagesSpoken":{"attributeId":"languagesSpoken","attributeName":"Languages Spoken","value":"English,Spanish,French"}}}},"body.gmbListing.foodDelivery":"https://www.ubereats.com","body.gmbListing.foodTakeout":"https://www.ubereats.com","body.gmbListing.whatsappBusinessLink":"https://wa.me/9737160007","body.gmbListing.textMessageNumber":"973716-0007","body.appleListing.phoneNumber":"+1 201-819-7989","body.appleListing.appleWebsiteUrl":"https://www.apple.com","body.appleListing.primaryCategory":"health_care.dentistry.dental_clinic.dentist","body.appleListing.additionalCategories.items.0":"health_care.dentistry.dental_clinic.dentist.oral_surgeon","body.appleListing.appleLocationAttributes":{"crossbusiness.accessibility_features":[{"attributeId":"accessible_elevator"}],"crossbusiness.family_kids":[{"attributeId":"kidsclub"},{"attributeId":"parents_waitingarea"}]},"body.appleListing.appleActionLinks":[{"id":"quicklinks.schedule_appointment","deepLinkUrl":"https://www.google.com","appStoreUrl":"https://apps.apple.com/your_apps_store_url"}],"body.appleListing.appleBusinessName":"This is sample business name","body.appleListing.appleBusinessDescription":"This is sample business description","body.thirdPartyListing.thirdPartyCategory":"Towing Service","body.thirdPartyListing.thirdPartySubCategories":["Car Dealer","Auto Glass Shop"],"body.socialProfileURLs.facebookUrl":"http://www.facebook.com/123","body.socialProfileURLs.twitterUrl":"http://www.twitter.com/123","body.socialProfileURLs.googleUrl":"http://www.google.com/123","body.socialProfileURLs.youTubeUrl":"http://www.youtube.com/12","body.socialProfileURLs.instagramUrl":"http://www.instagram.com/12","body.socialProfileURLs.pintrestUrl":"http://www.pinterest.com/12","body.socialProfileURLs.bbbUrl":"http://www.bbb.org/12","body.socialProfileURLs.lendingtreeUrl":"http://www.lendingtree.com/12","body.healthcare.doctorCategories.items.0":"Allergist-Immunologist > Allergy","body.healthcare.doctorCategories.items.1":"Allergist-Immunologist > General","body.healthcare.doctorCategories.items.2":"Addiction Medicine Specialist > General","body.healthcare.isProvider":true,"body.healthcare.practiceName":"General Medicine","body.healthcare.firstName":"John","body.healthcare.middleName":"Jack","body.healthcare.surName":"Doe","body.healthcare.npi":"1245319599","body.healthcare.credentials":"MD","body.healthcare.educationDetails.items.0.courseName":"Medical School","body.healthcare.educationDetails.items.0.university":"Sample University Name","body.healthcare.educationDetails.items.0.year":1998,"body.healthcare.hospitalAffiliationsDetails.items.0.organizationName":"Sample Hospital Name","body.healthcare.hospitalAffiliationsDetails.items.0.state":"CA","body.healthcare.hospitalAffiliationsDetails.items.0.city":"San Jose","body.healthcare.insuranceDetails.items.0.companyName":"Sample Insurance Company","body.healthcare.insuranceDetails.items.0.plan":"PPO","body.healthcare.conditions":"Sample text","body.healthcare.procedures":"Sample text"}]},"dependencies":{"parameters":{"997dda30-1653-45e3-a8b0-dab5291b18ea":{"name":"businessNumber","in":"path","description":"Business Number.","required":true,"example":"169744180007807","schema":{"type":"number","isRequired":true,"description":"Business Number.","uniqueKey":"","typeLabel":"number"}},"d1f10439-253a-4f05-9e49-71cdc440ffea":{"name":"Accept","in":"header","description":"e.g. application/json","required":false,"example":"application/json","schema":{"type":"string","default":"application/json","isRequired":false,"description":"e.g. application/json","uniqueKey":"","typeLabel":"string"}},"4c962b41-4277-4100-a3ab-c882ed6e4c62":{"name":"x-api-key","in":"header","description":"e.g. [Required] Partner specific API key provided by Birdeye for data exchange.","required":false,"example":"[Required] Partner specific API key provided by Birdeye for data exchange.","schema":{"type":"string","isRequired":false,"description":"e.g. [Required] Partner specific API key provided by Birdeye for data exchange.","uniqueKey":"","typeLabel":"string"}},"bbe97d71-ee2b-4f97-92a9-15984c423086":{"name":"Content-Type","in":"header","description":"Media type of the JSON request body.","required":false,"example":"application/json","schema":{"type":"string","default":"application/json","isRequired":false,"description":"Media type of the JSON request body.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"businessInfo":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Business/Product (Max 250 character long).","isRequired":true,"uniqueKey":"businessInfo.name","typeLabel":"string"},"phone":{"type":"string","description":"Your official Business Phone number. Format is (xxx) xxx-xxxx.","isRequired":true,"uniqueKey":"businessInfo.phone","typeLabel":"string"},"websiteUrl":{"type":"string","description":"Business website url.","uniqueKey":"businessInfo.websiteUrl","typeLabel":"string"},"emailId":{"type":"string","description":"Business Email ID.","uniqueKey":"businessInfo.emailId","typeLabel":"string"},"isAddressHidden":{"type":"string","description":"If your business doesn’t have a place for your customers to visit, then you can hide your street address.","uniqueKey":"businessInfo.isAddressHidden","typeLabel":"string"},"isServiceAreaProvider":{"type":"string","description":"If you deliver or provide service at customer locations.","uniqueKey":"businessInfo.isServiceAreaProvider","typeLabel":"string"},"mainBusinessDescription":{"type":"string","description":"Business Description is optional. If this field is included with an empty value in the API request, the existing Business Description will be cleared for the location. If a value is provided, it must contain at least 200 characters. Avoid sending URLs, phone numbers, addresses, or promotional content in this field. Facebook supports up to 255 characters for your description. If it's longer, add a Facebook override description.","uniqueKey":"businessInfo.mainBusinessDescription","typeLabel":"string"},"serviceAreas":{"type":"array","description":"Locations where you deliver or provide service (applicable if isServiceAreaProvider is 'Yes').NOTE: Maximum service areas that can be provided are 10.","items":{"type":"object","properties":{"description":{"type":"string","description":"Area, City, State, Zip, Country. e.g. \"1735 Berryessa Rd, San Jose, CA 95133, USA\", “Onalaska, WI, USA”.","uniqueKey":"businessInfo.serviceAreas.items.[INDEX].description","typeLabel":"string"}},"uniqueKey":"businessInfo.serviceAreas.items.[INDEX]","typeLabel":"object"},"uniqueKey":"businessInfo.serviceAreas","typeLabel":"object[]"},"location":{"type":"object","properties":{"zip":{"type":"string","description":"Zip Code.","isRequired":true,"uniqueKey":"businessInfo.location.zip","typeLabel":"string"},"address1":{"type":"string","description":"Address of the business/location.","uniqueKey":"businessInfo.location.address1","typeLabel":"string"},"address2":{"type":"string","description":"Address of the business/location.","uniqueKey":"businessInfo.location.address2","typeLabel":"string"},"subLocality":{"type":"string","description":"(Char 4-80) Mandatory for: New Zealand (Enter the Suburb) Other Countries: This field is not required. Any data entered here for countries outside of New Zealand will be ignored by the system.","uniqueKey":"businessInfo.location.subLocality","typeLabel":"string"},"city":{"type":"string","description":"City (Max 1000 character long).","uniqueKey":"businessInfo.location.city","typeLabel":"string"},"state":{"type":"string","description":"State (2 character state code).","uniqueKey":"businessInfo.location.state","typeLabel":"string"},"countryCode":{"type":"string","description":"Country Code (2 character country code).","uniqueKey":"businessInfo.location.countryCode","typeLabel":"string"}},"required":["zip"],"description":"Business address","uniqueKey":"businessInfo.location","typeLabel":"object"}},"required":["name","phone"],"description":"Business Information","uniqueKey":"businessInfo","typeLabel":"object"},"additionalInfo":{"type":"object","properties":{"hoursOfOperations":{"type":"array","description":"Regular hours: Regular working hours of the business for each day from Monday to Sunday.","items":{"type":"object","properties":{"day":{"type":"number","description":"0(Monday), 1(Tuesday), 2(Wednesday) and so on.","uniqueKey":"additionalInfo.hoursOfOperations.items.[INDEX].day","typeLabel":"number"},"workingHours":{"type":"array","items":{"type":"object","properties":{"startHour":{"type":"string","description":"Start hour 9:00 (9 AM), 18:00 (6 PM)","uniqueKey":"additionalInfo.hoursOfOperations.items.[INDEX].workingHours.items.[INDEX].startHour","typeLabel":"string"},"endHour":{"type":"string","description":"End hour 9:00 (9 AM), 18:00 (6 PM)","uniqueKey":"additionalInfo.hoursOfOperations.items.[INDEX].workingHours.items.[INDEX].endHour","typeLabel":"string"}},"uniqueKey":"additionalInfo.hoursOfOperations.items.[INDEX].workingHours.items.[INDEX]","typeLabel":"object"},"description":"Working hours of the business","uniqueKey":"additionalInfo.hoursOfOperations.items.[INDEX].workingHours","typeLabel":"object[]"},"isOpen":{"type":"number","description":"0 (Business closed today), 1 (open)","uniqueKey":"additionalInfo.hoursOfOperations.items.[INDEX].isOpen","typeLabel":"number"},"comment":{"type":"string","description":"Add the special instruction.","uniqueKey":"additionalInfo.hoursOfOperations.items.[INDEX].comment","typeLabel":"string"}},"uniqueKey":"additionalInfo.hoursOfOperations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"additionalInfo.hoursOfOperations","typeLabel":"object[]"},"services":{"type":"string","description":"Services offered by the business. Useful in SEO. (Comma separated list of services offered) Business services cannot be more than 1000 characters.","isRequired":true,"uniqueKey":"additionalInfo.services","typeLabel":"string"},"establishedYear":{"type":"number","description":"Year established","uniqueKey":"additionalInfo.establishedYear","typeLabel":"number"},"timezone":{"type":"string","description":"Timezone of the business.","uniqueKey":"additionalInfo.timezone","typeLabel":"string"},"languages":{"type":"array","description":"Languages.","items":{"type":"string","uniqueKey":"additionalInfo.languages.items.[INDEX]","typeLabel":"string"},"uniqueKey":"additionalInfo.languages","typeLabel":"string[]"},"moreHours":{"description":"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.","type":"array","items":{"type":"object","uniqueKey":"additionalInfo.moreHours.items.[INDEX]","typeLabel":"object"},"uniqueKey":"additionalInfo.moreHours","typeLabel":"object[]"},"appleMoreHours":{"description":"Apple more hours for specific services you offer such as Dining, Bar and Delivery. Apple more hours can only be added if apple primary category is added. To get specific types of apple more hours, please refer to Get supported more hours type api. NOTE: In apple more hours, day 0 denotes Monday, day 1 denotes Tuesday, …, day 6 denotes Sunday.","type":"array","items":{"type":"object","uniqueKey":"additionalInfo.appleMoreHours.items.[INDEX]","typeLabel":"object"},"uniqueKey":"additionalInfo.appleMoreHours","typeLabel":"object[]"},"wholeWeekOperating":{"type":"number","description":"Whether your business is open 24/7, Possible Values - 0 or 1.","uniqueKey":"additionalInfo.wholeWeekOperating","typeLabel":"number"},"specialHours":{"type":"array","description":"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.","items":{"type":"object","properties":{"specialDate":{"type":"string","description":"It should be \"MM/DD/YYYY\".","uniqueKey":"additionalInfo.specialHours.items.[INDEX].specialDate","typeLabel":"string"},"startHour":{"type":"string","description":"Start hour 9:00 (9 AM), 18:00 (6 PM)","uniqueKey":"additionalInfo.specialHours.items.[INDEX].startHour","typeLabel":"string"},"endHour":{"type":"string","description":"End hour 9:00 (9 AM), 18:00 (6 PM)","uniqueKey":"additionalInfo.specialHours.items.[INDEX].endHour","typeLabel":"string"},"isOpen":{"type":"number","description":"0(Business closed today), 1 (open)","uniqueKey":"additionalInfo.specialHours.items.[INDEX].isOpen","typeLabel":"number"}},"uniqueKey":"additionalInfo.specialHours.items.[INDEX]","typeLabel":"object"},"uniqueKey":"additionalInfo.specialHours","typeLabel":"object[]"},"businessStatus":{"type":"string","description":"The business status on the listing page can be set to Open, Temporarily Closed, Permanently Closed, or Opening Soon. A Reopen Date is mandatory for 'Temporarily Closed' and 'Opening Soon' statuses, while optional for 'Open'.","uniqueKey":"additionalInfo.businessStatus","typeLabel":"string"},"reopenDate":{"type":"string","description":"Reopen Date is required for the 'Temporarily Closed' and 'Opening Soon' statuses, and optional for 'Open.' The date must be in the 'MM/dd/yyyy' format.","uniqueKey":"additionalInfo.reopenDate","typeLabel":"string"},"keywords":{"type":"string","description":"Important keywords related to the business. Useful in SEO. (Comma separated list of important keywords) Business keywords cannot be more than 1000 characters.","uniqueKey":"additionalInfo.keywords","typeLabel":"string"},"products":{"type":"string","description":"Products about the business. Useful in SEO and Business products cannot be more than 1000 characters.","uniqueKey":"additionalInfo.products","typeLabel":"string"},"appointmentLink":{"type":"string","description":"Let customers book appointments by redirecting them to your appointments page.","uniqueKey":"additionalInfo.appointmentLink","typeLabel":"string"},"reservationLink":{"type":"string","description":"Let customers reserve tables by linking them to your reservations page.","uniqueKey":"additionalInfo.reservationLink","typeLabel":"string"},"menuLink":{"type":"string","description":"Show customers what you serve by linking them to your menu.","uniqueKey":"additionalInfo.menuLink","typeLabel":"string"},"orderAheadLink":{"type":"string","description":"Let customers place delivery and pick-up orders by linking them to your ordering page.","uniqueKey":"additionalInfo.orderAheadLink","typeLabel":"string"},"impressum":{"type":"string","description":"In certain countries (like Austria, Germany and Switzerland), businesses may be required by law to include a statement of ownership on their web presence.","uniqueKey":"additionalInfo.impressum","typeLabel":"string"},"paymentTypes":{"description":"List of payment types accepted by the business.\n\n+ (Members)\n + China Union Pay\n + Bitcoin\n + Cash Accepted\n + MasterCard\n + PayPal\n + Check / Cheque\n + Contactless Payment\n + Debit Card\n + Diners Club\n + JCB\n + Financing\n + Visa\n + American Express\n + Cash Only\n + Rupay\n + Credit Card\n + Discover","type":"array","items":{"type":"string","uniqueKey":"additionalInfo.paymentTypes.items.[INDEX]","typeLabel":"string"},"uniqueKey":"additionalInfo.paymentTypes","typeLabel":"string[]"},"additionalPaymentTypes":{"type":"string","description":"Additional Payment Type (Max 250 character long).","uniqueKey":"additionalInfo.additionalPaymentTypes","typeLabel":"string"},"localPhoneNumber":{"type":"string","description":"Local phone number.","uniqueKey":"additionalInfo.localPhoneNumber","typeLabel":"string"},"tollFreePhoneNumber":{"type":"string","description":"Tollfree number.","uniqueKey":"additionalInfo.tollFreePhoneNumber","typeLabel":"string"},"androidAppURL":{"type":"string","description":"Android app url.","uniqueKey":"additionalInfo.androidAppURL","typeLabel":"string"},"iosAppURL":{"type":"string","description":"IOS app url.","uniqueKey":"additionalInfo.iosAppURL","typeLabel":"string"}},"required":["hoursOfOperations","services"],"description":"Business Additional Information","uniqueKey":"additionalInfo","typeLabel":"object"},"media":{"type":"object","properties":{"logoUrl":{"type":"string","description":"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.","uniqueKey":"media.logoUrl","typeLabel":"string"},"coverImageUrl":{"type":"string","description":"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.","uniqueKey":"media.coverImageUrl","typeLabel":"string"},"gmbCover":{"type":"string","description":"Google Cover Image Url.","uniqueKey":"media.gmbCover","typeLabel":"string"},"facebookCover":{"type":"string","description":"Facebook Cover Image Url.","uniqueKey":"media.facebookCover","typeLabel":"string"}},"description":"Media details.","uniqueKey":"media","typeLabel":"object"},"optOut":{"type":"object","properties":{"gmbLogoOptOut":{"type":"boolean","description":"Update profile photo on your google my business page.","uniqueKey":"optOut.gmbLogoOptOut","typeLabel":"boolean"},"fbLogoOptOut":{"type":"boolean","description":"Update profile photo on your facebook profile.","uniqueKey":"optOut.fbLogoOptOut","typeLabel":"boolean"},"gmbCoverOptOut":{"type":"boolean","description":"Update cover photo on your google my business page.","uniqueKey":"optOut.gmbCoverOptOut","typeLabel":"boolean"},"fbCoverOptOut":{"type":"boolean","description":"Update cover photo on your facebook profile.","uniqueKey":"optOut.fbCoverOptOut","typeLabel":"boolean"},"gmbProfileOptOut":{"type":"boolean","description":"Opt out from the google specific section on the profile page.","uniqueKey":"optOut.gmbProfileOptOut","typeLabel":"boolean"},"businessProfileOptOut":{"type":"boolean","description":"Opt out from the business profile section.","uniqueKey":"optOut.businessProfileOptOut","typeLabel":"boolean"}},"description":"Opt out section","uniqueKey":"optOut","typeLabel":"object"},"covidInfo":{"type":"object","properties":{"postDescription":{"type":"string","description":"This information is posted and updated on your Google business profile page and your FB business page.","uniqueKey":"covidInfo.postDescription","typeLabel":"string"},"covid19SupportLink":{"type":"string","description":"Should be a valid covid19 support url","uniqueKey":"covidInfo.covid19SupportLink","typeLabel":"string"},"virtualCareLink":{"type":"string","description":"Should be a valid url virtual care link","uniqueKey":"covidInfo.virtualCareLink","typeLabel":"string"}},"description":"Provide this data for updating any COVID specific information you want to share with your customers.","uniqueKey":"covidInfo","typeLabel":"object"},"bingListing":{"type":"object","properties":{"primaryCategoryBing":{"type":"string","description":"Primary category of bing.","uniqueKey":"bingListing.primaryCategoryBing","typeLabel":"string"},"bingCategories":{"description":"You can add a maximum of up to 3 categories.","type":"array","items":{"type":"string","uniqueKey":"bingListing.bingCategories.items.[INDEX]","typeLabel":"string"},"uniqueKey":"bingListing.bingCategories","typeLabel":"string[]"},"bingPhoneNumber":{"type":"string","description":"You can provide a phone number which will be pushed only to your Bing listing site and will override the primary phone number set.","uniqueKey":"bingListing.bingPhoneNumber","typeLabel":"string"},"bingDescription":{"type":"string","description":"An ‘About the business description’. Bing description cannot be more than 4096 characters.","uniqueKey":"bingListing.bingDescription","typeLabel":"string"}},"description":"This data will be used to update your Bing listing.","uniqueKey":"bingListing","typeLabel":"object"},"internalListing":{"type":"object","properties":{"category":{"type":"string","description":"Primary category of business.","isRequired":true,"uniqueKey":"internalListing.category","typeLabel":"string"},"subCategories":{"description":"You can add up to 3 subcategories.","type":"array","items":{"type":"string","uniqueKey":"internalListing.subCategories.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"internalListing.subCategories","typeLabel":"string[]"},"description":{"type":"string","description":"Microsite Override Business Description is optional. If this field is included with an empty value in the API request, the existing Microsite Override Business Description will be cleared for the location. Avoid sending URLs, phone numbers, addresses, or promotional content in this field.","uniqueKey":"internalListing.description","typeLabel":"string"},"displayCategory":{"type":"string","description":"Choose one of the category either from primary category or from sub categories.","uniqueKey":"internalListing.displayCategory","typeLabel":"string"}},"required":["category","subCategories"],"description":"Provide data for microsite listing purpose.","uniqueKey":"internalListing","typeLabel":"object"},"facebookListing":{"type":"object","properties":{"facebookPhoneNumber":{"type":"string","description":"Phone number for facebook profile. This phone number will override the main phone number on your Facebook business page","uniqueKey":"facebookListing.facebookPhoneNumber","typeLabel":"string"},"categories":{"description":"You can add up to 3 categories.","type":"array","items":{"type":"string","uniqueKey":"facebookListing.categories.items.[INDEX]","typeLabel":"string"},"uniqueKey":"facebookListing.categories","typeLabel":"string[]"},"facebookDescription":{"type":"string","description":"About/Bio description for your business page. Facebook description cannot be more than 255 characters.","uniqueKey":"facebookListing.facebookDescription","typeLabel":"string"},"facebookPrivacyAndLegalDescription":{"type":"string","description":"This will update the description under the Privacy and Legal information of your page and cannot be more than 32000 characters.","uniqueKey":"facebookListing.facebookPrivacyAndLegalDescription","typeLabel":"string"}},"description":"This data will be used to update your Facebook business page/ listing.","uniqueKey":"facebookListing","typeLabel":"object"},"gmbListing":{"type":"object","properties":{"googleWebsiteUrl":{"type":"string","description":"Website url will update on google listing. This website URL will override your existing website URL on your Google business profile.","uniqueKey":"gmbListing.googleWebsiteUrl","typeLabel":"string"},"googlePhoneNumber":{"type":"string","description":"You can provide a phone number which will be pushed only to your google listing site and will override the primary phone number set.","uniqueKey":"gmbListing.googlePhoneNumber","typeLabel":"string"},"googleStoreId":{"type":"string","description":"Store id for google.","uniqueKey":"gmbListing.googleStoreId","typeLabel":"string"},"primaryCategoryGmb":{"type":"string","description":"Primary category of google.","uniqueKey":"gmbListing.primaryCategoryGmb","typeLabel":"string"},"additionalCategories":{"description":"You can add up to 9 subcategories.","type":"array","items":{"type":"string","uniqueKey":"gmbListing.additionalCategories.items.[INDEX]","typeLabel":"string"},"uniqueKey":"gmbListing.additionalCategories","typeLabel":"string[]"},"googleDescription":{"type":"string","description":"An ‘about your business’ description. Google description cannot be more than 750 characters.","uniqueKey":"gmbListing.googleDescription","typeLabel":"string"},"attributes":{"type":"object","properties":{},"description":"Google my business attributes are highly visible statements about your business that appear on your Google My Business listing. Supported attributes are","uniqueKey":"gmbListing.attributes","typeLabel":"object"},"hotelAttributes":{"type":"object","properties":{},"description":"Hotel attributes are key characteristics and amenities of your property that help guests discover and understand what your hotel offers. These attributes enhance your hotel's visibility and searchability across booking platforms and travel sites. Supported attribute categories are Services, Policies, FoodAndDrink, Pools, Wellness, Activities, Transportation, Families, Connectivity, Business, Accessibility, Pets, Parking, Housekeeping, HealthAndSafety, Sustainability, Property. Each attribute carries an attributeValueType field indicating the expected value format. Supported formats are BOOLEAN (true/false), INTEGER (positive number), YEAR (year string), TIME (HH:mm string), SINGLE_SELECT (one value from possibleValues), or MULTI_SELECT (comma-separated values from possibleValues).","uniqueKey":"gmbListing.hotelAttributes","typeLabel":"object"},"foodDelivery":{"type":"string","description":"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","uniqueKey":"gmbListing.foodDelivery","typeLabel":"string"},"foodTakeout":{"type":"string","description":"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","uniqueKey":"gmbListing.foodTakeout","typeLabel":"string"},"whatsappBusinessLink":{"type":"string","description":"Enter your WhatsApp Business link to display a direct chat option on your live Google Business Profile. This allows customers to easily message you. Example https://wa.me/\u003cyourphonenumber>","uniqueKey":"gmbListing.whatsappBusinessLink","typeLabel":"string"},"textMessageNumber":{"type":"string","description":"Enter a valid phone number to enable a text message chat option on your live Google Business Profile, allowing customers to easily reach you via SMS.","uniqueKey":"gmbListing.textMessageNumber","typeLabel":"string"}},"description":"This data will be used to update your Google Business Profile/ listing.","uniqueKey":"gmbListing","typeLabel":"object"},"appleListing":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"This will be shown as the primary phoneNumber on your Apple maps place card and will replace/ override your business info phone number.","uniqueKey":"appleListing.phoneNumber","typeLabel":"string"},"appleWebsiteUrl":{"type":"string","description":"Website url will update on apple listing. This website URL will override your existing website URL on your Apple Business Connect.","uniqueKey":"appleListing.appleWebsiteUrl","typeLabel":"string"},"primaryCategory":{"type":"string","description":"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.","uniqueKey":"appleListing.primaryCategory","typeLabel":"string"},"additionalCategories":{"description":"You can add upto 5 additional categories most suitable for your business. Please pass an acceptable category name/ id by first getting the approved list using the Get category API.","type":"array","items":{"type":"string","uniqueKey":"appleListing.additionalCategories.items.[INDEX]","typeLabel":"string"},"uniqueKey":"appleListing.additionalCategories","typeLabel":"string[]"},"appleLocationAttributes":{"type":"object","properties":{},"description":"Apple connect attributes are highly visible statements about your business that appear on your Apple Business listing. Few Apple Supported attributes are:","uniqueKey":"appleListing.appleLocationAttributes","typeLabel":"object"},"appleActionLinks":{"type":"object","properties":{},"description":"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.","uniqueKey":"appleListing.appleActionLinks","typeLabel":"object"},"appleBusinessName":{"type":"string","description":"Business name shown on your Apple Business listing. Must be between 3 and 250 characters.","uniqueKey":"appleListing.appleBusinessName","typeLabel":"string"},"appleBusinessDescription":{"type":"string","description":"Business description shown on your Apple Business listing. Must be between 20 and 500 characters.","uniqueKey":"appleListing.appleBusinessDescription","typeLabel":"string"}},"description":"This data will be used to update your Google Business Profile/ listing.","uniqueKey":"appleListing","typeLabel":"object"},"thirdPartyListing":{"type":"object","properties":{"thirdPartyCategory":{"type":"string","description":"Primary business category for third party listings. Note: This is a Mandatory field if vendor is applicable.","uniqueKey":"thirdPartyListing.thirdPartyCategory","typeLabel":"string"},"thirdPartySubCategories":{"type":"string","description":"Additional sub categories. You can set a maximum of 3 sub categories. Note: This is a Mandatory field if thirdPartyCategory is available.","uniqueKey":"thirdPartyListing.thirdPartySubCategories","typeLabel":"string"}},"description":"This data will be used to update your secondary listings sites.","uniqueKey":"thirdPartyListing","typeLabel":"object"},"socialProfileURLs":{"type":"object","properties":{"facebookUrl":{"type":"string","description":"Facebook URL.","uniqueKey":"socialProfileURLs.facebookUrl","typeLabel":"string"},"twitterUrl":{"type":"string","description":"Business Twitter URL.","uniqueKey":"socialProfileURLs.twitterUrl","typeLabel":"string"},"linkedInUrl":{"type":"string","description":"Business LinkedId URL.","uniqueKey":"socialProfileURLs.linkedInUrl","typeLabel":"string"},"googleUrl":{"type":"string","description":"Business Google URL.","uniqueKey":"socialProfileURLs.googleUrl","typeLabel":"string"},"youTubeUrl":{"type":"string","description":"Business Youtube URL.","uniqueKey":"socialProfileURLs.youTubeUrl","typeLabel":"string"},"instagramUrl":{"type":"string","description":"Business Instagram URL.","uniqueKey":"socialProfileURLs.instagramUrl","typeLabel":"string"},"pintrestUrl":{"type":"string","description":"Business Pinterest URL.","uniqueKey":"socialProfileURLs.pintrestUrl","typeLabel":"string"},"bbbUrl":{"type":"string","description":"Business BB URL.","uniqueKey":"socialProfileURLs.bbbUrl","typeLabel":"string"},"lendingtreeUrl":{"type":"string","description":"Business Lending Tree URL.","uniqueKey":"socialProfileURLs.lendingtreeUrl","typeLabel":"string"}},"description":"Profile URLs for business on top rated social sites","uniqueKey":"socialProfileURLs","typeLabel":"object"},"healthcare":{"type":"object","properties":{"doctorCategories":{"type":"array","description":"This is the doctor specific category your business belongs to. Please refer to the sheet \"Doctor Specific Categories\" to get the possible values.","items":{"type":"string","uniqueKey":"healthcare.doctorCategories.items.[INDEX]","typeLabel":"string"},"uniqueKey":"healthcare.doctorCategories","typeLabel":"string[]"},"isProvider":{"type":"boolean","description":"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.","uniqueKey":"healthcare.isProvider","typeLabel":"boolean"},"practiceName":{"type":"string","description":"Name of the practice.Must be less than 191 characters.","uniqueKey":"healthcare.practiceName","typeLabel":"string"},"firstName":{"type":"string","description":"First name of the provider.","uniqueKey":"healthcare.firstName","typeLabel":"string"},"middleName":{"type":"string","description":"Middle name of the provider.","uniqueKey":"healthcare.middleName","typeLabel":"string"},"surName":{"type":"string","description":"Surname of the provider","uniqueKey":"healthcare.surName","typeLabel":"string"},"npi":{"type":"number","description":"National Provider Identifier - NPI. Must be 10 digits","uniqueKey":"healthcare.npi","typeLabel":"number"},"credentials":{"type":"string","description":"Credentials of the provider/practice. Must be less than 25 characters.\n\nThe credential field supports the following healthcare professional credentials:\n\nANP, APN, APRN, ARNP, AUD, BSW, CCCA, CCC-SLP, CNM, CNP, CNS, CPNP, CPNP-PC, CRNA, CRNP, DC, DDS, DMD, DNP, DNP-C, DO, DPM, DPT, DSW, DVM, FNP, FNP-C, FNP-BC, GNP, IBCLC, LAC, LCSW, LLP, LMFT, LP, LPC, LPN, LSW, MBA, MBBS, MD, MPAS, MPH, MS, MSW, ND, NNP, NP, OD, OT, OTR, OTR/L, PA, PAC, PHARMD, PHD, PMHS, PNP, PSYD, RD, RSW, SLP, VMD, WHNP.\n\nExample:\n\n{\n \"credentials\": \"MD\"\n}","uniqueKey":"healthcare.credentials","typeLabel":"string"},"educationDetails":{"type":"array","description":"Education details of the provider/practice. Maximum of 5 entries allowed. Each entry must include courseName, university and year.","items":{"type":"object","properties":{"courseName":{"type":"string","description":"Course/qualification name. Must be exactly one of: Medical School, Internship, Residency, or Fellowship.","uniqueKey":"healthcare.educationDetails.items.[INDEX].courseName","typeLabel":"string"},"university":{"type":"string","description":"University of the provider/practice. Must not exceed 250 characters.","uniqueKey":"healthcare.educationDetails.items.[INDEX].university","typeLabel":"string"},"year":{"type":"integer","description":"Year the course was completed. Must be a valid number between 1964 and the current year.","uniqueKey":"healthcare.educationDetails.items.[INDEX].year","typeLabel":"integer"}},"uniqueKey":"healthcare.educationDetails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"healthcare.educationDetails","typeLabel":"object[]"},"hospitalAffiliationsDetails":{"type":"array","description":"Hospital affiliation details of the provider/practice. Maximum of 10 entries allowed. Each entry must include organizationName, state and city.","items":{"type":"object","properties":{"organizationName":{"type":"string","description":"Name of the hospital/organization. Must not exceed 150 characters.","uniqueKey":"healthcare.hospitalAffiliationsDetails.items.[INDEX].organizationName","typeLabel":"string"},"state":{"type":"string","description":"State of the hospital/organization. Must not exceed 50 characters.","uniqueKey":"healthcare.hospitalAffiliationsDetails.items.[INDEX].state","typeLabel":"string"},"city":{"type":"string","description":"City of the hospital/organization. Must not exceed 50 characters.","uniqueKey":"healthcare.hospitalAffiliationsDetails.items.[INDEX].city","typeLabel":"string"}},"uniqueKey":"healthcare.hospitalAffiliationsDetails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"healthcare.hospitalAffiliationsDetails","typeLabel":"object[]"},"insuranceDetails":{"type":"array","description":"Insurance details accepted by the provider/practice. Maximum of 20 entries allowed. Each entry must include companyName and plan.","items":{"type":"object","properties":{"companyName":{"type":"string","description":"Name of the insurance company. Must not exceed 100 characters.","uniqueKey":"healthcare.insuranceDetails.items.[INDEX].companyName","typeLabel":"string"},"plan":{"type":"string","description":"Insurance plan name. Must not exceed 150 characters.","uniqueKey":"healthcare.insuranceDetails.items.[INDEX].plan","typeLabel":"string"}},"uniqueKey":"healthcare.insuranceDetails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"healthcare.insuranceDetails","typeLabel":"object[]"},"conditions":{"type":"string","description":"Conditions treated by the provider/practice. Must not exceed 1000 characters.","uniqueKey":"healthcare.conditions","typeLabel":"string"},"procedures":{"type":"string","description":"Procedures performed by the provider/practice. Must not exceed 1000 characters.","uniqueKey":"healthcare.procedures","typeLabel":"string"}},"description":"This section is only applicable if you have purchased the health care listings plan and have been onboarded on the same.","uniqueKey":"healthcare","typeLabel":"object"}},"example":{"businessInfo":{"name":"Dieci Lifestyle Spa","phone":"(973) 716-0007","websiteUrl":"http://www.diecispa.org/","emailId":"test@example.com","isAddressHidden":false,"isServiceAreaProvider":false,"mainBusinessDescription":"A cozy neighborhood café serving freshly roasted coffee, artisan teas, and homemade pastries in a friendly atmos","serviceAreas":[{"description":"Van An, Berryessa Road, San Jose, CA, USA"},{"description":"Santa Clara, CA, USA"}],"location":{"address1":"90 W Mount Pleasant Ave","address2":"(btwn Preston Dr. \u0026amp; N. Mitchell Ave.)","subLocality":"Auckland CBD","city":"Livingston","state":"NJ","zip":7039,"countryCode":"US"}},"additionalInfo":{"establishedYear":"2022","timezone":"America/Los_Angeles","languages":["English","Hindi"],"moreHours":{"Dinner":[{"day":0,"isOpen":0,"workingHours":[{"startHour":"","endHour":""}]},{"day":1,"isOpen":0,"workingHours":[{"startHour":"","endHour":""}]},{"day":2,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":72600}]},{"day":3,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":41400}]},{"day":4,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":41400}]},{"day":5,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":41400}]},{"day":6,"isOpen":1,"workingHours":[{"startHour":0,"endHour":73800}]}],"Delivery":[{"day":0,"isOpen":0,"workingHours":[{"startHour":"","endHour":""}]},{"day":1,"isOpen":1,"workingHours":[{"startHour":25200,"endHour":34200}]},{"day":2,"isOpen":1,"workingHours":[{"startHour":7200,"endHour":34200}]},{"day":3,"isOpen":1,"workingHours":[{"startHour":0,"endHour":41400}]},{"day":4,"isOpen":1,"workingHours":[{"startHour":0,"endHour":41400}]},{"day":5,"isOpen":1,"workingHours":[{"startHour":0,"endHour":41400}]},{"day":6,"isOpen":1,"workingHours":[{"startHour":3600,"endHour":3600}]}]},"appleMoreHours":{"Dining Hours":[{"day":0,"isOpen":1,"workingHours":[{"startHour":36000,"endHour":57600}]},{"day":1,"isOpen":1,"workingHours":[{"startHour":36000,"endHour":57600}]},{"day":2,"isOpen":1,"workingHours":[{"startHour":36000,"endHour":57600}]},{"day":3,"isOpen":1,"workingHours":[{"startHour":36000,"endHour":57600}]},{"day":4,"isOpen":1,"workingHours":[{"startHour":36000,"endHour":57600}]},{"day":5,"isOpen":0,"workingHours":[{"startHour":"","endHour":""}]},{"day":6,"isOpen":0,"workingHours":[{"startHour":"","endHour":""}]}]},"wholeWeekOperating":0,"hoursOfOperations":[{"day":0,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":48600},{"startHour":52200,"endHour":68400}]},{"day":1,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":48600},{"startHour":52200,"endHour":68400}]},{"day":2,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":48600},{"startHour":52200,"endHour":68400}]},{"day":3,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":48600},{"startHour":52200,"endHour":68400}]},{"day":4,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":48600},{"startHour":52200,"endHour":68400}]},{"day":5,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":48600},{"startHour":52200,"endHour":68400}]},{"day":6,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":48600},{"startHour":52200,"endHour":64800}]}],"specialHours":[{"specialDate":"12/31/2020","startHour":32400,"endHour":43200,"isOpen":0},{"specialDate":"01/01/2021","startHour":"","endHour":"","isOpen":1}],"businessStatus":"Open","reopenDate":"01/01/2021","keywords":"HairSalons,DaySpas,BeautySalon,BeautySalons,Salons, MassageTherapists","services":"BeautySalon,HairSpa","products":"LivingProofDryShampoo,KevinMurphyBlondeAngelWash","appointmentLink":"http://www.gmail.com","reservationLink":"http://www.gmail.com","menuLink":"http://www.gmail.com","orderAheadLink":"http://www.gmail.com","impressum":"Thisissampleimpressum","paymentTypes":["China Union Pay","Bitcoin","Cash Accepted","MasterCard","PayPal","Check / Cheque","Contactless Payment","Debit Card","Diners Club","JCB","Financing","Visa","American Express","Cash Only","Rupay","Credit Card","Discover"],"additionalPaymentTypes":"Visa,MasterCard,AmericanExpress,DebitCards,Check","localPhoneNumber":"(973)716-0102","tollFreePhoneNumber":"","iosAppURL":"http://www.gmail.com","androidAppURL":"http://www.gmail.com"},"media":{"logoUrl":"https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082646457/2816b900140211eb870e7bf4ed6bc766.png","coverImageUrl":"https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082720956/GustavKlimtExpectationTreeoflifeArboldelaVidaFulfilment.jpeg","gmbCover":"https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082807649/41cdeb014d36cb35f936152d44c4c77d.jpeg","facebookCover":"https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082871068/IJ8Sa5.jpeg"},"optOut":{"gmbCoverOptOut":true,"gmbLogoOptOut":true,"fbCoverOptOut":false,"fbLogoOptOut":false,"gmbProfileOptOut":false,"businessProfileOptOut":false},"covidInfo":{"postDescription":"SampleCovidDesc","covid19SupportLink":"http://www.covidInfo.com","virtualCareLink":"http://www.covidInfo.com"},"bingListing":{"primaryCategoryBing":"Art Restoration Service","bingDescription":"Sample Bing Description","bingCategories":["Art Restoration Service"],"bingPhoneNumber":"(415) 673-0868"},"internalListing":{"description":"ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic","category":"Beauty","subCategories":["Eyelash Service","Nail Salons"],"displayCategory":"Eyelash Service"},"facebookListing":{"facebookDescription":"This is sample facebook description","facebookPrivacyAndLegalDescription":"This is sample privacy and legal description for the business.","facebookPhoneNumber":"(415) 673-0868","categories":["Science","Sports"]},"thirdPartyListing":{"thirdPartyCategory":"Towing Service","thirdPartySubCategories":["Car Dealer","Auto Glass Shop"]},"gmbListing":{"googleWebsiteUrl":"http://www.gmail.com","googleStoreId":"1232133","googlePhoneNumber":"(973) 716-0007","primaryCategoryGmb":"Fast Food Restaurant","googleDescription":"This is sample description for google","additionalCategories":["Snack bar"],"attributes":{"Accessibility":[{"attributeId":"has_wheelchair_accessible_elevator","attributeName":"Wheelchair accessible elevator","value":false}],"Crowd":[{"attributeId":"welcomes_families","attributeName":"Family-friendly","value":true}]},"hotelAttributes":{"business":{"business":{"meetingRoomsCount":{"attributeId":"meetingRoomsCount","attributeName":"Number of meeting rooms","value":20}}},"policies":{"policies":{"checkinTime":{"attributeId":"checkinTime","attributeName":"Check-In Time","value":"14:00"},"checkoutTime":{"attributeId":"checkoutTime","attributeName":"Check-Out Time","value":"11:00"}}},"property":{"property":{"builtYear":{"attributeId":"builtYear","attributeName":"Built Year","value":2010}}},"services":{"services":{"frontDesk":{"attributeId":"frontDesk","attributeName":"Front desk","value":true},"giftShop":{"attributeId":"giftShop","attributeName":"Gift shop","value":false},"languagesSpoken":{"attributeId":"languagesSpoken","attributeName":"Languages Spoken","value":"English,Spanish,French"}}}},"foodDelivery":"https://www.ubereats.com","foodTakeout":"https://www.ubereats.com","whatsappBusinessLink":"https://wa.me/9737160007","textMessageNumber":"973716-0007"},"appleListing":{"primaryCategory":"health_care.dentistry.dental_clinic.dentist","appleWebsiteUrl":"https://www.apple.com","additionalCategories":["health_care.dentistry.dental_clinic.dentist.oral_surgeon"],"appleLocationAttributes":{"crossbusiness.accessibility_features":[{"attributeId":"accessible_elevator"}],"crossbusiness.family_kids":[{"attributeId":"kidsclub"},{"attributeId":"parents_waitingarea"}]},"appleActionLinks":[{"id":"quicklinks.schedule_appointment","deepLinkUrl":"https://www.google.com","appStoreUrl":"https://apps.apple.com/your_apps_store_url"}],"phoneNumber":"+1 201-819-7989","appleBusinessName":"This is sample business name","appleBusinessDescription":"This is sample business description"},"socialProfileURLs":{"googleUrl":"http://www.google.com/123","facebookUrl":"http://www.facebook.com/123","twitterUrl":"http://www.twitter.com/123","youTubeUrl":"http://www.youtube.com/12","linkedinUrl":"http://www.linkedin.com/12","instagramUrl":"http://www.instagram.com/12","pintrestUrl":"http://www.pinterest.com/12","bbbUrl":"http://www.bbb.org/12","lendingtreeUrl":"http://www.lendingtree.com/12"},"healthcare":{"doctorCategories":["Allergist-Immunologist > Allergy","Allergist-Immunologist > General","Addiction Medicine Specialist > General"],"isProvider":true,"practiceName":"General Medicine","firstName":"John","middleName":"Jack","surName":"Doe","npi":"1245319599","credentials":"MD","educationDetails":[{"courseName":"Medical School","university":"Sample University Name","year":1998}],"hospitalAffiliationsDetails":[{"organizationName":"Sample Hospital Name","state":"CA","city":"San Jose"}],"insuranceDetails":[{"companyName":"Sample Insurance Company","plan":"PPO"}],"conditions":"Sample text","procedures":"Sample text"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"businessInfo":{"name":"Dieci Lifestyle Spa","phone":"(973) 716-0007","websiteUrl":"http://www.diecispa.org/","emailId":"test@example.com","isAddressHidden":false,"isServiceAreaProvider":false,"mainBusinessDescription":"A cozy neighborhood café serving freshly roasted coffee, artisan teas, and homemade pastries in a friendly atmos","serviceAreas":[{"description":"Van An, Berryessa Road, San Jose, CA, USA"},{"description":"Santa Clara, CA, USA"}],"location":{"address1":"90 W Mount Pleasant Ave","address2":"(btwn Preston Dr. \u0026amp; N. Mitchell Ave.)","subLocality":"Auckland CBD","city":"Livingston","state":"NJ","zip":7039,"countryCode":"US"}},"additionalInfo":{"establishedYear":"2022","timezone":"America/Los_Angeles","languages":["English","Hindi"],"moreHours":{"Dinner":[{"day":0,"isOpen":0,"workingHours":[{"startHour":"","endHour":""}]},{"day":1,"isOpen":0,"workingHours":[{"startHour":"","endHour":""}]},{"day":2,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":72600}]},{"day":3,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":41400}]},{"day":4,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":41400}]},{"day":5,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":41400}]},{"day":6,"isOpen":1,"workingHours":[{"startHour":0,"endHour":73800}]}],"Delivery":[{"day":0,"isOpen":0,"workingHours":[{"startHour":"","endHour":""}]},{"day":1,"isOpen":1,"workingHours":[{"startHour":25200,"endHour":34200}]},{"day":2,"isOpen":1,"workingHours":[{"startHour":7200,"endHour":34200}]},{"day":3,"isOpen":1,"workingHours":[{"startHour":0,"endHour":41400}]},{"day":4,"isOpen":1,"workingHours":[{"startHour":0,"endHour":41400}]},{"day":5,"isOpen":1,"workingHours":[{"startHour":0,"endHour":41400}]},{"day":6,"isOpen":1,"workingHours":[{"startHour":3600,"endHour":3600}]}]},"appleMoreHours":{"Dining Hours":[{"day":0,"isOpen":1,"workingHours":[{"startHour":36000,"endHour":57600}]},{"day":1,"isOpen":1,"workingHours":[{"startHour":36000,"endHour":57600}]},{"day":2,"isOpen":1,"workingHours":[{"startHour":36000,"endHour":57600}]},{"day":3,"isOpen":1,"workingHours":[{"startHour":36000,"endHour":57600}]},{"day":4,"isOpen":1,"workingHours":[{"startHour":36000,"endHour":57600}]},{"day":5,"isOpen":0,"workingHours":[{"startHour":"","endHour":""}]},{"day":6,"isOpen":0,"workingHours":[{"startHour":"","endHour":""}]}]},"wholeWeekOperating":0,"hoursOfOperations":[{"day":0,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":48600},{"startHour":52200,"endHour":68400}]},{"day":1,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":48600},{"startHour":52200,"endHour":68400}]},{"day":2,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":48600},{"startHour":52200,"endHour":68400}]},{"day":3,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":48600},{"startHour":52200,"endHour":68400}]},{"day":4,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":48600},{"startHour":52200,"endHour":68400}]},{"day":5,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":48600},{"startHour":52200,"endHour":68400}]},{"day":6,"isOpen":1,"workingHours":[{"startHour":32400,"endHour":48600},{"startHour":52200,"endHour":64800}]}],"specialHours":[{"specialDate":"12/31/2020","startHour":32400,"endHour":43200,"isOpen":0},{"specialDate":"01/01/2021","startHour":"","endHour":"","isOpen":1}],"businessStatus":"Open","reopenDate":"01/01/2021","keywords":"HairSalons,DaySpas,BeautySalon,BeautySalons,Salons, MassageTherapists","services":"BeautySalon,HairSpa","products":"LivingProofDryShampoo,KevinMurphyBlondeAngelWash","appointmentLink":"http://www.gmail.com","reservationLink":"http://www.gmail.com","menuLink":"http://www.gmail.com","orderAheadLink":"http://www.gmail.com","impressum":"Thisissampleimpressum","paymentTypes":["China Union Pay","Bitcoin","Cash Accepted","MasterCard","PayPal","Check / Cheque","Contactless Payment","Debit Card","Diners Club","JCB","Financing","Visa","American Express","Cash Only","Rupay","Credit Card","Discover"],"additionalPaymentTypes":"Visa,MasterCard,AmericanExpress,DebitCards,Check","localPhoneNumber":"(973)716-0102","tollFreePhoneNumber":"","iosAppURL":"http://www.gmail.com","androidAppURL":"http://www.gmail.com"},"media":{"logoUrl":"https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082646457/2816b900140211eb870e7bf4ed6bc766.png","coverImageUrl":"https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082720956/GustavKlimtExpectationTreeoflifeArboldelaVidaFulfilment.jpeg","gmbCover":"https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082807649/41cdeb014d36cb35f936152d44c4c77d.jpeg","facebookCover":"https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082871068/IJ8Sa5.jpeg"},"optOut":{"gmbCoverOptOut":true,"gmbLogoOptOut":true,"fbCoverOptOut":false,"fbLogoOptOut":false,"gmbProfileOptOut":false,"businessProfileOptOut":false},"covidInfo":{"postDescription":"SampleCovidDesc","covid19SupportLink":"http://www.covidInfo.com","virtualCareLink":"http://www.covidInfo.com"},"bingListing":{"primaryCategoryBing":"Art Restoration Service","bingDescription":"Sample Bing Description","bingCategories":["Art Restoration Service"],"bingPhoneNumber":"(415) 673-0868"},"internalListing":{"description":"ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic","category":"Beauty","subCategories":["Eyelash Service","Nail Salons"],"displayCategory":"Eyelash Service"},"facebookListing":{"facebookDescription":"This is sample facebook description","facebookPrivacyAndLegalDescription":"This is sample privacy and legal description for the business.","facebookPhoneNumber":"(415) 673-0868","categories":["Science","Sports"]},"thirdPartyListing":{"thirdPartyCategory":"Towing Service","thirdPartySubCategories":["Car Dealer","Auto Glass Shop"]},"gmbListing":{"googleWebsiteUrl":"http://www.gmail.com","googleStoreId":"1232133","googlePhoneNumber":"(973) 716-0007","primaryCategoryGmb":"Fast Food Restaurant","googleDescription":"This is sample description for google","additionalCategories":["Snack bar"],"attributes":{"Accessibility":[{"attributeId":"has_wheelchair_accessible_elevator","attributeName":"Wheelchair accessible elevator","value":false}],"Crowd":[{"attributeId":"welcomes_families","attributeName":"Family-friendly","value":true}]},"hotelAttributes":{"business":{"business":{"meetingRoomsCount":{"attributeId":"meetingRoomsCount","attributeName":"Number of meeting rooms","value":20}}},"policies":{"policies":{"checkinTime":{"attributeId":"checkinTime","attributeName":"Check-In Time","value":"14:00"},"checkoutTime":{"attributeId":"checkoutTime","attributeName":"Check-Out Time","value":"11:00"}}},"property":{"property":{"builtYear":{"attributeId":"builtYear","attributeName":"Built Year","value":2010}}},"services":{"services":{"frontDesk":{"attributeId":"frontDesk","attributeName":"Front desk","value":true},"giftShop":{"attributeId":"giftShop","attributeName":"Gift shop","value":false},"languagesSpoken":{"attributeId":"languagesSpoken","attributeName":"Languages Spoken","value":"English,Spanish,French"}}}},"foodDelivery":"https://www.ubereats.com","foodTakeout":"https://www.ubereats.com","whatsappBusinessLink":"https://wa.me/9737160007","textMessageNumber":"973716-0007"},"appleListing":{"primaryCategory":"health_care.dentistry.dental_clinic.dentist","appleWebsiteUrl":"https://www.apple.com","additionalCategories":["health_care.dentistry.dental_clinic.dentist.oral_surgeon"],"appleLocationAttributes":{"crossbusiness.accessibility_features":[{"attributeId":"accessible_elevator"}],"crossbusiness.family_kids":[{"attributeId":"kidsclub"},{"attributeId":"parents_waitingarea"}]},"appleActionLinks":[{"id":"quicklinks.schedule_appointment","deepLinkUrl":"https://www.google.com","appStoreUrl":"https://apps.apple.com/your_apps_store_url"}],"phoneNumber":"+1 201-819-7989","appleBusinessName":"This is sample business name","appleBusinessDescription":"This is sample business description"},"socialProfileURLs":{"googleUrl":"http://www.google.com/123","facebookUrl":"http://www.facebook.com/123","twitterUrl":"http://www.twitter.com/123","youTubeUrl":"http://www.youtube.com/12","linkedinUrl":"http://www.linkedin.com/12","instagramUrl":"http://www.instagram.com/12","pintrestUrl":"http://www.pinterest.com/12","bbbUrl":"http://www.bbb.org/12","lendingtreeUrl":"http://www.lendingtree.com/12"},"healthcare":{"doctorCategories":["Allergist-Immunologist > Allergy","Allergist-Immunologist > General","Addiction Medicine Specialist > General"],"isProvider":true,"practiceName":"General Medicine","firstName":"John","middleName":"Jack","surName":"Doe","npi":"1245319599","credentials":"MD","educationDetails":[{"courseName":"Medical School","university":"Sample University Name","year":1998}],"hospitalAffiliationsDetails":[{"organizationName":"Sample Hospital Name","state":"CA","city":"San Jose"}],"insuranceDetails":[{"companyName":"Sample Insurance Company","plan":"PPO"}],"conditions":"Sample text","procedures":"Sample text"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"11194ccb-6389-43bf-89c5-d089f48903df":{"description":"OK","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"8f5cd228-23e1-4112-b381-cf68521aaf80":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"number","uniqueKey":"code","typeLabel":"number"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"example":{"code":2296,"message":"Invalid Food Delivery link"},"uniqueKey":"","typeLabel":"object"},"x-apiary-response-models":[{"$ref":"#/components/schemas/2296Model"},{"$ref":"#/components/schemas/2297Model"},{"$ref":"#/components/schemas/2290Model"},{"$ref":"#/components/schemas/3334Model"},{"$ref":"#/components/schemas/3335Model"},{"$ref":"#/components/schemas/3336Model"},{"$ref":"#/components/schemas/3337Model"},{"$ref":"#/components/schemas/3348Model"},{"$ref":"#/components/schemas/2511Model"},{"$ref":"#/components/schemas/2512Model"},{"$ref":"#/components/schemas/2513Model"},{"$ref":"#/components/schemas/2514Model"},{"$ref":"#/components/schemas/2515Model"},{"$ref":"#/components/schemas/2516Model"},{"$ref":"#/components/schemas/2517Model"},{"$ref":"#/components/schemas/2518Model"},{"$ref":"#/components/schemas/2519Model"},{"$ref":"#/components/schemas/2520Model"},{"$ref":"#/components/schemas/2521Model"},{"$ref":"#/components/schemas/2522Model"},{"$ref":"#/components/schemas/6000Model"},{"$ref":"#/components/schemas/6001Model"},{"$ref":"#/components/schemas/2827Model"},{"$ref":"#/components/schemas/2828Model"},{"$ref":"#/components/schemas/2829Model"},{"$ref":"#/components/schemas/2830Model"},{"$ref":"#/components/schemas/2831Model"},{"$ref":"#/components/schemas/2832Model"},{"$ref":"#/components/schemas/2833Model"},{"$ref":"#/components/schemas/2834Model"},{"$ref":"#/components/schemas/2835Model"},{"$ref":"#/components/schemas/2836Model"},{"$ref":"#/components/schemas/2837Model"},{"$ref":"#/components/schemas/2838Model"},{"$ref":"#/components/schemas/2839Model"},{"$ref":"#/components/schemas/2840Model"},{"$ref":"#/components/schemas/2841Model"},{"$ref":"#/components/schemas/2842Model"},{"$ref":"#/components/schemas/2843Model"}],"x-apiary-response-examples":{"error_2296":{"value":{"code":2296,"message":"Invalid Food Delivery link"}},"error_2297":{"value":{"code":2297,"message":"Invalid Food Takeout link"}},"error_2290":{"value":{"code":2290,"message":"Food Takeout/Food Delivery not supported for gmb primary category"}},"error_3334":{"value":{"code":2503,"message":"Primary category can not be included in additional category."}},"error_3335":{"value":{"code":2276,"message":"Please add upto 9 GBP additional categories only."}},"error_3336":{"value":{"code":2277,"message":"Duplicate GBP categories are not allowed."}},"error_3337":{"value":{"code":2278,"message":"Primary GBP category is not allowed in additional GBP categories."}},"error_3348":{"value":{"code":2162,"message":"Reopen date should not be less than current date."}},"error_2511":{"value":{"code":2511,"message":"Cannot update business status when listing is already fixed."}},"error_2512":{"value":{"code":2512,"message":"Cannot update opening soon date when listing is already fixed."}},"error_2513":{"value":{"code":2513,"message":"Opened On date can not be in future."}},"error_2514":{"value":{"code":2514,"message":"Opening Soon date is mandatory when business is marked as Opening soon."}},"error_2515":{"value":{"code":2515,"message":"Reopen date is not supported for this date."}},"error_2516":{"value":{"code":2516,"message":"Opening Soon Date can not be more than 1 year from now."}},"error_2517":{"value":{"code":2517,"message":"Opening Soon date should not be less than current date."}},"error_2518":{"value":{"code":2518,"message":"Business Status is mandatory to pass with reopen, opened on and opening soon date."}},"error_2519":{"value":{"code":2519,"message":"Third party categories change for opening soon business is not allowed."}},"error_2520":{"value":{"code":2520,"message":"Open Date is not supported for this date"}},"error_2521":{"value":{"code":2285,"message":"Invalid text message number"}},"error_2522":{"value":{"code":2286,"message":"Invalid whatsapp business link"}},"error_6000":{"value":{"code":6000,"message":"The 'sub_locality' field is mandatory for addresses in New Zealand."}},"error_6001":{"value":{"code":6001,"message":"The 'sub_locality' field cannot exceed 80 characters."}},"error_2827":{"value":{"code":2827,"message":"Education details cannot have more than 5 entries"}},"error_2828":{"value":{"code":2828,"message":"Each education detail must have courseName, university and year"}},"error_2829":{"value":{"code":2829,"message":"Hospital affiliation details cannot have more than 10 entries"}},"error_2830":{"value":{"code":2830,"message":"Each hospital affiliation detail must have organizationName, state and city"}},"error_2831":{"value":{"code":2831,"message":"Insurance details cannot have more than 20 entries"}},"error_2832":{"value":{"code":2832,"message":"Each insurance detail must have companyName and plan"}},"error_2833":{"value":{"code":2833,"message":"Education year must be a valid number"}},"error_2834":{"value":{"code":2834,"message":"Education university name cannot be more than 250 characters"}},"error_2835":{"value":{"code":2835,"message":"Education year must be between 1964 and the current year"}},"error_2836":{"value":{"code":2836,"message":"Hospital affiliation organization name cannot be more than 150 characters"}},"error_2837":{"value":{"code":2837,"message":"Hospital affiliation state cannot be more than 50 characters"}},"error_2838":{"value":{"code":2838,"message":"Hospital affiliation city cannot be more than 50 characters"}},"error_2839":{"value":{"code":2839,"message":"Conditions cannot be more than 1000 characters"}},"error_2840":{"value":{"code":2840,"message":"Procedures cannot be more than 1000 characters"}},"error_2841":{"value":{"code":2841,"message":"Education course must be exactly one of: Medical School, Internship, Residency, or Fellowship"}},"error_2842":{"value":{"code":2842,"message":"Insurance company name cannot be more than 100 characters"}},"error_2843":{"value":{"code":2843,"message":"Insurance plan name cannot be more than 150 characters"}}},"examples":{"response":{"title":"response","value":{"code":2296,"message":"Invalid Food Delivery link"}}},"exampleType":"examples"}},"exampleType":"examples"},"134c5b61-1de7-4e38-9fd8-c8d5625ece26":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"number","uniqueKey":"code","typeLabel":"number"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"example":{"code":1161,"message":"Invalid API key"},"uniqueKey":"","typeLabel":"object"},"examples":{"response":{"title":"response","value":{"code":1161,"message":"Invalid API key"}}},"exampleType":"examples"}},"exampleType":"examples"},"30113ddd-e664-4261-b5b4-ec09fc24b43f":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"number","uniqueKey":"code","typeLabel":"number"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"example":{"code":89,"message":"Rate limit exceeded"},"uniqueKey":"","typeLabel":"object"},"examples":{"response":{"title":"response","value":{"code":89,"message":"Rate limit exceeded"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{},"servers":{"f50b9d30-5cd5-4d34-9445-d1b5377cec53":{"url":"https://api.birdeye.com/resources"}}},"originalFileLocation":"api/openapi.yaml"},"subdomain":"birdeye-0229a3ce","siteName":"Birdeye Developer Portal","title":"Update Listing - Birdeye Developer Portal","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-17T11:34:55.712Z","originalFileLocation":"api/listing/update-listing.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The Update Listing API will update the location details on all your listings sites.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Birdeye Developer Portal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/birdeye-0229a3ce/emhvamJ1iO9evqX0/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/birdeye-0229a3ce/emhvamJ1iO9evqX0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/birdeye-0229a3ce/emhvamJ1iO9evqX0/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/birdeye-0229a3ce/emhvamJ1iO9evqX0/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/birdeye-0229a3ce/emhvamJ1iO9evqX0/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/birdeye-0229a3ce/emhvamJ1iO9evqX0/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/birdeye-0229a3ce/emhvamJ1iO9evqX0/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/birdeye-0229a3ce/emhvamJ1iO9evqX0/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/birdeye-0229a3ce/emhvamJ1iO9evqX0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Listing - Birdeye Developer Portal\">\u003cmeta data-mint-head property=\"og:description\" content=\"The Update Listing API will update the location details on all your listings sites.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Birdeye Developer Portal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.birdeye.com/api/listing/update-listing\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://birdeye-0229a3ce.mintlify.app/_mintlify/api/og/v2?division=Listing\u0026amp;title=Update+Listing\u0026amp;description=The+Update+Listing+API+will+update+the+location+details+on+all+your+listings+sites.\u0026amp;theme=727e5f15fe4ee7dd4f2ad978\u0026amp;signature=d20d151f033c75e1cd1f5b57611e53bf57b6442302e5f87debebe801ef093e2b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update Listing - Birdeye Developer Portal\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The Update Listing API will update the location details on all your listings sites.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://birdeye-0229a3ce.mintlify.app/_mintlify/api/og/v2?division=Listing\u0026amp;title=Update+Listing\u0026amp;description=The+Update+Listing+API+will+update+the+location+details+on+all+your+listings+sites.\u0026amp;theme=727e5f15fe4ee7dd4f2ad978\u0026amp;signature=d20d151f033c75e1cd1f5b57611e53bf57b6442302e5f87debebe801ef093e2b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/birdeye-0229a3ce/emhvamJ1iO9evqX0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Birdeye Developer Portal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#007AFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.birdeye.com/api/listing/update-listing\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/listing/update-listing.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.birdeye.com/#organization\",\"name\":\"Birdeye Developer Portal\",\"url\":\"https://docs.birdeye.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/birdeye-0229a3ce/UGWhTcR8ROU1U6UM/images/birdeye-vector-logo.svg?fit=max\u0026auto=format\u0026n=UGWhTcR8ROU1U6UM\u0026q=85\u0026s=2a909a704f4e2bbfdc09801f660a2265\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.birdeye.com#website\",\"name\":\"Birdeye Developer Portal\",\"url\":\"https://docs.birdeye.com\",\"publisher\":{\"@id\":\"https://docs.birdeye.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.birdeye.com/api/listing/update-listing#webpage\",\"url\":\"https://docs.birdeye.com/api/listing/update-listing\",\"name\":\"Update Listing\",\"description\":\"The Update Listing API will update the location details on all your listings sites.\",\"dateModified\":\"2026-07-17T11:34:55.712Z\",\"isPartOf\":{\"@id\":\"https://docs.birdeye.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.birdeye.com/api/listing/update-listing#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.birdeye.com/api/listing/update-listing#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://docs.birdeye.com/api/business/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Listing\",\"item\":\"https://docs.birdeye.com/api/listing/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update Listing\",\"item\":\"https://docs.birdeye.com/api/listing/update-listing\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.birdeye.com/api/listing/update-listing#apireference\",\"headline\":\"Update Listing\",\"name\":\"Update Listing\",\"description\":\"The Update Listing API will update the location details on all your listings sites.\",\"url\":\"https://docs.birdeye.com/api/listing/update-listing\",\"mainEntityOfPage\":{\"@id\":\"https://docs.birdeye.com/api/listing/update-listing#webpage\"},\"dateModified\":\"2026-07-17T11:34:55.712Z\",\"publisher\":{\"@id\":\"https://docs.birdeye.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.birdeye.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Birdeye Developer Portal\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Birdeye Developer Portal","nav":{"global":null,"tabs":[{"tab":"MCP","icon":"https://mintlify.s3.us-west-1.amazonaws.com/birdeye-0229a3ce/images/mcp.svg","pages":[{"title":"MCP","href":"/mcp/introduction"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Get Started","icon":"rocket","pages":[{"title":"Introduction","href":"/api/introduction"},{"title":"Authentication and Rate limiting","href":"/api/authentication"},{"title":"Pagination","href":"/api/pagination"},{"title":"HTTP Status Codes","href":"/api/http-status-codes"},{"title":"Error Response","href":"/api/error-response"},{"title":"Change Logs","href":"/api/changelog"}]},{"group":"Reference","pages":[{"group":"Business","icon":"building","pages":[{"title":"Business","href":"/api/business/overview"},{"title":"Create Business","openapi":"api/openapi.yaml POST /v1/signup/reseller/subaccount","href":"/api/business/create-a-business"},{"title":"Search","openapi":"api/openapi.yaml POST /v1/business/{businessNumber}/search","href":"/api/business/search-business"},{"title":"Get","openapi":"api/openapi.yaml GET /v1/business/{business_id}","href":"/api/business/get-business"},{"title":"Update","openapi":"api/openapi.yaml PUT /v1/business/{businessId}","href":"/api/business/update-business"},{"title":"Delete","openapi":"api/openapi.yaml DELETE /v1/business/{business_Id}","href":"/api/business/delete-business"},{"title":"Status Update","openapi":"api/openapi.yaml PUT /v1/business/{business_id}/status","href":"/api/business/update-the-status"},{"title":"Child Businesses","openapi":"api/openapi.yaml GET /v1/business/child/all","href":"/api/business/get-child-businesses"},{"title":"Public profile tabs","openapi":"api/openapi.yaml POST /v1/business/tabs","href":"/api/business/update-public-profile-of-businesses"},{"title":"Get Hierarchy","openapi":"api/openapi.yaml GET /v1/business/{businessId}/hierarchy","href":"/api/business/get-hierarchy-for-an-enterprise"},{"title":"Get Hierarchy v2","openapi":"api/openapi.yaml GET /v2/business/hierarchy/info","href":"/api/business/get-hierarchy-v2"},{"title":"Update Hierarchy","openapi":"api/openapi.yaml POST /v1/business/business-hierarchy/location/update-mapping/{businessId}","href":"/api/business/update-hierarchy"},{"title":"Get Custom card details","openapi":"api/openapi.yaml GET /v1/business/{businessNumber}/profile/customcard","href":"/api/business/get-custom-card-details"},{"title":"Manage Custom card","openapi":"api/openapi.yaml PUT /v1/business/public/card/{cardId}","href":"/api/business/update-custom-card"},{"title":"Manage Custom card","openapi":"api/openapi.yaml DELETE /v1/business/public/card/{cardId}","href":"/api/business/delete-custom-card"},{"title":"Get Timezone List","openapi":"api/openapi.yaml GET /v1/business/{businessNumber}/timezones","href":"/api/business/get-timezone-list"},{"title":"Get Birdeye Impressions","openapi":"api/openapi.yaml POST /v1/business/{businessNumber}/birdeye/impressions","href":"/api/business/get-birdeye-impressions"}]},{"group":"Custom Fields","icon":"sliders","pages":[{"title":"Custom Fields","href":"/api/custom-fields/overview"},{"title":"Create Custom Fields","openapi":"api/openapi.yaml POST /v1/business/public/custom-fields/create","href":"/api/custom-fields/create"},{"title":"Update Custom Fields","openapi":"api/openapi.yaml PUT /v1/business/public/custom-fields/update/{fieldId}","href":"/api/custom-fields/update"},{"title":"Get Custom Fields","openapi":"api/openapi.yaml GET /v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}","href":"/api/custom-fields/get"},{"title":"Get Custom Fields List","openapi":"api/openapi.yaml POST /v1/business/public/custom-fields/getList?locationBizNumber={locationBizNumber}","href":"/api/custom-fields/post"},{"title":"Delete Custom Fields","openapi":"api/openapi.yaml DELETE /v1/business/public/custom-fields/delete/{fieldId}","href":"/api/custom-fields/delete"},{"title":"Associate Custom Fields","openapi":"api/openapi.yaml PUT /v1/business/public/custom-fields/associate","href":"/api/custom-fields/associate"},{"title":"Create Custom card","openapi":"api/openapi.yaml POST /v1/business/public/card","href":"/api/custom-fields/create-custom-card"}]},{"group":"User","icon":"user","pages":[{"title":"User","href":"/api/user/overview"},{"title":"Signup","openapi":"api/openapi.yaml POST /v1/user/signup/v2","href":"/api/user/create-user"},{"title":"Update User","openapi":"api/openapi.yaml PUT /v1/user/updateUser","href":"/api/user/update-user"},{"title":"Delete","openapi":"api/openapi.yaml DELETE /v1/user/remove","href":"/api/user/delete-a-user"},{"title":"Password","openapi":"api/openapi.yaml POST /v1/user/forgotpassword","href":"/api/user/forgot-password"},{"title":"Get","openapi":"api/openapi.yaml GET /v1/user/details","href":"/api/user/get-details-of-a-user"}]},{"group":"Reviews","icon":"star","pages":[{"title":"Reviews","href":"/api/reviews/overview"},{"title":"Get","openapi":"api/openapi.yaml POST /v1/review/businessId/{businessId}","href":"/api/reviews/get-reviews"},{"title":"Get Review Responses","openapi":"api/openapi.yaml POST /v1/review/response","href":"/api/reviews/get-review-responses"},{"title":"Archived Get Reviews","openapi":"api/openapi.yaml POST /v1/review/archive/public","href":"/api/reviews/archived-get-reviews"},{"title":"Review Summary","openapi":"api/openapi.yaml GET /v1/review/businessid/{businessId}/summary","href":"/api/reviews/get-reviews-summary"},{"title":"Review Reply","openapi":"api/openapi.yaml PUT /v1/review/reply/business/{businessNumber}/review/{reviewId}","href":"/api/reviews/post-review-reply"},{"title":"Create Tags","openapi":"api/openapi.yaml POST /v1/tag","href":"/api/reviews/create-tags"},{"title":"Delete Tag","openapi":"api/openapi.yaml DELETE /v1/tag/{tagname}","href":"/api/reviews/delete-a-tag"},{"title":"Fetch Tags","openapi":"api/openapi.yaml GET /v1/tag/all","href":"/api/reviews/get-all-tags"},{"title":"Search reviews and assign tags","openapi":"api/openapi.yaml POST /v1/tag/add/review","href":"/api/reviews/assign-tags-to-filtered-reviews"},{"title":"Search reviews and remove tags","openapi":"api/openapi.yaml POST /v1/tag/remove/review","href":"/api/reviews/remove-tags-from-filtered-reviews"},{"title":"Remove tags from all reviews","openapi":"api/openapi.yaml POST /v1/tag/remove/all/review","href":"/api/reviews/remove-particular-tags-from-all-reviews"}]},{"group":"Contact","icon":"address-book","pages":[{"title":"Contact","href":"/api/contact/overview"},{"title":"Create or Update Contact","openapi":"api/openapi.yaml POST /v1/customer-v2/external/saveCustomer","href":"/api/contact/create-or-update-contact"},{"title":"Get Contact","openapi":"api/openapi.yaml POST /v1/customer-v2/external/getCustomer","href":"/api/contact/get-contact"},{"title":"Delete Contact","openapi":"api/openapi.yaml POST /v1/customer-v2/external/deleteCustomer","href":"/api/contact/delete-contact"},{"title":"Check in","openapi":"api/openapi.yaml POST /v1/customer/checkin","href":"/api/contact/customer-checkin"},{"title":"Activity log","openapi":"api/openapi.yaml GET /v1/customer/history/{customerId}","href":"/api/contact/customer-activity-log"},{"title":"Delete Customer","openapi":"api/openapi.yaml DELETE /v1/customer/id/{customerId}","href":"/api/contact/customer-delete"},{"title":"Subscribe/Unsubscribe Customer","openapi":"api/openapi.yaml POST /v1/customer-v2/change-permission","href":"/api/contact/subscribe-unsubscribe-customer"},{"title":"Contacts list","openapi":"api/openapi.yaml POST /v2/customer/list","href":"/api/contact/contact"},{"title":"Customer or Lead list","openapi":"api/openapi.yaml POST /v1/contact/details","href":"/api/contact/customer-or-lead-list"},{"title":"Contact Us","openapi":"api/openapi.yaml POST /v1/contactUs/{businessId}","href":"/api/contact/contact-us-request"},{"title":"Get opt-out Contacts","openapi":"api/openapi.yaml POST /v1/contact/{businessId}/update-feed","href":"/api/contact/get-opt-out-contact-data"}]},{"group":"Contact V2","icon":"address-card","pages":[{"title":"Contact V2","href":"/api/contact-v2/overview"},{"title":"Upsert Contact","openapi":"api/openapi.yaml POST /v1/contact/external/preferences/saveCustomer","href":"/api/contact-v2/upsert-contact"},{"title":"Retrieve Contact","openapi":"api/openapi.yaml POST /v1/contact/external/preferences/getCustomer","href":"/api/contact-v2/retrieve-contact"},{"title":"Customer Check in","openapi":"api/openapi.yaml POST /v1/contact/external/preferences/checkin","href":"/api/contact-v2/customer-checkin"},{"title":"Update Communication Preferences","openapi":"api/openapi.yaml POST /v1/contact/external/preferences/change-permission","href":"/api/contact-v2/update-communication-preferences"},{"title":"Retrieve Opted-Out Contacts","openapi":"api/openapi.yaml POST /v1/contact/external/preferences/update-feed","href":"/api/contact-v2/retrieve-opted-out-contacts"}]},{"group":"Campaign","icon":"bullhorn","pages":[{"title":"Campaign","href":"/api/campaign/overview"},{"title":"Fetch Request URL","openapi":"api/openapi.yaml POST /v1/campaign/external/campaign-request-url","href":"/api/campaign/fetch-request-url"},{"title":"Set Defaullt Review Sources","openapi":"api/openapi.yaml POST /v1/campaign/external/default-review-sources","href":"/api/campaign/set-defaullt-review-sources"}]},{"group":"Aggregation","icon":"layer-group","pages":[{"title":"Aggregation","href":"/api/aggregation/overview"},{"title":"Get source list","openapi":"api/openapi.yaml GET /v1/aggregation/business/{businessId}","href":"/api/aggregation/get-business-aggregation-sources"},{"title":"Get Source List-lite","openapi":"api/openapi.yaml GET /v1/survey/reviewsites-alias","href":"/api/aggregation/get-all-aggregation-source"},{"title":"Add Aggregation Link","openapi":"api/openapi.yaml POST /v1/aggregation/business/{business_id}","href":"/api/aggregation/add-aggregation-url"},{"title":"Delete","openapi":"api/openapi.yaml DELETE /v1/aggregation/business/{businessID}/aggregation/{aggregationID}","href":"/api/aggregation/delete-aggregation-url"}]},{"group":"Report","icon":"chart-bar","pages":[{"title":"Report","href":"/api/report/overview"},{"title":"Dashboard","openapi":"api/openapi.yaml GET /v1/reports/smb","href":"/api/report/get-dashboard-data"},{"title":"Review conversion report","openapi":"api/openapi.yaml GET /v1/reports/business/analytics/email","href":"/api/report/get-review-conversion-report"},{"title":"Review and rating over time","openapi":"api/openapi.yaml POST /v1/reports/review/analytic/time","href":"/api/report/review-and-rating-over-time-report"},{"title":"Reviews \u0026 Rating By Location","openapi":"api/openapi.yaml POST /v1/reports/rating/location","href":"/api/report/reviews-rating-by-location-report"},{"title":"Review Count \u0026 Rating","openapi":"api/openapi.yaml POST /v1/review/report/count-by-rating/{BusinessId}","href":"/api/report/review-count-rating"},{"title":"Review Count \u0026 Rating By Employee","openapi":"api/openapi.yaml POST /v1/review/report/count-by-rating/employee/{BusinessId}","href":"/api/report/review-count-rating-by-employee"},{"title":"Insights Category Report by location","openapi":"api/openapi.yaml POST /v1/keywords/opmetric/location","href":"/api/report/insights-category-report-by-location-report"},{"title":"Competitive Ranking","openapi":"api/openapi.yaml POST /v2/competitive/ranking","href":"/api/report/competitive-ranking-report"},{"title":"NPS Over time","openapi":"api/openapi.yaml POST /v1/reports/nps/time/elst","href":"/api/report/nps-over-time-report"},{"title":"NPS By Location","openapi":"api/openapi.yaml POST /v1/reports/nps/location/elst","href":"/api/report/nps-by-location-report"},{"title":"Review By Source","openapi":"api/openapi.yaml POST /v1/reports/count/reviewsite","href":"/api/report/review-by-source-report"},{"title":"Visitor report","openapi":"api/openapi.yaml POST /v1/reports/count/visitors","href":"/api/report/visitor-report"},{"title":"Usage report","openapi":"api/openapi.yaml POST /v1/reports/usage","href":"/api/report/usage-report"},{"title":"Review Response Rate Over Time","openapi":"api/openapi.yaml POST /v1/review/report/response-rate/time/rate-over-time","href":"/api/report/review-response-rate-over-time"},{"title":"Review Response Rate By Location Overview","openapi":"api/openapi.yaml POST /v1/review/report/response-rate/by-location/overview","href":"/api/report/review-response-rate-by-location-overview"},{"title":"Average Response Time By Location","openapi":"api/openapi.yaml POST /v1/review/report/avg-response-time/by-location","href":"/api/report/average-response-time-by-location"},{"title":"Average Response Time Over Time","openapi":"api/openapi.yaml POST /v1/review/report/avg-response-time/time","href":"/api/report/average-response-time-over-time"}]},{"group":"Survey","icon":"clipboard-list","pages":[{"title":"Survey","href":"/api/survey/overview"},{"title":"Get","openapi":"api/openapi.yaml GET /v1/survey/{survey_id}","href":"/api/survey/get-survey"},{"title":"Submit","openapi":"api/openapi.yaml POST /v1/survey/{survey_id}/submit","href":"/api/survey/post-a-survey-response"},{"title":"List Responses","openapi":"api/openapi.yaml POST /v1/survey/ext/list/responses/{survey_id}","href":"/api/survey/list-responses-for-a-survey"},{"title":"Get Survey Usage by Location","openapi":"api/openapi.yaml POST /v1/survey/{surveyId}/usage/by-location","href":"/api/survey/get-survey-usage-by-location"},{"title":"Get All","openapi":"api/openapi.yaml GET /v1/survey/business/{business_id}/all","href":"/api/survey/get-all-surveys"},{"title":"Create Survey","openapi":"api/openapi.yaml POST /v1/survey/external/create/{businessId}","href":"/api/survey/create-survey"},{"title":"Update Settings","openapi":"api/openapi.yaml POST /v1/survey/{surveyId}/settings/update","href":"/api/survey/update-survey-settings"}]},{"group":"Business Media","icon":"photo-film","pages":[{"title":"Business Media","href":"/api/business-media/overview"},{"title":"Add Media","openapi":"api/openapi.yaml POST /v1/business/{businessNumber}/upload/media","href":"/api/business-media/add-media"},{"title":"Get Media","openapi":"api/openapi.yaml GET /v1/business/{businessNumber}/media/get","href":"/api/business-media/get-media"},{"title":"Update Media","openapi":"api/openapi.yaml PUT /v1/business/{businessNumber}/update/media/{mediaId}","href":"/api/business-media/update-media"},{"title":"Delete Media","openapi":"api/openapi.yaml DELETE /v1/business/{businessNumber}/media/delete","href":"/api/business-media/delete-media"}]},{"group":"Social","icon":"share-nodes","pages":[{"title":"Social","href":"/api/social/overview"},{"title":"Schedule Social Post","openapi":"api/openapi.yaml POST /v1/social/{accountNumber}/schedule","href":"/api/social/schedule-social-post"},{"title":"Edit scheduled Social Post","openapi":"api/openapi.yaml POST /v1/social/post/public/scheduled/edit/{accountNumber}","href":"/api/social/edit-scheduled-social-post"},{"title":"Edit published social Post","openapi":"api/openapi.yaml POST /v1/social/post/public/published/edit/{accountNumber}","href":"/api/social/edit-published-social-post"},{"title":"Delete public social Post","openapi":"api/openapi.yaml POST /v1/social/post/public/delete/{accountNumber}","href":"/api/social/delete-public-social-post"},{"title":"Track Social Post","openapi":"api/openapi.yaml GET /v1/social/{accountNumber}/post/track/{trackingId}","href":"/api/social/track-social-post"},{"title":"Social Open URL Performance Report","openapi":"api/openapi.yaml POST /v1/social/open-url/performance/report","href":"/api/social/social-open-url-performance-report"},{"title":"Upload Social Media","openapi":"api/openapi.yaml POST /v1/social/post/public/media/upload","href":"/api/social/upload-social-media"},{"title":"Track Social Media Upload","openapi":"api/openapi.yaml GET /v1/social/post/public/media/track/{batch_id}","href":"/api/social/track-social-media-upload"}]},{"group":"Employee","icon":"user-tie","pages":[{"title":"Get","openapi":"api/openapi.yaml GET /v1/employee/{businessId}","href":"/api/employee/get-details-of-employees"}]},{"group":"Conversation","icon":"comments","pages":[{"title":"Conversation","href":"/api/conversation/overview"},{"title":"List Conversations","openapi":"api/openapi.yaml POST /v1/messenger/export","href":"/api/conversation/list-conversations"}]},{"group":"Subscription","icon":"bell","pages":[{"title":"Subscription","href":"/api/subscription/overview"},{"title":"Subscribe","openapi":"api/openapi.yaml POST /v1/subscriptions/subscribe","href":"/api/subscription/create-subscription"},{"title":"List","openapi":"api/openapi.yaml GET /v1/subscriptions/list","href":"/api/subscription/list-subscriptions"},{"title":"Unsubscribe","openapi":"api/openapi.yaml GET /v1/subscriptions/unsubscribe/{subscriptionId}","href":"/api/subscription/unsubscribe-subscription"}]},{"group":"Webhook","icon":"webhook","pages":[{"title":"Webhook","href":"/api/webhook/overview"},{"title":"List webhook events","openapi":"api/openapi.yaml GET /v1/messenger/webhook/event","href":"/api/webhook/get-events"},{"title":"Create webhook subscription","openapi":"api/openapi.yaml POST /v1/messenger/subscribe/webhook/event","href":"/api/webhook/create-webhook-subscription"}]},{"group":"Competitor","icon":"trophy","pages":[{"title":"Competitor","href":"/api/competitor/overview"},{"title":"Competitor of Enterprise Business","openapi":"api/openapi.yaml GET /v1/business/{EnterpriseBusinessNumber}/child","href":"/api/competitor/get-competitor-business"},{"title":"Child Business of Competitor","openapi":"api/openapi.yaml GET /v1/business/{EnterpriseCompetitorBusinessId}/child","href":"/api/competitor/get-competitor-child-business"},{"title":"Get Competitors","openapi":"api/openapi.yaml GET /v1/business/{businessId}/competitors","href":"/api/competitor/get-business-competitors"},{"title":"Create Competitor Enterprise","openapi":"api/openapi.yaml POST /v1/signup/competitor/{businessNumber}","href":"/api/competitor/create-new-competitor-enterprise"},{"title":"Create Child Business","openapi":"api/openapi.yaml POST /v1/signup/competitor/{businessId}","href":"/api/competitor/create-new-child-business-in-competitor-enterprise"},{"title":"Add Aggregation Link","openapi":"api/openapi.yaml POST /v1/aggregation/competitor/{compAccountId}/{businessNumber}","href":"/api/competitor/add-new-competitor-aggregation-url"},{"title":"Get Competitor Review","openapi":"api/openapi.yaml POST /v1/review/businessId/{CompetitorEnterpriseBusinessId}","href":"/api/competitor/get-competitor-reviews"},{"title":"Competitive Insight Category","openapi":"api/openapi.yaml POST /v1/competitors/competitive-insight/categories/{businessNumber}","href":"/api/competitor/get-score"},{"title":"Competitive Insight Themes","openapi":"api/openapi.yaml POST /v1/competitors/competitive-insight/themes/{businessNumber}","href":"/api/competitor/get-theme-statistics"},{"title":"Competitive Insight Keywords","openapi":"api/openapi.yaml POST /v1/competitors/competitive-insight/keywords/{businessNumber}","href":"/api/competitor/get-keyword-statistics"}]},{"group":"Competitor AI","icon":"robot","pages":[{"title":"Competitor AI","href":"/api/competitor-ai/overview"},{"title":"Retrieve Competitor Reviews","openapi":"api/openapi.yaml POST /v1/competitors/review","href":"/api/competitor-ai/retrieve-competitor-reviews"},{"title":"Retrieve Competitor Review Metrics","openapi":"api/openapi.yaml POST /v1/competitors/review/metrics","href":"/api/competitor-ai/retrieve-competitor-review-metrics"}]},{"group":"Insight AI","icon":"lightbulb","pages":[{"title":"Insight AI","href":"/api/insight-ai/overview"},{"title":"Insight Experience Score Benchmark","openapi":"api/openapi.yaml POST /v1/insight/experience/scoreBenchmark","href":"/api/insight-ai/get-insight-experience-score-benchmark"},{"title":"Insight Experience Location Info","openapi":"api/openapi.yaml POST /v1/insight/experience/locationInfo","href":"/api/insight-ai/get-insight-experience-location-info"},{"title":"Insight Experience Location Info Rank","openapi":"api/openapi.yaml POST /v1/insight/experience/locationInfo/rank","href":"/api/insight-ai/get-insight-experience-location-info-rank"},{"title":"Insight Experience Over Time","openapi":"api/openapi.yaml POST /v1/insight/experience/over-time","href":"/api/insight-ai/get-insight-experience-over-time"},{"title":"Insight Sentiment Score Benchmark","openapi":"api/openapi.yaml POST /v1/insight/sentiment/scoreBenchmark","href":"/api/insight-ai/get-insight-sentiment-score-benchmark"},{"title":"Insight Sentiment Location Info","openapi":"api/openapi.yaml POST /v1/insight/sentiment/locationInfo","href":"/api/insight-ai/get-insight-sentiment-location-info"},{"title":"Insight Sentiment Location Info Rank","openapi":"api/openapi.yaml POST /v1/insight/sentiment/locationInfo/rank","href":"/api/insight-ai/get-insight-sentiment-location-info-rank"},{"title":"Insight Sentiment Over Time","openapi":"api/openapi.yaml POST /v1/insight/sentiment/over-time","href":"/api/insight-ai/get-insight-sentiment-over-time"},{"title":"Insight Sentiment Category","openapi":"api/openapi.yaml POST /v1/insight/sentiment/category","href":"/api/insight-ai/get-insight-sentiment-category"},{"title":"Insight Reputation Score Benchmark","openapi":"api/openapi.yaml POST /v1/insight/reputation/scoreBenchmark","href":"/api/insight-ai/get-insight-reputation-score-benchmark"},{"title":"Insight Reputation Location Info","openapi":"api/openapi.yaml POST /v1/insight/reputation/locationInfo","href":"/api/insight-ai/get-insight-reputation-location-info"},{"title":"Insight Reputation Location Info Rank","openapi":"api/openapi.yaml POST /v1/insight/reputation/locationInfo/rank","href":"/api/insight-ai/get-insight-reputation-location-info-rank"},{"title":"Insight Reputation Over Time","openapi":"api/openapi.yaml POST /v1/insight/reputation/over-time","href":"/api/insight-ai/get-insight-reputation-over-time"},{"title":"Insight Reputation Source","openapi":"api/openapi.yaml POST /v1/insight/reputation/source","href":"/api/insight-ai/get-insight-reputation-source"}]},{"group":"Google Q\u0026A","icon":"circle-question","pages":[{"title":"Google Q\u0026A","href":"/api/google-q-a/overview"},{"title":"Create Question","openapi":"api/openapi.yaml POST /v1/qna/question/create","href":"/api/google-q-a/create-question"},{"title":"Create Answer","openapi":"api/openapi.yaml POST /v1/qna/answer/create","href":"/api/google-q-a/create-answer"},{"title":"Update Question","openapi":"api/openapi.yaml PUT /v1/qna/question/update","href":"/api/google-q-a/update-question"},{"title":"Update Answer","openapi":"api/openapi.yaml PUT /v1/qna/answer/update","href":"/api/google-q-a/update-answer"},{"title":"Delete Question","openapi":"api/openapi.yaml POST /v1/qna/question/delete","href":"/api/google-q-a/delete-question"},{"title":"Delete Answer","openapi":"api/openapi.yaml POST /v1/qna/answer/delete","href":"/api/google-q-a/delete-answer"},{"title":"Delete All Questions and Answers","openapi":"api/openapi.yaml DELETE /v1/qna/question/deleteAll","href":"/api/google-q-a/delete-all-questions-and-answers"},{"title":"Get All Questions and Answers","openapi":"api/openapi.yaml POST /v1/qna/get","href":"/api/google-q-a/get-all-questions-and-answers"},{"title":"Get All Unanswered Q\u0026A","openapi":"api/openapi.yaml POST /v1/qna/unanswered/get","href":"/api/google-q-a/get-all-unanswered-questions-and-answers"}]},{"group":"Google Services","icon":"globe","pages":[{"title":"Google Services","href":"/api/google-services/overview"},{"title":"Create Service","openapi":"api/openapi.yaml POST /v1/google-services/service/create","href":"/api/google-services/create-service"},{"title":"Get All Services","openapi":"api/openapi.yaml POST /v1/google-services/services","href":"/api/google-services/get-all-services"},{"title":"Update Service","openapi":"api/openapi.yaml POST /v1/google-services/service/update","href":"/api/google-services/update-service"},{"title":"Delete Services","openapi":"api/openapi.yaml POST /v1/google-services/service/delete","href":"/api/google-services/delete-services"},{"title":"Get Location Mapping","openapi":"api/openapi.yaml GET /v1/google-services/service/location-mapping","href":"/api/google-services/get-location-mapping"},{"title":"Update Location Mapping","openapi":"api/openapi.yaml POST /v1/google-services/services/location-mapping","href":"/api/google-services/update-location-mapping"}]},{"group":"FAQ","icon":"circle-question","pages":[{"title":"FAQ","href":"/api/faq/overview"},{"title":"Get All QnA","openapi":"api/openapi.yaml POST /v1/quero/external/get-all-qna","href":"/api/faq/get-all-qna"}]},{"group":"Listing","icon":"map-pin","pages":[{"title":"Listing","href":"/api/listing/overview"},{"title":"Fix Listing","openapi":"api/openapi.yaml POST /v1/listing/fix","href":"/api/listing/fix-listing"},{"title":"Get Location Status Report","openapi":"api/openapi.yaml GET /v1/listing/status/location","href":"/api/listing/get-location-status-report"},{"title":"Listings Insights","openapi":"api/openapi.yaml POST /v1/listing/insights","href":"/api/listing/listings-insights"},{"title":"Listings Insights Datapoints","openapi":"api/openapi.yaml POST /v1/listing/report/{reportType}/datapoints","href":"/api/listing/listings-insights-datapoints"},{"title":"Get GMB Attributes","openapi":"api/openapi.yaml GET /v1/listing/{businessNumber}/gmb-attributes-list","href":"/api/listing/get-gmb-attributes"},{"title":"Get Apple Attributes","openapi":"api/openapi.yaml GET /v1/listing/{businessNumber}/apple-location-attributes-list","href":"/api/listing/get-apple-attributes"},{"title":"Get Apple Action Links","openapi":"api/openapi.yaml GET /v1/listing/{businessNumber}/apple-action-links","href":"/api/listing/get-apple-action-links"},{"title":"Get Category List","openapi":"api/openapi.yaml GET /v1/listing/{businessNumber}/category-list","href":"/api/listing/get-category-list"},{"title":"Create Listing","openapi":"api/openapi.yaml POST /v1/listing/{businessNumber}/create","description":"Create Listing API publishes information on online listing sources. We post presence information on more than 50+ online directories. You can use this API to not just create your detailed listing but also fix/ publish/ sync/ make live at the same time.","href":"/api/listing/create-listing"},{"title":"Update Listing","openapi":"api/openapi.yaml PUT /v1/listing/{businessNumber}/update","href":"/api/listing/update-listing"},{"title":"Get Listing","openapi":"api/openapi.yaml GET /v1/listing/{businessNumber}/get","description":"The Get Listing API will get the listing information for the given business number/ ID.","href":"/api/listing/get-listing"},{"title":"Get More Hours Type","openapi":"api/openapi.yaml GET /v1/listing/{businessNumber}/more-hours-type","href":"/api/listing/get-more-hours-type"},{"title":"Get Google Keywords Count","openapi":"api/openapi.yaml POST /v1/listing/{businessNumber}/gmb/keywords","href":"/api/listing/get-google-keywords-count"},{"title":"Deactivate Listing","openapi":"api/openapi.yaml POST /v1/listing/{businessNumber}/deactivate","href":"/api/listing/deactivate-listing"},{"title":"Retrieve Menu Details","openapi":"api/openapi.yaml POST /v1/listing/menu-details","href":"/api/listing/retrieve-menu-details"},{"title":"Get Hotel Attributes","openapi":"api/openapi.yaml GET /v1/listing/get/hotel-attributes","href":"/api/listing/get-hotel-attributes"}]},{"group":"GMB Products","icon":"bag-shopping","pages":[{"title":"GMB Products","href":"/api/gmb-products/overview"},{"title":"Onboard Google Merchant Account","openapi":"api/openapi.yaml POST /v1/listing/public/product/setup/googleMerchant","href":"/api/gmb-products/onboard-google-merchant-account"},{"title":"Create Product Listing","openapi":"api/openapi.yaml POST /v1/listing/public/product","href":"/api/gmb-products/create-product-listing"},{"title":"Update Product Listing","openapi":"api/openapi.yaml PUT /v1/listing/public/product/{productId}","href":"/api/gmb-products/update-product-listing"},{"title":"Get Product Listing","openapi":"api/openapi.yaml GET /v1/listing/public/product/{productIdentifier}","href":"/api/gmb-products/get-product-listing"},{"title":"Delete Product Listings","openapi":"api/openapi.yaml POST /v1/listing/public/product/deleteProduct","href":"/api/gmb-products/delete-product-listings"},{"title":"Get List Product Listing","openapi":"api/openapi.yaml POST /v1/listing/public/product/getList","href":"/api/gmb-products/get-list-product-listing"},{"title":"Add Products On a Location","openapi":"api/openapi.yaml POST /v1/listing/public/product/addProduct","href":"/api/gmb-products/add-products-on-a-location"},{"title":"Remove Products On a Location","openapi":"api/openapi.yaml POST /v1/listing/public/product/removeProduct","href":"/api/gmb-products/remove-products-on-a-location"}]},{"group":"AI Search","icon":"magnifying-glass","pages":[{"title":"AI Search","href":"/api/search-ai/overview"},{"title":"Get AI Search Configuration","openapi":"api/openapi.yaml GET /v1/listing/searchAi/public/account-setup","href":"/api/search-ai/get-search-ai-configuration"},{"title":"Get AI Search Available Runs","openapi":"api/openapi.yaml GET /v1/listing/searchAi/public/available-runs","href":"/api/search-ai/get-search-ai-available-runs"},{"title":"Get AI Search Citations","openapi":"api/openapi.yaml POST /v1/listing/searchAi/public/citations","href":"/api/search-ai/get-search-ai-citations"},{"title":"Get AI Search Businesses","openapi":"api/openapi.yaml POST /v1/listing/searchAi/public/business","href":"/api/search-ai/get-search-ai-businesses"},{"title":"Get Accuracy Report","openapi":"api/openapi.yaml POST /v1/listing/searchAi/public/aio-details?page-size=100\u0026start-index=0","href":"/api/search-ai/get-accuracy-report"},{"title":"Get Sentiment Report","openapi":"api/openapi.yaml POST /v1/listing/searchAi/public/swot-details?page-size=100\u0026start-index=0","href":"/api/search-ai/get-sentiment-report"}]},{"group":"Ticketing","icon":"ticket","pages":[{"title":"Ticketing","href":"/api/ticketing/overview"},{"title":"Create ticket","openapi":"api/openapi.yaml PUT /v1/ticket/{businessNumber}/create-ticket","href":"/api/ticketing/create-ticket"},{"title":"Add Ticket Comments","openapi":"api/openapi.yaml POST /v1/ticket/{businessNumber}/comment-activity","href":"/api/ticketing/add-ticket-comments"},{"title":"Update ticket","openapi":"api/openapi.yaml PUT /v1/ticket/{businessNumber}/update","href":"/api/ticketing/update-ticket"},{"title":"Get All Ticket Data","openapi":"api/openapi.yaml POST /v1/ticket/{businessNumber}/get/all?","href":"/api/ticketing/get-all-ticket-data"}]},{"group":"Integration","icon":"plug","pages":[{"title":"Integration","href":"/api/integration/overview"},{"title":"Add Business Integration Mapping","openapi":"api/openapi.yaml PUT /v1/integrations/add/businessintegrationmapping","href":"/api/integration/add-locations"}]}]}]}]},"basePath":"","title":"Update Listing - Birdeye Developer Portal","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}