---
title: "Update Org Settings"
method: PUT
path: "/org/settings"
tags: ["Organization Settings"]
---

# Update Org Settings

`PUT /org/settings`

## Request

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

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.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- OrgSettingsUpdateRequest: Mirrors `campaign_builder.routers.org_settings.UpdateOrgSettingsRequest`. `email_domain` is the auto-join domain: anyone signing up with an address at that domain joins THIS organisation without an invite. It is the widest blast radius on this surface, which is why the route is admin-gated and the handler re-checks the caller's org role on top.
  - `org_name` string, nullable: Organization display name. PropelAuth owns it; a rejected rename aborts the whole update.
  - `email_domain` string, 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 `200`

Successful Response

- ApiResponseStudioPayload
  - `data` StudioPayload, 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.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)