HighLevel: Links schemas

← Links operations · All schemas

Create Link — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
locationId	string	Required within parent	Location ID of the business profile
name	string	Required within parent	Display name of the trigger link
redirectTo	string	Required within parent	URL or variable to redirect to when the trigger link is clicked

Create Link — response body

Field	Type	Presence	Description and constraints
$	object	Root
link	JSON	Optional	The trigger link object
link (allOf 1)	Model	All variants apply	Expand Get Links — response body — links item

Referenced models: Get Links — response body — links item

Delete Link — response body

Field	Type	Presence	Description and constraints
$	object	Root
succeded	boolean	Optional	Indicates whether the link was successfully deleted (legacy field, misspelled). Use `succeeded` with x-api-version: v3.
succeeded	boolean	Optional	Indicates whether the link was successfully deleted.

Get Links — response body

Field	Type	Presence	Description and constraints
$	object	Root
links	array	Optional	List of trigger links
links[]	Model	Each item	Expand Get Links — response body — links item

Referenced models: Get Links — response body — links item

Get Links — response body — links item

Field	Type	Presence	Description and constraints
$	object	Root
fieldKey	string	Optional	Template variable key used to reference this trigger link
id	string	Optional	Unique identifier of the trigger link
locationId	string	Optional	Location ID this trigger link belongs to
name	string	Optional	Display name of the trigger link
redirectTo	string	Optional	URL or variable to redirect to when the trigger link is clicked

Update Link — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent	Display name of the trigger link
redirectTo	string	Required within parent	URL or variable to redirect to when the trigger link is clicked