Social API reference

Social API · Conversations

post/v1/communities/{community_id}/conversations/{conversation_id}/membersAuth

Add a member to a group conversation. Admin-only. Refuses if the new member has a block with any existing participant.

Path parameters

community_id*string

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

conversation_id*string

Conversation UUID.

Headers

Idempotency-Keystring

Opaque client-generated string (1-256 chars, `[A-Za-z0-9._:-]`) that makes a retry safe: within 24 h a repeat with the same key and body returns the original response with `Idempotent-Replay: true` instead of running again. Same key with a different body is `409 IDEMPOTENCY_KEY_REUSE`.

Request body

actor_id*string · uuid

The acting actor (a group admin). In the deprecated shape that sends `caller_actor_id`, this is the actor being added.

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

member_actor_idstring · uuid

The actor being added. Required unless you send the deprecated `caller_actor_id` shape.

Example: "aaaaaaaa-0000-0000-0000-000000000002"

caller_actor_idstring · uuid

Deprecated: the caller in the old shape (`caller_actor_id` + `actor_id` as the member). Send `actor_id` + `member_actor_id`.

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

roleenum (2)

Default `member`.

Example: "member"

Response · 201 Member added.

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

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

{
  "actor_id": "aaaaaaaa-0000-0000-0000-000000000001",
  "member_actor_id": "aaaaaaaa-0000-0000-0000-000000000002",
  "caller_actor_id": "aaaaaaaa-0000-0000-0000-000000000001",
  "role": "member"
}

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"
}