v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB

Custom Content

Update custom content

Update a custom content by id. At most one of spaceId, pageId, blogPostId, or customContentId is allowed in the request body. Note that if spaceId is specified, it must be the same as the spaceId used for creating the custom content as moving custom content to a different space is not supported.

Permissions required: Permission to view the content of the page or blogpost and its corresponding space. Permission to update custom content in the space.

put/custom-content/{id}

Path parameters

idinteger required

The ID of the custom content to be updated. If you don't know the custom content ID, use Get Custom Content by Type and filter the results.

Request body

idstring required

Id of custom content.

typestring required

Type of custom content.

status'current' required

The status of the custom content.

spaceIdstring

ID of the containing space (must be the same as the spaceId of the space the custom content was created in).

pageIdstring

ID of the containing page.

blogPostIdstring

ID of the containing Blog Post.

customContentIdstring

ID of the containing custom content.

titlestring required

Title of the custom content.

Response

Returned if the requested custom content is updated successfully.

idstring

ID of the custom content.

typestring

The type of custom content.

The status of the content.

titlestring

Title of the custom content.

spaceIdstring

ID of the space the custom content is in.

Note: This is always returned, regardless of if the custom content has a container that is a space.

pageIdstring

ID of the containing page.

Note: This is only returned if the custom content has a container that is a page.

blogPostIdstring

ID of the containing blog post.

Note: This is only returned if the custom content has a container that is a blog post.

customContentIdstring

ID of the containing custom content.

Note: This is only returned if the custom content has a container that is custom content.

authorIdstring

The account ID of the user who created this custom content originally.

createdAtstring date-time

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