Skip to content

Create collection

POST
/api/collections

Create a collection. Admin role is required.

Authorizations

bearerAuth

Bearer token using a JWT

Type
HTTP (Bearer)

Request Body

application/json
JSON
{
  
"name": "string",
  
"isActor": true,
  
"isTop": true,
  
"sortIndex": 0
}

Responses

Created collection.

application/json
JSON
{
  
"id": 2,
  
"name": "Collection name",
  
"isActor": false,
  
"isTop": false,
  
"sortIndex": 12,
  
"createdAt": "2020-01-29T18:10:16.630Z",
  
"updatedAt": "2020-01-30T22:42:14.789Z"
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI