postCollections
Creates a new collection
Requires authentication as user
postCollections
Request
post /Collections
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
IsLocked | query | Whether or not to lock the new collection. |
||
Name | query | The name of the new collection. |
||
ParentId | query | Optional - create the collection within a specific folder |
||
Ids | query | Item Ids to add to the collection |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | CollectionCreationResult | Operation successful. Returning a CollectionCreationResult object. |
|
400 | Bad Request. Server cannot process request. |
||
401 | Unauthorized. Client needs to authenticate. |
||
403 | Forbidden. No permission for the reqested operation. |
||
404 | Resource not found or unavailable. |
||
500 | Server error. |
Definitions
CollectionCreationResult
Name | Type | Notes |
---|---|---|
Id | string | |
Name | string |