Collection Update

PATCH/collections/{collection_mark}

Update a collection owned by the authenticated account.

Path Parameters

collection_mark*string

Either:

The unique collection ID.
A string of the form -

Formatxid-prefixed-kebab-case-string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?CollectionName

slug?CollectionSlug

A polymorphic identifier which is either a raw ID, a slug or both values combined and separated by a hyphen. This allows endpoints to respond to varying forms of a resource's ID which may be present in different app contexts. For example, a slug may be used in a URL but raw IDs are often exposed as part of API responses or in certain endpoint parameters. This type allows flexibility in user experience as well as the API surface while ensuring performance during database queries and other operations.

For example, given a thread with the ID cc5lnd2s1s4652adtu50 and the slug top-10-movies-thread, Storyden will understand both the forms: cc5lnd2s1s4652adtu50-top-10-movies-thread or cc5lnd2s1s4652adtu50 or top-10-movies-thread as the identifier for that thread.

Marks are only ever used on the read path as they are a derivative data type and are not stored in the database as-is, while IDs and slugs are. The write path typically exposes slugs as writable and IDs as immutable.

Formatxid-prefixed-kebab-case-string

description?CollectionDescription

Response Body

`application/json`

curl -X PATCH "https://example.com/collections/cc5lnd2s1s4652adtu50-top-10-movies-thread" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "cc5lnd2s1s4652adtu50",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "misc": {},
  "name": "string",
  "slug": "cc5lnd2s1s4652adtu50-top-10-movies-thread",
  "description": "string",
  "owner": {
    "id": "cc5lnd2s1s4652adtu50",
    "joined": "2019-08-24T14:15:22Z",
    "suspended": "2019-08-24T14:15:22Z",
    "handle": "Southclaws",
    "name": "Barnaby Keene",
    "signature": "<body><p>Sent with love from London!</p></body>",
    "roles": [
      {
        "badge": true,
        "default": true,
        "id": "cc5lnd2s1s4652adtu50",
        "name": "string",
        "colour": "string",
        "meta": {}
      }
    ]
  },
  "item_count": 0,
  "has_queried_item": true
}

Empty

{
  "error": "string",
  "message": "string",
  "suggested": "string",
  "metadata": {}
}

Collection Update

Authorization

Path Parameters

Request Body

Response Body

200application/json

401

404

defaultapplication/json

`application/json`

`application/json`