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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Required within parent | Expand Create Blog Post — request body — body |
Referenced models: Create Blog Post — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Create Blog Post — response body |
Referenced models: Create Blog Post — response body
Schemas
Section titled “Schemas”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 — 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 — 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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}