Skip to main content
PATCH
Update articles in bulk
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Body

application/json

Send article_ids and exactly one of category_id, state or status. Sending none, or more than one, returns 422.

article_ids
string[]
required

Between 1 and 100 articles, each given by slug, permalink identifier or UUID.

Required array length: 1 - 100 elements
Example:
category_id
string<uuid>

Moves the articles to this category.

state
enum<string>

Sets the state of the articles.

Available options:
draft,
published
status
enum<string>

Archives or unarchives the articles.

Available options:
archive,
active

Response

OK - Articles updated

updated_articles
object[]