1. Org
Cognita
  • Introduction
  • Auth
    • register
      POST
    • login
      POST
    • callback
      GET
    • profile
      GET
    • verify email
      POST
    • refresh
      POST
    • logout
      POST
    • forgot password
      POST
    • reset password
      POST
    • request reset password
      POST
    • update-profile
      PATCH
  • Meetings
    • Transcripts
      • Retrieve transcripts for a meeting
    • upload init
    • Get meeting details
  • Transcription
    • live
    • Get Transcript segments
    • Create translation for transcript
  • Organization
    • Billing
      • Get Billing Details
      • Update Plan
    • Org
      • Create Organization
        POST
      • Get Organization
        GET
      • Get Organizations
        GET
      • update organization
        PUT
      • update settings
        PATCH
      • Delete Organization
        DELETE
      • get organization settings
        GET
      • Suspend
        POST
      • Resume
        POST
    • Retention
      • Set Retention Policy
      • Get Retention Policy
      • Update Retention Policy
    • Domains
      • Allowed Domains
      • Allowed Domains
      • Domain verfying
  • Workspaces
    • Org
      • Get Organization Workspaces
    • Workspace
      • Create Workspace
      • Get Workspace
      • Update Workspace
      • Delete Workspace
    • Users
      • Get Workspace Members
      • Delete Member from Workspace
    • Meetings
      • Start a meeting in workspace
  • configurations
    • feature-flags
    • configs
    • tenant-defaults
  • Schemas
    • Organization
      • OrganizationSettings
      • FeatureFlags
      • RetentionPolicy
      • Organization
      • CreateOrgRequestBody
    • Billing & Subscriptions
      • BillingAccount
      • SubscriptionEntitlements
      • SubscriptionPlan
      • Subscription
      • PaymentMethod
      • Invoice
      • UsageRecords
      • Bill
    • Roles & permissions
      • Permissions
    • Workspace
      • Workspaces
    • Meeting & Recordings
      • Meetings
    • Trascriptions & Summaries
    • Integrations
    • Notifications & Audit logs
    • AI Services
    • Localization
    • Auth & Users
      • user
      • AccessToken
    • ErrorResponse
    • SuccessResponse
    • DeviceInfo
    • Session
  1. Org

update settings

Developing
Develop Env
http://localhost:3000/api
Develop Env
http://localhost:3000/api
PATCH
http://localhost:3000/api
/orgs/{orgId}/settings
organization
Maintainer:Abdelrhman Moataz

Purpose#

Update a subset of org settings safely from admin UI.
##Auth / Scope
org:write (org admin)

Headers#

Authorization, Content-Type, X-Request-ID

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🟠404Not Found
🟠403Forbidden
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'http://localhost:3000/api/orgs//settings' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "timezone": "2019-08-24T14:15:22.123Z",
    "defaultLanguage": "string",
    "complianceMode": "string",
    "recordingConsent": "string",
    "aiSummaries": "string",
    "educationMode": true,
    "dlpEnabled": true,
    "translationEnabled": true,
    "realTimeSummaries": true,
    "lmsIntegration": "string",
    "retentionAlerts": true
}'
Response Response Example
200 - Example 1
{
    "status": "ok",
    "message": "Organization settings updated successfully",
    "data": {
        "timezone": "string (IANA)",
        "defaultLanguage": "string",
        "complianceMode": "string (gdpr|hipaa|ferpa|none)",
        "recordingConsent": "string (required|optional|none)",
        "aiSummaries": "string (basic|enhanced|off)",
        "educationMode": "boolean",
        "dlpEnabled": "boolean",
        "translationEnabled": "boolean",
        "realTimeSummaries": "boolean",
        "lmsIntegration": "string | null",
        "retentionAlerts": "boolean"
    }
}
Modified at 2025-10-16 11:46:33
Previous
update organization
Next
Delete Organization
Built with