HighLevel: Blogs schemas

← Blogs operations · All schemas

Check url slug — response body

Field	Type	Presence	Description and constraints
$	object	Root
exists	boolean	Required within parent	Indicates whether the url slug exists or not

Create Blog Post — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
author	string	Required within parent	This needs to be author id, which you can get from the author get api call.
blogId	string	Required within parent	You can find the blog id from blog site dashboard link
canonicalLink	string	Optional
categories	array	Required within parent	This needs to be array of category ids, which you can get from the category get api call.
categories[]	string	Each item
description	string	Required within parent
imageAltText	string	Required within parent
imageUrl	string	Required within parent
locationId	string	Required within parent
publishedAt	string	Required within parent	Provide ISO timestamp
rawHTML	string	Required within parent
status	string	Required within parent	One of: DRAFT, PUBLISHED, SCHEDULED, ARCHIVED schema: {"type": "string"}
tags	array	Optional
tags[]	string	Each item
title	string	Required within parent
urlSlug	string	Required within parent

Create Blog Post — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	Model	Required within parent	Expand Create Blog Post — response body — data Object containing response data of blog post create.

Referenced models: Create Blog Post — response body — data

Create Blog Post — response body — data

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Unique identifier of the blog post
archived	boolean	Required within parent	Indicates whether the blog post is archived
author	string	Optional	Identifier of the author of the blog post
canonicalLink	string	Optional	Canonical link of the blog post
categories	array	Required within parent	Array of category IDs associated with the blog post
categories[]	string	Each item
description	string	Required within parent	Description of the blog post
imageAltText	string	Required within parent	Alternative text for the blog post image
imageUrl	string	Required within parent	URL of the image associated with the blog post
publishedAt	string	Required within parent	Timestamp when the blog post was published
status	string	Required within parent	Publication status of the blog post
tags	array	Optional	Array of tags associated with the blog post
tags[]	string	Each item
title	string	Required within parent	Title of the blog post
updatedAt	string	Required within parent	Timestamp when the blog post was last updated
urlSlug	string	Required within parent	URL slug for the blog post

Get Blog posts by Blog ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
blogs	array	Required within parent	Object containing response data of blog posts
blogs[]	Model	Each item	Expand Create Blog Post — response body — data

Referenced models: Create Blog Post — response body — data

Get Blogs by Location ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent	Object containing response data of blog
data[]	Model	Each item	Expand Get Blogs by Location ID — response body — data item

Referenced models: Get Blogs by Location ID — response body — data item

Get Blogs by Location ID — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Unique identifier of the blog
name	string	Required within parent	Name of the blog

Get all authors — response body

Field	Type	Presence	Description and constraints
$	object	Root
authors	array	Required within parent	Array of authors
authors[]	Model	Each item	Expand Get all authors — response body — authors item

Referenced models: Get all authors — response body — authors item

Get all authors — response body — authors item

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

Get all categories — response body

Field	Type	Presence	Description and constraints
$	object	Root
categories	array	Required within parent	Array of categories
categories[]	Model	Each item	Expand Get all categories — response body — categories item

Referenced models: Get all categories — response body — categories item

Get all categories — response body — categories item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent
canonicalLink	string	Required within parent
label	string	Optional
locationId	string	Required within parent
updatedAt	string	Required within parent
urlSlug	string	Required within parent

Update Blog Post — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
author	string	Required within parent	This needs to be author id, which you can get from the author get api call.
blogId	string	Required within parent	You can find the blog id from blog site dashboard link
canonicalLink	string	Optional
categories	array	Required within parent	This needs to be array of category ids, which you can get from the category get api call.
categories[]	string	Each item
description	string	Required within parent
imageAltText	string	Required within parent
imageUrl	string	Required within parent
locationId	string	Required within parent
publishedAt	string	Required within parent	Provide ISO timestamp
rawHTML	string	Required within parent
status	string	Required within parent	One of: DRAFT, PUBLISHED, SCHEDULED, ARCHIVED schema: {"type": "string"}
tags	array	Optional
tags[]	string	Each item
title	string	Required within parent
urlSlug	string	Required within parent
wordCount	number	Required within parent

Update Blog Post — response body

Field	Type	Presence	Description and constraints
$	object	Root
updatedBlogPost	Model	Required within parent	Expand Create Blog Post — response body — data Object containing response data of blog post update

Referenced models: Create Blog Post — response body — data