Skip to main content
PUT
/
api
/
organisations
Update the organisation
curl --request PUT \
  --url https://api.example.com/api/organisations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "displayName": "<string>",
  "preferences": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "onboarded": true,
  "themeLogo": "<string>",
  "themePrimaryColor": "<string>",
  "preferences": {
    "emailSignupDomains": "<string>",
    "themePrimaryColor": "<string>",
    "themeLogo": "<string>"
  },
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "license": "<string>",
  "licenseData": {
    "environmentState": "initial",
    "organisationStatus": "active",
    "kind": "online",
    "createdAt": "<string>",
    "expiresAt": "<string>",
    "environmentLimits": {
      "users": 123,
      "projects": 123,
      "documents": 123,
      "deployments": 123,
      "enableDeploymentsWorkflows": true,
      "enableSSO": true,
      "enableAuditLogs": true,
      "enableBranding": true,
      "evaluateByRelease": true,
      "diffModel": true,
      "diffRelease": true,
      "activeSimulation": true,
      "testEventsShared": true,
      "enableLLM": true,
      "enableRoles": true
    }
  },
  "url": "<string>",
  "deletedAt": "<string>"
}

Body

application/json
name
string

URL-safe name of the organisation

displayName
string

Display name of the organisation

preferences
object

Organisation preferences to update

Response

200 - application/json

The updated organisation

The updated organisation

id
string
required

Unique identifier of the organisation

name
string
required

URL-safe name of the organisation

displayName
string
required

Display name of the organisation

onboarded
boolean
required

Whether the organisation has completed onboarding

Theme logo URL

themePrimaryColor
string
required

Theme primary color

preferences
object
required

Organisation preferences

createdAt
string
required

Creation timestamp

updatedAt
string
required

Last update timestamp

license
string

License key

licenseData
object

Decoded license data

url
string

URL of the organisation

deletedAt
string

Deletion timestamp if soft-deleted