Create Article

  • REST Method: POST
  • URL: https://docsapi.helpscout.net/v1/articles
  • Content-Type: application/json

Request

Name Type Required Default Notes
article Article Y   The body of the request (see example below).
reload boolean N false Set this request parameter to true to return the created article in the response. 
{
    "collectionId": "5214c77c45667acd25394b51",
    "status": "published",
    "slug": "my-article",
    "name": "My Article",
    "text": "Text of the article goes here.",
    "categories": [
        "5214c83d45667acd25394b54"
    ],
    "related": [
        "521509f145667acd25394b5b",
        "521509f145667acd25394b5d"
    ],
    "keywords": [
      "return",
      "billing"
    ]
}

Accepted Fields

Name Type Required Default Notes
collectionId String Y    
status String N unpublished Sets the status of the article to either 'published' or 'notpublished'. If the article should not be viewable by the public, set the status to 'notpublished'.
slug String N   SEO-friendly identifier for the article that can be used in a URL. If this is not specified, one will be auto-generated from the name of the article. Note that a slug cannot be used to GET an article.
name String Y   Name must be unique for the Collection this Article is associated with.
text String Y   Article copy can be uploaded as either plain text or in HTML format
categories Array N   An array of Category ids that this Article should be associated with.
  • If no categories are specified, the Article will be associated with the 'Uncategorized' Category.
  • An Article cannot be manually associated with the 'Uncategorized' category. Either do not pass this attribute in the request, or set it to null if the article should be uncategorized.
related Array N   An array of Article ids that are related to this Article.
keywords Array N   An array of Strings that list all associated keywords for the Article.

Response

Response Name Type Notes
Header Status Integer 201
Header Location String https://docsapi.helpscout.net/v1/articles/{id} 
Status: 201 Created
Location: https://docsapi.helpscout.net/v1/articles/{id}
↑Back to top
© Help Scout 2024