Update Category Order
- REST Method: PUT
- URL: https://docsapi.helpscout.net/v1/collections/{id}/categories
- Content-Type:
application/json
Use this endpoint to update the order of multiple categories in a collection with one API call. Only the specified categories will be updated.
Request
Name |
Type |
Required |
Default |
Options |
Notes |
categories |
Array |
Y |
|
|
The body of the request (see example below). |
{
"categories": [
{
"id": "522f91631ef00a6bca026c9f",
"order": 1
},
{
"id": "522f998e1ef00a6bca026ca2",
"order": 2
},
{
"id": "522f91311ef00a6bca026c9e",
"order": 3
}
]
}
Accepted Fields
Name |
Type |
Required |
Default |
Notes |
id |
String |
Y |
|
The category id |
order |
Int |
Y |
|
The order of the category |
Response
Response |
Name |
Type |
Notes |
Header |
Status |
Integer |
200 |
Status: 200 OK