API Reference
  1. Trustmarkt API
  2. Articles

Update Article

put
https://api.trustmarkt.de/v1/articles/

Update the specified article. The article must belong to the authenticated user's company, otherwise a 404 error will be returned.
Only articles in draft or rejected status can be updated. If the article is in review or published status, a 422 error will be returned.

The content of the article should be provided as Markdown in the content field. HTML-Tags will be stripped from the content for security reasons.
Supported Markdown features include:

  • Headers (H2, H3, H4)
  • Bold and italic text
  • Links
  • Lists
  • Dividers

Images can not be included within the article content via the API. If you want to include images in your article, please use the Trustmarkt Web App to upload images directly in the article editor.

Path Params
string
required

The article to update.

Body Params
string
length between 10 and 90

The title of the article.

string
length between 0 and 50000

The Markdown-Content of the article. Supports headings (H2–H4), bold, italic, links, lists,
dividers and GFM tables, plus the custom SEO directives :::faq and :::callout
(see App\Helper\Article\MarkdownDirectiveParser). All raw HTML tags are stripped
from the content for security reasons.

string | null

The alt-text for the article thumbnail.

string | null

The author of the article. Will be set to the currently authenticated user if not provided.

string | null

The category of the article.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?