Edit a news article

This method will allow you to edit a news article.

URL

/api/v2/support_centres/edit_news_article

Access

This method can be accessed by account tokens and user tokens where the associated user has access to manage the support centre content.

Supported Parameters

  • support_centre - ID or permalink of a support centre. (required)
  • news_article - ID or permalink of a news article. (required)
  • title - the title for the article. (optional)
  • content - the content of the article. (optional)
  • permalink - the permalink for the article, leave blank to keep the original permalink. (optional)
  • user - the username, email address or ID of a user. (optional)
  • published - whether the article should be displayed in the support centre. (optional)

Example JSON

A successful article

{
    "id": 4,
    "title": "Testing",
    "permalink": "test",
    "author": {
        "id": 2,
        "username": "danq",
        "first_name": "Dan",
        "last_name": "Quinney",
        "job_title": null,
        "avatar_url": "https://secure.gravatar.com/avatar/144bf62bac97854d81eb4e1eb02e748d?rating=PG&size={{size}}&d=mm"
    },
    "content": "Updated content",
    "published": false
}

A failed article

{
    "errors": {
        "permalink": [
            "has already been taken"
        ]
    }
}

Proudly powered by Katapult. Running on 100% renewable energy.