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>"
}Updates the organisation name, display name, and preferences.
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>"
}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.
The updated organisation
The updated organisation
Unique identifier of the organisation
URL-safe name of the organisation
Display name of the organisation
Whether the organisation has completed onboarding
Theme logo URL
Theme primary color
Organisation preferences
Show child attributes
Creation timestamp
Last update timestamp
License key
Decoded license data
Show child attributes
URL of the organisation
Deletion timestamp if soft-deleted
Was this page helpful?