Skip to main content
PATCH
Update an article

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the article.

Example:

1

Body

application/json

Fields accepted when updating an article. Unlike create, this accepts status.

title
string

The title of the article

Example:

"Article Title"

slug
string

The slug of the article

Example:

"article-title"

position
integer

article position in category

Example:

1

content
string

The text content.

Example:

"This is the content of the article"

description
string

The description of the article

Example:

"This is the description of the article"

category_id
integer

The category id of the article

Example:

1

author_id
integer

The author agent id of the article

Example:

1

associated_article_id
integer

To associate similar articles to each other, e.g to provide the link for the reference.

Example:

2

status
enum<integer>

0 = draft, 1 = published, 2 = archived. Responses return the name as a string ("draft", "published", "archived"), not this integer.

Available options:
0,
1,
2
locale
string

The locale of the article

Example:

"en"

meta
object

Use for search

Example:

Response

Success

Single-article responses are wrapped in a payload key.

payload
object

An article as the Help Center API renders it. Note that this is not the database row — category and author come back as nested objects rather than as category_id and author_id.