Social API reference

Social API · Muted-Terms

post/v1/communities/{community_id}/actors/{actor_id}/muted-termsAuth

Add (or refresh) a muted term for the actor. Re-posting the same `term` updates the scope + expires_at.

Path parameters

community_id*string

Social community UUID.

actor_id*string

Social actor 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

term*string

Term to mute. 1..200 chars after trim.

Example: "spoiler"

scopeenum (4)

Default `all`.

actionenum (2)

What matching does. `mute` (default) or `pending_approval` (task 015).

expires_atstring · date-time

Optional expiry (ISO timestamp in the future).

Response · 201 Muted term applied.

actor_id*string · uuid

Owning actor UUID.

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

community_id*string · uuid

Owning community UUID.

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

term*string

Case-insensitive substring.

Example: "spoiler"

scope*object

Where the mute applies.

Example: "all"

action*object

What matching does (task 015). `mute` = feed-filter only; `pending_approval` = hold a stranger's comment on your post for review.

Example: "mute"

expires_at*string · date-time

ISO timestamp; null = never expires.

Example: null

created_at*string · date-time

ISO timestamp.

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

Example

Request

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

{
  "term": "spoiler",
  "scope": "feed",
  "action": "mute",
  "expires_at": "2026-01-01T00:00:00.000Z"
}

Response

{
  "actor_id": "aaaaaaaa-0000-0000-0000-000000000001",
  "community_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
  "term": "spoiler",
  "scope": "all",
  "action": "mute",
  "expires_at": null,
  "created_at": "2026-05-01T12:00:00.000Z"
}