Organization Settings

Update Org Settings

Rename the organisation, or set its auto-join email domain.

SETTING email_domain WIDENS WHO CAN JOIN. Anyone who signs up with an address at that domain becomes a member without an invite. Admin-gated, and the handler re-checks the caller's org role on top.

The rename happens FIRST and against PropelAuth, so a rejected name aborts the whole update rather than half-applying it.

put/org/settings

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/org/settings
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

org_namestring nullable

Organization display name. PropelAuth owns it; a rejected rename aborts the whole update.

email_domainstring nullable

Email domain for auto-join signup (e.g. graph8.com). Anyone who signs up with an address at this domain joins this organization with no invite. Normalised: scheme, www. and trailing slash are stripped and the value is lowercased.

Response

Successful Response

dataStudioPayload required

An open envelope for one settings block, document or brand artefact.

OPEN on purpose. These surfaces are configuration and generated content, and both grow: a new toggle on a settings block or a new field on a generated document must reach a caller on the day it ships, not on the day somebody remembers to widen a mirror. A closed response model here would silently DROP the new key, which reads to the caller as "the product does not have that setting".

The request side is the opposite and is mirrored exactly - see the module docstring for why the asymmetry is deliberate.

Changes

No recorded changes to this operation across all 2 revisions of this API.