Client spaces

Rename a space, archive/unarchive it, or gate the whole space.

Renames change the display name only; the slug is a forever addressing contract and never changes. Only the fields present in the body are touched; on the two gate fields null means remove the gate.

patch/spaces/{idOrSlug}

Request

  • Base URL: https://api.stacktr.ee
  • URL: https://api.stacktr.ee/spaces/{idOrSlug}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.stacktr.ee/oauth/authorize, token URL https://api.stacktr.ee/oauth/token, scopes: sites:write, sites:read)

Request body

namestring

New display name.

archivedboolean

true to archive (the plan slot is freed; the portal and the address close to readers, each page keeps its own link), false to unarchive.

passwordstring nullable

Passcode covering every page in the space, inherited by pages already filed under it and by ones published later. null clears it.

allowed_email_domainstring nullable

Email gate covering every page in the space: domains and/or single addresses separated by commas ("acme.com, jane@globex.com"; strict-equal, no subdomains), up to 20. null clears it.

Response

Updated.

okboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.