Sign in

v1

latestOpenAPI 3.1.02026-07-261344388.3 KB
Organisation

Update the organisation

Updates the organisation name, display name, and preferences.

put/api/organisations

Request body

namestring

URL-safe name of the organisation

displayNamestring

Display name of the organisation

Example request

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

Response

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