/api/collections

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

distributedId*string

Match^[0-9a-f]{32}$

name*string

Length1 <= length

description?string

mediaType?string

sortBy?string

sortOrder?string

Response Body

`application/json`

curl -X POST "https://example.com/api/collections" \  -H "Content-Type: application/json" \  -d '{    "distributedId": "string",    "name": "string"  }'

{
  "collection": {
    "id": "string",
    "userId": "string",
    "profileId": "string",
    "distributedId": "string",
    "name": "string",
    "description": "string",
    "mediaType": "string",
    "sortBy": "string",
    "sortOrder": "string",
    "hidden": true,
    "itemCount": 0,
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "error": "string"
}

{
  "error": "string"
}

/api/collections

Request Body

Response Body

201application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`