SYsymbol
share

Set a capsule, Type, Collection or project to Private (self), Anyone with link (link) or Public (public)

Changed on
put/api/preview/share/visibility

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/share/visibility
  • 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

enable_public_profileboolean

With public only: turn your public profile on in the same step when it is off. Without it, a publish while the profile is off answers 422 public_profile_required with next_step: "enable_public_profile". A username is still claimed in Settings first.

resourceIdstring required

The capsule, Type, Collection or project id.

resourceType'capsule' | 'type' | 'collection' | 'project' required

The kind of resource.

visibility'self' | 'link' | 'public' | 'private' | 'unlisted' required

self (Private): only you, and every link ends. link (Anyone with link): answers with the resource's reusable link. public (Public): listed on your profile and in Discover at its public address. The older words private and unlisted are deprecated aliases of self and link.

Response

Successful response

exposes_capsulesinteger
share_urlstring uri nullable required
vanity_urlstring uri nullable required
visibility'self' | 'link' | 'public' | 'org_view' | 'org_edit' required

Changes