Skip to main content
PUT
Propose changes to a help center article
Send the complete article body as an HTML fragment in diff_html, with each change wrapped in suggestion markup. An inline change replaces a phrase:
A block change adds, removes or replaces whole paragraphs, with data-diff-suggestion-block, data-diff-suggestion-block-old and data-diff-suggestion-block-new on div elements. Leave an old or new part empty to suggest a pure addition or removal. An inline change holds only text, formatting and whole links to other articles. To change the text of a link to another article, an image or a code block, wrap the whole paragraph or block in a block change instead; an inline change there is refused with 400. To change a collapsible section’s title, wrap the whole <details> element in a block change; a block change between its title and its body, or holding a title without its section, is refused with 400. In a list, change an item’s text with an inline change; a block change may follow the item’s text or wrap the whole list. A block change placed first in an item is turned into an inline change when each side holds a single paragraph with the same attributes, which are kept; otherwise, as for a side holding an image, it is refused with 400. A block change placed between items is refused with 400. Read the article first with Get an article. Build on proposal_base.content_html: the working draft when there is one, otherwise the newest saved version, which may be newer than the live one. Send proposal_base.revision back as revision and proposal_base.base_version as base_version. If the draft changed, or a version was saved or retranslated, since you read it, the request is refused with 409 and nothing is written; read it again and rebuild the change. The body replaces the whole working draft in that language: content left out of diff_html is removed from the draft. Nothing is saved as a version or published. A version can’t be saved, and the article can’t be published, until every suggestion is accepted or rejected. A body with no suggestion in it is refused with 400. To propose a translation the article doesn’t have yet, pass that language_code and a title for it.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

helpCenterId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
entityId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
diff_html
string
required
Minimum string length: 1
revision
integer
required
Required range: 0 <= x <= 9007199254740991
base_version
string
required

proposal_base.base_version from the read the proposal was built on. If the draft or a saved version changed since, the proposal is refused with 409.

language_code
string
Minimum string length: 2
title
string
Minimum string length: 1

Response

Default Response

artifact_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
article_entity_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
language_code
string
required
title
string
required
change_count
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
revision
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991