update organization

Developing

Develop Env

http://localhost:3000/api

PUT

/orgs/{orgId}/update

organization

Maintainer:Abdelrhman Moataz

Purpose

Replace organization record (use with caution). Prefer PATCH for partial updates.

Auth / Scope

org:write AND caller must be org admin or system:admin.

Headers

Authorization: Bearer <token>

Content-Type: application/json

X-Request-ID, optional Idempotency-Key for safe retries

Notes

This is a full replace. Use PATCH /orgs/{orgId}/settings to change settings only.

Server will write audit log entry for the update.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠404Not Found

🟠403Forbidden

🔴500Server Error

🟠429Too Many Requests

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'http://localhost:3000/api/orgs//update' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Cognita Education Group",
    "orgType": "education",
    "billingAccountId": "cus_87654321xyz",
    "settings": {
        "timezone": "America/Los_Angeles",
        "defaultLanguage": "en-US",
        "complianceMode": "ferpa",
        "recordingConsent": "required",
        "aiSummaries": "enhanced",
        "educationMode": true
    },
    "retentionPolicy": {
        "transcripts": "730d",
        "recordings": "365d",
        "chatLogs": "365d",
        "userData": "1825d",
        "examData": "3650d"
    },
    "allowedDomains": [
        "cognita.edu"
    ],
    "featureFlags": {
        "realTimeTranslation": true
    }
}'

Response Example

200 - Example 1

{
    "status": "ok",
    "message": "Organization updated successfully",
    "data": {
        "name": "Cognita Education Group",
        "orgType": "education",
        "billingAccountId": "cus_87654321xyz",
        "settings": {
            "timezone": "America/Los_Angeles",
            "defaultLanguage": "en-US",
            "complianceMode": "ferpa",
            "recordingConsent": "required",
            "aiSummaries": "enhanced",
            "educationMode": true
        },
        "retentionPolicy": {
            "transcripts": "730d",
            "recordings": "365d",
            "chatLogs": "365d",
            "userData": "1825d",
            "examData": "3650d"
        },
        "allowedDomains": [
            "cognita.edu"
        ],
        "featureFlags": {
            "realTimeTranslation": true
        }
    }
}

Modified at 2025-10-16 11:46:28

Get Organizations

update settings

update organization

Purpose#

Auth / Scope#