Set this request parameter to true to return the updated article in the response.
{
"status": "published",
"slug": "my-article",
"name": "My Article",
"text": "Text of the article goes here.",
"categories": [
"5214c83d45667acd25394b54"
],
"related": [
"521509f145667acd25394b5b",
"521509f145667acd25394b5d"
]
}
Accepted Fields
Name
Type
Required
Default
Notes
status
String
N
Options:
published
notpublished
Notes:
If the status is being changed from 'notpublished' to 'published' and a draft exists for the article, the draft will be deleted.
If the status of the article is 'published' and the text of the article is modified, and a draft exists for the article, the draft will be deleted.
slug
String
N
SEO-friendly identifier for the article that can be used in a URL.
name
String
N
Name must be unique for the Collection this Article is associated with.
text
String
N
Article copy can be uploaded as either plain text or in HTML format
categories
Array
N
An array of category ids.
If this attribute is not present in the request, the existing category list will NOT be modified.
If this attribute is present and set to null, all existing categories will be removed from the list and the article will be added to the 'Uncategorized' category.
Otherwise, the article will be associated with the categories in this array.
An Article cannot be manually associated with the 'Uncategorized' category, so that id will not be accepted in this list. To make an Article 'Uncategorized', set this attribute to null.
related
Array
N
An array of article ids.
If this attribute is not present in the request, the existing related article list will NOT be modified.
If this attribute is present and has a value of null, all existing related articles will be removed from the list.
Otherwise, the article will be related to the articles specified in this list.
keywords
Array
N
An array of keywords.
If this attribute is not present in the request, the existing keywords list will NOT be modified.
If this attribute is present and has a value of null, all existing keywords will be removed from the list.
Otherwise, this will replace all keywords currently specified in this list. For any keywords previously in the list be sure to include them in the array.