Social API reference

Social API · Actors

patch/v1/communities/{community_id}/actors/{actor_id}Auth

Update actor profile fields. Pass only the fields you want to change.

Path parameters

community_id*string

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

actor_id*string

Social actor UUID.

Request body

display_namestring

New display name; null clears it.

avatar_urlstring

New avatar URL; null clears it.

metadataobject

Your own key/value data for the actor. Replaces the stored object; keys are kept exactly as sent.

statusenum (3)

New status.

is_privateboolean

Make the actor private (task 014). Caps effective post visibility at `followers`; following requires an approved request. Flipping back to public auto-approves pending requests.

Response · 200 Actor updated.

id*string · uuid

Social actor UUID.

Example: "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"

community_id*string · uuid

Owning community UUID.

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

external_id*string

Customer-supplied stable identifier (your user id).

Example: "user_abc123"

display_name*string

Display name.

Example: "Ada Lovelace"

avatar_url*string

Avatar URL.

Example: "https://cdn.example.com/avatars/ada.png"

metadata*object

Free-form metadata blob.

Example: {"tier":"pro"}

status*object

Lifecycle status. `suspended` is moderator-applied via PATCH `status=suspended`; `deleted` is soft-deletion. Shadow-banning is a separate moderation mechanism that does not change `status`.

Example: "active"

is_private*boolean

When true, the actor is private (task 014): effective post visibility is capped at `followers` and following requires an approved follow request.

Example: false

created_at*string · date-time

ISO timestamp the row was inserted.

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

updated_at*string · date-time

ISO timestamp of the last update.

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

Example

Request

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

{
  "display_name": "string",
  "avatar_url": "string",
  "metadata": {},
  "status": "active",
  "is_private": false
}

Response

{
  "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "community_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
  "external_id": "user_abc123",
  "display_name": "Ada Lovelace",
  "avatar_url": "https://cdn.example.com/avatars/ada.png",
  "metadata": {
    "tier": "pro"
  },
  "status": "active",
  "is_private": false,
  "created_at": "2026-05-01T12:00:00.000Z",
  "updated_at": "2026-05-01T12:00:00.000Z"
}