Skip to content

HighLevel: Create Blog Post

HighLevel blogs.createBlogPost: arguments, response, policy and SDK examples.

← Blogs operations · Get started

Operation gohighlevel.create_blog_post

Provider route: POST /blogs/posts. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";
async function execute(input: Parameters<HighLevelIntegration["blogs"]["createBlogPost"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.blogs.createBlogPost(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.blogs.create_blog_post(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Create Blog Post — request body — body

Referenced models: Create Blog Post — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create Blog Post — response body

Referenced models: Create Blog Post — response body

Create Blog Post — response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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 — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
authorstringRequired within parentThis needs to be author id, which you can get from the author get api call.
blogIdstringRequired within parentYou can find the blog id from blog site dashboard link
canonicalLinkstringOptional
categoriesarrayRequired within parentThis needs to be array of category ids, which you can get from the category get api call.
categories[]stringEach item
descriptionstringRequired within parent
imageAltTextstringRequired within parent
imageUrlstringRequired within parent
locationIdstringRequired within parent
publishedAtstringRequired within parentProvide ISO timestamp
rawHTMLstringRequired within parent
statusstringRequired within parentOne of: DRAFT, PUBLISHED, SCHEDULED, ARCHIVED
schema: {"type": "string"}
tagsarrayOptional
tags[]stringEach item
titlestringRequired within parent
urlSlugstringRequired within parent
Create Blog Post — response body — data
FieldTypePresenceDescription and constraints
$objectRoot
_idstringRequired within parentUnique identifier of the blog post
archivedbooleanRequired within parentIndicates whether the blog post is archived
authorstringOptionalIdentifier of the author of the blog post
canonicalLinkstringOptionalCanonical link of the blog post
categoriesarrayRequired within parentArray of category IDs associated with the blog post
categories[]stringEach item
descriptionstringRequired within parentDescription of the blog post
imageAltTextstringRequired within parentAlternative text for the blog post image
imageUrlstringRequired within parentURL of the image associated with the blog post
publishedAtstringRequired within parentTimestamp when the blog post was published
statusstringRequired within parentPublication status of the blog post
tagsarrayOptionalArray of tags associated with the blog post
tags[]stringEach item
titlestringRequired within parentTitle of the blog post
updatedAtstringRequired within parentTimestamp when the blog post was last updated
urlSlugstringRequired within parentURL slug for the blog post

SDK function policy ID: gohighlevel.create_blog_post. Catalog operation: create-blog-post. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["blogs/post.write"]

Pinned headers: {"Version": "v3"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.