Sirportly

Toggle Menu

Add a support centre topic

This method allows you to create a support centre topic.

URL

/api/v2/support_centres/add_topic

Access

This method can be accessed by account tokens.

Supported Parameters

  • support_centre - ID or local domain of a support centre. (required)
  • title - the title of the topic (required)
  • permalink - the permalink of the topic
  • description - the description of the topic
  • position - the position of the topic

Returned Data

If the topic is created successfully, you will receive a 201 Created status and information about the topic will be provided. If a validation error occurs, you will receive a 422 Unprocessable Entity status along with an array of errors (see below)

Example JSON

A successful topic

{
    "id": 16681,
    "name": "Testing",
    "permalink": "testing",
    "position": 11
}

A failed topic

{
    "errors": {
        "title": [
            "can't be blank"
        ]
    }
}