Sign in

v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Blog Post

Update blog post

Update a blog post by id.

Permissions required: Permission to view the blog post and its corresponding space. Permission to update blog posts in the space.

put/blogposts/{id}

Path parameters

idinteger required

The ID of the blog post to be updated. If you don't know the blog post ID, use Get Blog Posts and filter the results.

Request body

idstring required

Id of the blog post.

status'current' | 'draft' required

The updated status of the blog post.

Note, if you change the status of a blog post from 'current' to 'draft' and it has an existing draft, the existing draft will be deleted in favor of the updated draft. Additionally, this endpoint can be used to restore a 'trashed' or 'deleted' blog post to 'current' status. For restoration, blog post contents will not be updated and only the blog post status will be changed.

titlestring required

Title of the blog post.

spaceIdstring

ID of the containing space.

This currently does not support moving the blog post to a different space.

createdAtstring

Created date of the blog post in the format of "yyyy-MM-ddTHH:mm:ss.SSSZ".

Response

Returned if the requested blog post is successfully updated.

idstring

ID of the blog post.

status'current' | 'draft' | 'historical' | 'trashed' | 'deleted' | 'any'

The status of the content.

titlestring

Title of the blog post.

spaceIdstring

ID of the space the blog post is in.

authorIdstring

The account ID of the user who created this blog post originally.

createdAtstring date-time

Date and time when the blog post was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

isFavoritedByCurrentUserboolean

Whether the blog post has been favorited by the current user.