Updating an Article

You can update all or part of your article through the API with a PATCH to /article/:article_id. Only send us what's changed.

Taylor Sloane
Updated by Taylor Sloane

PATCH /article/:article_id

Arguments

Required?

article_id

Yes

title

No

category_id

No

user_id

No

body

No

is_private

No

is_published

No

description

No

short_version

No

icon

No

slug

No

tags

No

multilingual

No

Example response:

{
"article": Article
}

Updating Multilingual Content

The multilingual array can contain any translations you want to update. Here's the properties available on each ArticleMultilingual object:

Arguments

Required?

language_code

Yes

title

No

body

No

description

No

short_version

No

slug

No

tags

No

is_live

No

You only need to pass the fields that you want to update. So this is a perfectly acceptable request:

PATCH /article/:article_id {
multilingual: [
language_code: "de",
title: "New german title"
]
}

That would just update the German title of your article, leaving all the other properties as they were before.

How did we do?

The Article Object

Contact

This site is protected by hCaptcha and its Privacy Policy and Terms of Service apply.