Skip to content

BIRD-200632 | FR- Add entityCategory field #308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SambhavBirdeye merged 3 commits into from
May 20, 2026
+13 −2
Merged

BIRD-200632 | FR- Add entityCategory field #308

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
56dad45
BIRD-200632
SambhavBirdeye May 18, 2026
c6b96b1
BIRD-200632
SambhavBirdeye May 18, 2026
deb0821
BIRD-200632
SambhavBirdeye May 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions apiary.apib
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2453,7 +2453,8 @@ Create a business API creates a new business under a reseller.
"zip": 32323,
"type": "Business",
"phone": "4032365164",
"countryCode": "US"
"entityCategory": "physical_location",
"countryCode": "US",
"aggrOptions" : 1
}

Expand All @@ -2468,6 +2469,11 @@ Create a business API creates a new business under a reseller.
Reseller
or a existing custom hierarchy type. Default is: Business.
+ phone: 4032365164 (required,number)- Phone number of the Business.
+ entityCategory: physical_location (string) - Specifies the category of the business entity being created or updated. Valid values are:
physical_location,provider.
physical_location represents a physical office, branch, or storefront location.
provider represents an individual practitioner or provider (e.g. doctor, dentist, loan officer) operating within one or more physical locations.
If entityCategory is not provided, the entity is created as physical_location by default.
+ countryCode: AU (string) - This field is mandatory for non US locations.
+ aggrOptions:1 (number)- Aggregation Options to enable/disable aggregations. Possible values are [0,1]
0 to Disable Search Business
Expand Down Expand Up @@ -3091,7 +3097,11 @@ Update Business API updates business information.
+ fieldValue: GR (string)- Custom field value.
+ fieldName: colours (required,string)-Name of custom field (Make sure to enter the same fieldName or else the new field will be created).
+ id: 376 (required,number)- fieldId of the custom field created earlier.

+ entityCategory: physical_location (string) - Specifies the category of the business entity being created or updated. Valid values are:
physical_location,provider.
physical_location represents a physical office, branch, or storefront location.
provider represents an individual practitioner or provider (e.g. doctor, dentist, loan officer) operating within one or more physical locations.
If entityCategory is not provided, the entity is created as physical_location by default.
+ Body

{
Expand Down Expand Up @@ -3346,6 +3356,7 @@ Update Business API updates business information.
"bbbUrl": null
},
"isSEOEnabled": "false",
"entityCategory": "physical_location",
"externalReferenceId" : "",
"customFields": [
{
Expand Down