Social API reference

Social API · Communities

patch/v1/workspaces/{workspace_id}/communities/{community_id}Auth

Update community display name, description, settings, or status. Status transitions are unrestricted (active ↔ suspended; archived is terminal in v1).

Path parameters

workspace_id*string

ProductCraft workspace UUID owning the community.

community_id*string

Social community UUID.

Request body

display_namestring

New display name.

descriptionstring

New description; null clears it.

settingsobject

Replaces the settings blob. Supported keys are typed on CommunitySettingsDto; unrecognized keys are stored verbatim but not consumed.

statusenum (3)

New status. `suspended` blocks writes; `archived` makes the community read-only.

Response · 200 Community updated.

id*string · uuid

Community UUID.

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

workspace_id*string · uuid

Owning workspace UUID.

Example: "11111111-1111-1111-1111-111111111111"

app_id*string · uuid

Auth app UUID this community wraps; `null` for standalone communities.

Example: "33333333-3333-3333-3333-333333333333"

slug*string

URL-friendly community slug.

Example: "my-product-community"

display_name*string

Display name.

Example: "My Product Community"

description*string

Optional human-readable description.

Example: null

settings*object

Per-community settings: every key the service reads, with its default when it was never set. Unrecognized keys you stored are returned unchanged but not consumed.

Example: {"max_comment_depth":3}

status*object

Lifecycle status.

Example: "active"

created_by*string

Account UUID of the creator.

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

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/workspaces/{workspace_id}/communities/{community_id}
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "display_name": "string",
  "description": "string",
  "settings": {},
  "status": "active"
}

Response

{
  "id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
  "workspace_id": "11111111-1111-1111-1111-111111111111",
  "app_id": "33333333-3333-3333-3333-333333333333",
  "slug": "my-product-community",
  "display_name": "My Product Community",
  "description": null,
  "settings": {
    "max_comment_depth": 3
  },
  "status": "active",
  "created_by": "aaaaaaaa-0000-0000-0000-000000000001",
  "created_at": "2026-05-01T12:00:00.000Z",
  "updated_at": "2026-05-01T12:00:00.000Z"
}