Create Collection
- REST Method: POST
- URL: https://docsapi.helpscout.net/v1/collections
- Content-Type:
application/json
Request
| Name |
Type |
Required |
Default |
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 created collection in the response. |
{
"siteId": "52404efc4566740003092640",
"name": "My Collection",
"visibility": "public",
"order": 1
}
Accepted Fields
| Name |
Type |
Required |
Default |
Notes |
| siteId |
String |
Y |
|
The id of the Site that the Collection will be associated with. |
| 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:
- public - viewable by the public
- private - viewable only in admin
|
| order |
Int |
N |
1 |
|
| description |
String |
N |
"A collection of my Docs." |
Optional description of the collection, up to 45 characters. |
Response
| Response |
Name |
Type |
Notes |
| Header |
Status |
Integer |
201 |
| Header |
Location |
String |
https://docsapi.helpscout.net/v1/collections/{id} |
Status: 201 Created
Location: https://docsapi.helpscout.net/v1/collections/{id}