HighLevel: Funnels schemas

← Funnels operations · All schemas

Create Redirect — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
action	string	Required within parent	One of: funnel, website, url, all
domain	string	Required within parent
locationId	string	Required within parent
path	string	Required within parent
target	string	Required within parent

Create Redirect — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	Data containing details of the created redirect
data (allOf 1)	Model	All variants apply	Expand Create Redirect — response body — data action, domain, id, location Id, path, path Lowercase, target, type

Referenced models: Create Redirect — response body — data action, domain, id, location Id, path, path Lowercase, target, type

Create Redirect — response body — data action, domain, id, location Id, path, path Lowercase, target, type

Field	Type	Presence	Description and constraints
$	object	Root
action	string	Required within parent	Action performed by the redirect
domain	string	Required within parent	Domain where the redirect occurs
id	string	Required within parent	Unique identifier of the redirect
locationId	string	Required within parent	Identifier of the location associated with the redirect
path	string	Required within parent	Original path that will be redirected
pathLowercase	string	Required within parent	Lowercase version of the original path
target	string	Required within parent	Target URL to which the original path will be redirected
type	string	Required within parent	Type of redirect (e.g., Permanent, Temporary)

Delete Redirect By Id — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	object	Required within parent	Status of the delete operation

Fetch List of Funnels — response body

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Required within parent
count (anyOf 1)	number	Alternative
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
funnels	object	Required within parent
traceId	string	Required within parent

Fetch List of Redirects — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	object	Required within parent	Object containing the count of redirects and an array of redirect data

Fetch count of funnel pages — response body

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Required within parent
count (anyOf 1)	number	Alternative
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Fetch list of funnel pages — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent
deleted	string	Required within parent
funnelId	string	Required within parent
locationId	string	Required within parent
name	string	Required within parent
stepId	string	Required within parent
updatedAt	string	Required within parent

Update Redirect By Id — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
action	string	Required within parent	One of: funnel, website, url, all
locationId	string	Required within parent
target	string	Required within parent

Update Redirect By Id — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	Data containing details of the updated redirect
data (allOf 1)	Model	All variants apply	Expand Create Redirect — response body — data action, domain, id, location Id, path, path Lowercase, target, type

Referenced models: Create Redirect — response body — data action, domain, id, location Id, path, path Lowercase, target, type