Social API reference

Social API · Conversations

patch/v1/communities/{community_id}/conversations/{conversation_id}/members/{member_actor_id}Auth

Update a participant (task 025). Field-level authz: `role` is admin-only; `muted` / `muted_until` / `pinned` are self-only (the caller must be the path actor). The canonical home for participant state.

Path parameters

community_id*string

Social community UUID. Must belong to the PAK's workspace.

conversation_id*string

Conversation UUID.

member_actor_id*string

Target participant — social actor UUID.

Request body

actor_idstring · uuid

The acting actor making the change. 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"

roleenum (2)

Target role (admin-only). Omit to leave unchanged.

Example: "admin"

mutedboolean

Mute the thread indefinitely (self-only — caller must be the path actor). Task 024/025.

Example: true

muted_untilstring

Timed mute until this ISO timestamp (self-only). Pass null to clear.

Example: "2026-05-02T12:00:00Z"

pinnedboolean

Pin / unpin the thread in the caller's inbox (self-only).

Example: true

Response · 200 Participant updated.

id*string · uuid

Conversation UUID.

Example: "11111111-2222-3333-4444-555555555555"

community_id*string · uuid

Owning community UUID.

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

kind*object

Conversation shape — 1-on-1 (`direct`) or multi-participant (`group`).

Example: "direct"

name*string

Group display name; null for 1-on-1.

Example: null

created_by*string

Social actor UUID of the group founder; null for legacy / 1-on-1.

Example: null

participants*array

Participants, joined-at ascending.

unread_count*number

Unread messages for the requesting actor (task 024) — messages from others created after the requester's last_read_at. Embedded on list + single GET for inbox badges.

Example: 0

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"

last_message_at*string · date-time

ISO timestamp of the most recent message (or conversation create when no messages yet).

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

Example

Request

PATCH https://social.productcraft.co/v1/communities/{community_id}/conversations/{conversation_id}/members/{member_actor_id}
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "actor_id": "aaaaaaaa-0000-0000-0000-000000000001",
  "caller_actor_id": "aaaaaaaa-0000-0000-0000-000000000001",
  "role": "admin",
  "muted": true,
  "muted_until": "2026-05-02T12:00:00Z",
  "pinned": true
}

Response

{
  "id": "11111111-2222-3333-4444-555555555555",
  "community_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
  "kind": "direct",
  "name": null,
  "created_by": null,
  "participants": [
    {
      "actor_id": "aaaaaaaa-0000-0000-0000-000000000001",
      "joined_at": "2026-05-01T12:00:00.000Z",
      "last_read_at": null,
      "muted": false,
      "muted_until": null,
      "pinned": false,
      "role": "member"
    }
  ],
  "unread_count": 0,
  "created_at": "2026-05-01T12:00:00.000Z",
  "updated_at": "2026-05-01T12:00:00.000Z",
  "last_message_at": "2026-05-01T12:00:00.000Z"
}