Update Category

  • REST Method: PUT
  • URL: https://docsapi.helpscout.net/v1/categories/{id}
  • Content-Type: application/json

Request

Name Type Required Default Options Notes
category Category Y     The body of the request (see example below).
reload Boolean N false   Set this request parameter to true to return the updated category in the response. 
{
    "name": "My Category",
    "slug": "my-category",
    "visibility": "public",
    "order": 1,
    "defaultSort": "name"
}

Accepted Fields

Name Type Required Default Notes
name String Y   Name must be unique for the Collection this category is associated with.
slug String N   SEO-friendly identifier for the article that can be used in a URL.
visibility String N public Options:
  • public - viewable by the public
  • private - viewable only in admin
order Int N 1 Use this attribute to specify the order of a category when displayed in a list.
defaultSort String N popularity

Use this attribute to set the default sort when getting a list of articles in a category.

Options:
  • popularity
  • name

Response

Response Name Type Notes
Header Status Integer 200 
Status: 200 OK
↑Back to top