post__settings_organization

POST /settings/organization

Update Organization Settings (Full Replacement)

Update the organization settings with a complete replacement. This endpoint replaces all existing organization settings with the provided settings object. The user must be authenticated and associated with an organization.

Request Body Schema

Name
Type
Required
Restrictions
Description

» settings

object

true

none

Complete settings object to replace existing settings

TypeScript Client Library

// Using the Flashback TypeScript client
import { FlashbackClient } from '@flashback/client';

const client = new FlashbackClient({ accessToken: 'your-access-token' });

// Update organization settings with full replacement
try {
  const result = await client.settings.organization.update({
    settings: {
      defaultStorageType: 'S3',
      maxFileSize: '10GB',
      retentionPolicy: { enabled: true, days: 365 },
      security: { requireMFA: true, sessionTimeout: 3600 }
    }
  });
  console.log('Organization settings updated:', result);
} catch (error) {
  console.error('Failed to update organization settings:', error);
}

Code Samples

# You can also use wget
curl -X POST https://backend.flashback.tech/settings/organization \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "settings": {
      "defaultStorageType": "S3",
      "maxFileSize": "10GB",
      "retentionPolicy": {
        "enabled": true,
        "days": 365
      },
      "security": {
        "requireMFA": true,
        "sessionTimeout": 3600
      }
    }
  }'

Example responses

200 Response

{
  "success": true,
  "message": "Organization settings updated successfully"
}

400 Response

{
  "success": false,
  "message": "Failed to update organization settings"
}

404 Response

{
  "success": false,
  "message": "User not associated with any organization"
}

500 Response

{
  "success": false,
  "message": "Internal server error",
  "error": "Database connection failed"
}

Responses

Status
Meaning
Description
Schema

200

Organization settings updated successfully

Inline

400

Failed to update organization settings

Inline

404

User not associated with organization

Inline

500

Internal server error

Inline

Response Schema

Status Code 200

Name
Type
Required
Restrictions
Description

» success

boolean

true

none

Indicates if the request was successful

» message

string

true

none

Success message describing the operation

Status Code 400

Name
Type
Required
Restrictions
Description

» success

boolean

true

none

Always false for error responses

» message

string

true

none

Error message describing the issue

Status Code 404

Name
Type
Required
Restrictions
Description

» success

boolean

true

none

Always false for error responses

» message

string

true

none

Error message describing the issue

Status Code 500

Name
Type
Required
Restrictions
Description

» success

boolean

true

none

Always false for error responses

» message

string

true

none

Error message describing the issue

» error

string

false

none

Additional error details if available

DTOs

UpdateSettingsRequest

export interface UpdateSettingsRequest {
  // Using Record<string, any> for maximum flexibility - settings can contain any JSON-serializable data
  settings: Record<string, any>;
}

SettingsErrorResponse

export interface SettingsErrorResponse {
  success: false;
  message: string;
  error?: string;
}

Last updated

Was this helpful?