SYsymbol
capsule

Preview what archiving capsules would pause (links, public pages, skills, embeds, and access for the people they are shared with) and, per capsule, whether you could archive it

Changed on
post/api/preview/capsules/batch/archive-impact

Request

  • Base URL
    https://symbol.chat (the document declares no server; this is the origin it was published from)
  • URL
    https://symbol.chat/api/preview/capsules/batch/archive-impact
  • Auth
    • HTTP bearer
    • or API key in cookie __Secure-next-auth.session-token
    • or OAuth 2
      Authorization code: https://mcp.symbol.chat/authorize
      Token URL: https://mcp.symbol.chat/token

Request body

capsuleIdsstring[] required

Capsule ids to preview archiving

Response

Successful response

canResumeboolean required
embedCountinteger required
linkCountinteger required
peopleCountinteger required

Distinct people the capsules you would archive, and may manage people on, are shared with. They lose access while the capsules are archived. A team capsule its whole organization reads (org_view, org_edit) is left out: the people it is shared with are members and keep reading it.

peopleHiddenCountinteger required

How many capsules you would archive without being allowed to see who they are shared with. Anyone they are shared with loses access too. Team capsules its whole organization reads are left out.

publicCountinteger required
publishedSkillCountinteger required
totalinteger required

Requested capsules the caller can read.

withActiveSharesinteger required
withPeopleSharesinteger required

Of the capsules you would archive and may manage people on, how many are shared with at least one person who loses access (team capsules its whole organization reads are left out).

Changes