HighLevel: Businesses schemas

← Businesses operations · All schemas

Create Business — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional
city	string	Optional
country	string	Optional
description	string	Optional
email	string	Optional
locationId	string	Required within parent
name	string	Required within parent
phone	string	Optional
postalCode	string	Optional
state	string	Optional
website	string	Optional

Create Business — response body

Field	Type	Presence	Description and constraints
$	object	Root
buiseness	JSON	Required within parent	Business Response
buiseness (allOf 1)	Model	All variants apply	Expand Get Businesses by Location — response body — businesses item
success	boolean	Required within parent	Success Value

Referenced models: Get Businesses by Location — response body — businesses item

Delete Business — response body

Field	Type	Presence	Description and constraints
$	object	Root
success	boolean	Required within parent	Success value

Get Business — response body

Field	Type	Presence	Description and constraints
$	object	Root
business	JSON	Required within parent	Business Response
business (allOf 1)	Model	All variants apply	Expand Get Businesses by Location — response body — businesses item

Referenced models: Get Businesses by Location — response body — businesses item

Get Businesses by Location — response body

Field	Type	Presence	Description and constraints
$	object	Root
businesses	array	Required within parent	Business Response
businesses[]	Model	Each item	Expand Get Businesses by Location — response body — businesses item

Referenced models: Get Businesses by Location — response body — businesses item

Get Businesses by Location — response body — businesses item

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	address
city	string	Optional	city
country	string	Optional	country
createdAt	string	Optional	Creation Time Format: date-time
createdBy	JSON	Optional	Created By
createdBy (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
description	string	Optional	description
email	string	Optional	email
id	string	Required within parent	Business Id
locationId	string	Required within parent	locaitonId
name	string	Required within parent	Business Name
phone	string	Optional	phone number
postalCode	string	Optional	postal code
state	string	Optional	state
updatedAt	string	Optional	Last updation time Format: date-time
updatedBy	JSON	Optional	updated By
updatedBy (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
website	string	Optional	website

Referenced models: Delete Event — request body — body

Update Business — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional
city	string	Optional
country	string	Optional
description	string	Optional
email	string	Optional
name	string	Optional
phone	string	Optional
postalCode	string	Optional
state	string	Optional
website	string	Optional