post

/blog/posts

Creates a Blog Post.

Required Fields

  • title
  • body

Read Only Fields

  • id
  • preview_url
  • summary

Notes

  • When including published_date in a request, supply it as a flat date string (not an object) in valid RFC 2822. The example request below includes a published_date in RFC 2822 format.

  • Blog posts default to draft status. To publish blog posts to the storefront, set their is_published property to true.

  • If a custom URL is not provided, the post’s URL will be generated based on the value of title.

Authorization

apiKey - X-Auth-Token
apiKey - X-Auth-Client

Request Parameters

2 Headers

Request Body

1 Example
Schema
object
id
integer

ID of this blog post. (READ-ONLY)

1 validation
title
string

Title of this blog post.

1 validation + required
url
string

URL for the public blog post.

1 validation
preview_url
string

URL to preview the blog post. (READ-ONLY)

1 validation
body
string

Text body of the blog post.

1 validation + required
tags
array[string]

Tags to characterize the blog post.

summary
string

Summary of the blog post. (READ-ONLY)

1 validation
is_published
boolean

Whether the blog post is published.

1 validation
published_date
string

Published date in RFC-2822 format.

1 validation
meta_description
string

Description text for this blog post’s element.

1 validation
meta_keywords
string

Keywords for this blog post’s element.

1 validation
author
string

Name of the blog post’s author.

1 validation
thumbnail_path
string

Local path to a thumbnail image within the product_images folder to accompany the blog post.

Responses

1 Example

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
2 variables not set
store_hash
X-Auth-Token
X-Auth-Client