> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gorules.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update the organisation

> Updates the organisation name, display name, and preferences.



## OpenAPI

````yaml /openapi/brms.json put /api/organisations
openapi: 3.0.3
info:
  title: GoRules BRMS
  version: local
servers: []
security: []
tags:
  - name: AI
    description: >-
      AI-powered assistant for interactive conversations and decision logic
      generation
  - name: Audit log
    description: Track and export organisation activity logs for compliance and monitoring
  - name: Branches
    description: >-
      Manage feature branches for collaborative decision development with
      commits and merging
  - name: Change requests
    description: Review and approve changes before merging or deploying to environments
  - name: Cloud
    description: Cloud-specific endpoints for organisation and client management
  - name: Decision
    description: Evaluate and simulate decision graphs with trace and performance data
  - name: Deployment workflows
    description: Manage deployment workflow runs and job approvals
  - name: Deployments
    description: Configure cloud storage providers for release deployments
  - name: Document
    description: Manage decision documents, versions, and file operations within projects
  - name: Environment
    description: >-
      Configure deployment environments with approval workflows and access
      tokens
  - name: Group
    description: Manage permission groups for project-level access control
  - name: Infrastructure
    description: Health check and infrastructure status endpoints
  - name: Integration
    description: Configure external integrations for HTTP requests and data sources
  - name: Invitation
    description: Manage organisation invitations for new members
  - name: Member
    description: Manage project membership and group assignments
  - name: Organisation
    description: Manage organisation settings, preferences, and licensing
  - name: Personal access token
    description: Create and manage personal access tokens for API authentication
  - name: Profile
    description: Manage current user profile settings
  - name: Project
    description: Create and manage projects with approval workflows
  - name: Release
    description: >-
      Package, version, and deploy decision documents. Learn more about
      [Releases](https://gorules.io/developers/brms/multi-environment)
  - name: Roles
    description: Define custom roles with permissions for organisation-wide access control
  - name: Security
    description: Manage project access tokens for API authentication
  - name: Templates
    description: Browse and apply project templates for quick onboarding
  - name: Test events
    description: Manage test events for decision evaluation and testing
  - name: User
    description: Manage organisation users, invitations, and service accounts
paths:
  /api/organisations:
    put:
      tags:
        - Organisation
      summary: Update the organisation
      description: Updates the organisation name, display name, and preferences.
      operationId: updateOrganisation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: URL-safe name of the organisation
                displayName:
                  type: string
                  description: Display name of the organisation
                preferences:
                  type: object
                  properties:
                    themeLogo:
                      type: string
                      description: URL or path to the organisation logo
                    themePrimaryColor:
                      type: string
                      description: Primary theme color for the organisation
                    emailSignupDomains:
                      type: string
                      description: Comma separated list
                      example: '@gorules.io, @gorules.dev'
                  default: {}
                  description: Organisation preferences to update
      responses:
        '200':
          description: The updated organisation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Unique identifier of the organisation
                  name:
                    type: string
                    description: URL-safe name of the organisation
                  displayName:
                    type: string
                    description: Display name of the organisation
                  onboarded:
                    type: boolean
                    description: Whether the organisation has completed onboarding
                  license:
                    type: string
                    description: License key
                  licenseData:
                    type: object
                    properties:
                      kind:
                        type: string
                        nullable: true
                        enum:
                          - online
                          - offline
                          - null
                        description: License kind (online or offline)
                      createdAt:
                        type: string
                        nullable: true
                        description: Date the license was created
                      expiresAt:
                        type: string
                        nullable: true
                        description: Date the license expires
                      environmentState:
                        type: string
                        enum:
                          - initial
                          - connected
                          - disabled
                        description: Current environment state
                      organisationStatus:
                        type: string
                        enum:
                          - active
                          - disabled
                          - invalid
                          - grace
                          - expired
                        description: Current organisation license status
                      environmentLimits:
                        type: object
                        properties:
                          users:
                            type: number
                            description: Maximum number of users allowed
                          projects:
                            type: number
                            description: Maximum number of projects allowed
                          documents:
                            type: number
                            description: Maximum number of documents allowed
                          deployments:
                            type: number
                            description: Maximum number of deployments allowed
                          enableDeploymentsWorkflows:
                            type: boolean
                            description: Whether deployment workflows are enabled
                          enableSSO:
                            type: boolean
                            description: Whether SSO is enabled
                          enableAuditLogs:
                            type: boolean
                            description: Whether audit logs are enabled
                          enableBranding:
                            type: boolean
                            description: Whether custom branding is enabled
                          evaluateByRelease:
                            type: boolean
                            description: Whether evaluate by release is enabled
                          diffModel:
                            type: boolean
                            description: Whether model diffing is enabled
                          diffRelease:
                            type: boolean
                            description: Whether release diffing is enabled
                          activeSimulation:
                            type: boolean
                            description: Whether active simulation is enabled
                          testEventsShared:
                            type: boolean
                            description: Whether test events sharing is enabled
                          enableLLM:
                            type: boolean
                            description: Whether LLM features are enabled
                          enableRoles:
                            type: boolean
                            description: Whether roles are enabled
                        description: Environment feature limits and flags
                    required:
                      - environmentState
                      - organisationStatus
                    description: Decoded license data
                  url:
                    type: string
                    description: URL of the organisation
                  themeLogo:
                    type: string
                    description: Theme logo URL
                  themePrimaryColor:
                    type: string
                    description: Theme primary color
                  preferences:
                    type: object
                    properties:
                      emailSignupDomains:
                        type: string
                        description: Comma-separated list of email signup domains
                      themePrimaryColor:
                        type: string
                        description: Primary theme color for the organisation
                      themeLogo:
                        type: string
                        description: URL or path to the organisation logo
                    description: Organisation preferences
                  createdAt:
                    type: string
                    description: Creation timestamp
                  updatedAt:
                    type: string
                    description: Last update timestamp
                  deletedAt:
                    type: string
                    description: Deletion timestamp if soft-deleted
                required:
                  - id
                  - name
                  - displayName
                  - onboarded
                  - themeLogo
                  - themePrimaryColor
                  - preferences
                  - createdAt
                  - updatedAt
                description: The updated organisation
      security:
        - internalAuth: []
components:
  securitySchemes:
    internalAuth:
      type: http
      scheme: internal
      description: Cannot be used directly

````