Help Center API limitations with content blocks

Content blocks let authors insert the same content in multiple help center articles. See Reusing content with content blocks in Zendesk help.

Certain articles in the help center may have content blocks and others may not. The Help Center API behaves normally with articles that don't have any content blocks. However, the API has the following limitations with articles that have content blocks.

Getting or listing articles

You can use the Show Article and List Articles endpoints to get articles that have content blocks. However, the content of any content block is converted to inline text in the response. Example:

"body": "<p>This article has content blocks enabled.</p>\n<p>This is a content block.</p>\n<p>This is the rest of the article.</p>"

Updating an article or translation

The body property of the Update Article and Update Translation endpoints do not support content blocks. In other words, there are no placeholders for content blocks in the body.

Even if you make a preliminary GET request to get the body of an article with content blocks to use in your update, the content blocks are converted to flat text in the GET response. After updating the article, the links to the content blocks in the Guide editor are replaced with the flat text.

Updating any other article or translation property does not affect any content blocks in the article.

Archiving an article

You can use the Archive Article endpoint to archive articles containing content blocks.