Update Collection
- REST Method: PUT
- URL: https://docsapi.helpscout.net/v1/collections/{id}
- Content-Type:
application/json
Request
| Name |
Type |
Required |
Default |
Options |
Notes |
| collection |
Collection |
Y |
|
|
The body of the request (see example below). |
| reload |
boolean |
N |
false |
|
Set this request parameter to true to return the updated collection in the response. |
{
"name": "My Collection",
"visibility": "public",
"order": 1
}
Accepted Fields
| Name |
Type |
Required |
Default |
Notes |
| name |
String |
Y |
|
Name must be unique for the Help Scout account associated with the API key used to make this request. |
| visibility |
String |
N |
public |
Options:
|
| order |
Int |
N |
1 |
|
| description |
String |
N |
"A collection of my Docs." |
Optional description of the collection, up to 45 characters. |
| siteId |
Int |
N |
|
The site to which you wish to move the collection. |
Response
| Response |
Name |
Type |
Notes |
| Header |
Status |
Integer |
200 |
Status: 200 OK