Show Developer Menu

POST /topics/{slug}/articles

Issuing a POST call to articles will allow you to create a new Help Article

Example Request
curl 'https://{brand}{slug}/articles' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json' \
  -H 'Content-type: application/json' \
  -X POST -d '{"article": {"title": "foo", "body": "support", "status": 1, "topic_id": "topic-slug-url-fragment"}}'

A successful request will return the JSON for the newly created article.

A failed request will return an HTTP 422 Unprocessable Entity with the JSON body explaining the error.

  • The status value denotes the visibility of the article: 0 (Published), 1 (Draft), 4 (Internal)
  • You can post directly to /api/v1/articles if you wish to create an article without a topic.