Social API reference

Social API · Collections

patch/v1/communities/{community_id}/collections/{collection_id}Auth

Update a collection (owner only) — rename, cover, visibility, reorder position.

Path parameters

community_id*string

Social community UUID.

collection_id*string · uuid

Id of the collection.

Request body

actor_idstring · uuid

The acting actor; must be the collection owner. Send it, or the deprecated `caller_actor_id`; one of the two is required.

Example: "aaaaaaaa-0000-0000-0000-000000000001"

caller_actor_idstring · uuid

Deprecated alias of `actor_id`; send `actor_id`.

Example: "aaaaaaaa-0000-0000-0000-000000000001"

namestring

New name (1-200 chars).

cover_asset_idstring · uuid

Asset to use as the cover image; null clears it.

cover_urlstring

Cover image URL (alternative to cover_asset_id); null clears it.

visibilityenum (2)

`public` or `private`.

positionnumber

New ordering position among the owner's collections.

Response · 200 Updated.

id*string · uuid

Id of the collection.

Example: "99999999-0000-0000-0000-000000000001"

community_id*string · uuid

Id of the community the collection belongs to.

Example: "cccccccc-cccc-cccc-cccc-cccccccccccc"

owner_actor_id*string · uuid

The actor that owns the collection.

Example: "aaaaaaaa-0000-0000-0000-000000000001"

name*string

Display name.

Example: "Travel"

kind*object

`bookmark` (a private folder of saved posts) or `highlight` (shown on the owner's profile; its stories never expire).

Example: "bookmark"

cover_asset_id*string · uuid

Asset used as the cover image, if any.

Example: null

cover_url*string

Cover image URL, if set instead of an asset.

Example: null

visibility*object

`public` or `private` (owner only).

Example: "private"

position*number

Owner-defined ordering position.

Example: 0

item_count*number

Number of posts in the collection.

Example: 12

created_at*string · date-time

When the collection was created.

Example: "2026-05-01T12:00:00.000Z"

updated_at*string · date-time

When the collection last changed.

Example: "2026-05-01T12:00:00.000Z"

Example

Request

PATCH https://social.productcraft.co/v1/communities/{community_id}/collections/{collection_id}
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "actor_id": "aaaaaaaa-0000-0000-0000-000000000001",
  "caller_actor_id": "aaaaaaaa-0000-0000-0000-000000000001",
  "name": "string",
  "cover_asset_id": "00000000-0000-0000-0000-000000000000",
  "cover_url": "string",
  "visibility": "public",
  "position": 0
}

Response

{
  "id": "99999999-0000-0000-0000-000000000001",
  "community_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
  "owner_actor_id": "aaaaaaaa-0000-0000-0000-000000000001",
  "name": "Travel",
  "kind": "bookmark",
  "cover_asset_id": null,
  "cover_url": null,
  "visibility": "private",
  "position": 0,
  "item_count": 12,
  "created_at": "2026-05-01T12:00:00.000Z",
  "updated_at": "2026-05-01T12:00:00.000Z"
}