Social API reference

Social API · Lists

patch/v1/communities/{community_id}/lists/{list_id}Auth

Update list name / description / visibility. Owner-only.

Path parameters

community_id*string

Social community UUID.

list_id*string

List UUID.

Request body

actor_idstring · uuid

The acting actor; must be the list 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.

descriptionstring

New description.

visibilityenum (2)

New visibility.

Response · 200 List updated.

id*string · uuid

List UUID.

Example: "11111111-0000-0000-0000-000000000001"

community_id*string · uuid

Owning community UUID.

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

owner_id*string · uuid

List owner — social actor UUID.

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

name*string

List display name.

Example: "Tech news"

description*string

Optional description.

Example: "Curated tech accounts I follow."

visibility*object

public = discoverable; private = owner-only.

Example: "public"

member_count*number

Current member count.

Example: 12

created_at*string · date-time

ISO timestamp.

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

updated_at*string · date-time

ISO timestamp.

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

Example

Request

PATCH https://social.productcraft.co/v1/communities/{community_id}/lists/{list_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",
  "description": "string",
  "visibility": "public"
}

Response

{
  "id": "11111111-0000-0000-0000-000000000001",
  "community_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
  "owner_id": "aaaaaaaa-0000-0000-0000-000000000001",
  "name": "Tech news",
  "description": "Curated tech accounts I follow.",
  "visibility": "public",
  "member_count": 12,
  "created_at": "2026-05-01T12:00:00.000Z",
  "updated_at": "2026-05-01T12:00:00.000Z"
}