Organisation

Update the organisation

Updates the organisation name, display name, and preferences.

put/api/organisations

Request

The document declares no server URL.
Auth
HTTP internal
TypeScript
https://skmtc.dev/gorules/apis/gorules-agent-api/docs/api/organisations/put.ts
A function with typed inputs. Its response is checked against the schema.

namestring

URL-safe name of the organisation

displayNamestring

Display name of the organisation

{
  "preferences": {
    "emailSignupDomains": "@gorules.io, @gorules.dev"
  }
}

The updated organisation

idstring required

Unique identifier of the organisation

namestring required

URL-safe name of the organisation

displayNamestring required

Display name of the organisation

onboardedboolean required

Whether the organisation has completed onboarding

licensestring

License key

urlstring

URL of the organisation

themeLogostring required

Theme logo URL

themePrimaryColorstring required

Theme primary color

createdAtstring required

Creation timestamp

updatedAtstring required

Last update timestamp

deletedAtstring

Deletion timestamp if soft-deleted

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