TRtrycompai
Organization

Update organization

Changed on

Partially updates the authenticated organization. Only provided fields will be updated.

patch/v1/organization

Request

  • Base URL
    https://api.trycomp.ai
  • Auth
    API key in header X-API-Key

Request body

namestring

Organization name

slugstring

Organization slug

logostring

Organization logo URL

metadatastring

Additional metadata in JSON format

websitestring

Organization website URL

onboardingCompletedboolean

Whether onboarding is completed

fleetDmLabelIdinteger

FleetDM label ID for device management

isFleetSetupCompletedboolean

Whether FleetDM setup is completed

primaryColorstring

Organization primary color in hex format

advancedModeEnabledboolean

Whether advanced mode is enabled for the organization

backgroundCheckStepEnabledboolean

Whether the background-check step is required during member onboarding. Set to false to turn off the "Require background checks" setting; true to require it.

evidenceApprovalEnabledboolean

Whether evidence requires approval before it is accepted.

deviceAgentStepEnabledboolean

Whether the device-agent step is enabled during member onboarding.

securityTrainingStepEnabledboolean

Whether the security-training step is enabled during member onboarding.

whistleblowerReportEnabledboolean

Whether the whistleblower reporting feature is enabled.

accessRequestFormEnabledboolean

Whether the trust-portal access request form is enabled.

Example request

{
  "name": "New Acme Corporation",
  "slug": "new-acme-corp",
  "logo": "https://example.com/logo.png",
  "metadata": "{\"theme\": \"dark\", \"preferences\": {}}",
  "website": "https://acme-corp.com",
  "onboardingCompleted": true,
  "fleetDmLabelId": 123,
  "primaryColor": "#3B82F6",
  "backgroundCheckStepEnabled": true,
  "deviceAgentStepEnabled": true,
  "securityTrainingStepEnabled": true,
  "whistleblowerReportEnabled": true,
  "accessRequestFormEnabled": true
}

Response

Organization updated successfully

idstring

The organization ID

namestring

Organization name

slugstring

Organization slug

logostring nullable

Organization logo URL

metadatastring nullable

Additional metadata in JSON format

websitestring nullable

Organization website URL

onboardingCompletedboolean

Whether onboarding is completed

hasAccessboolean

Whether organization has access to the platform

fleetDmLabelIdinteger nullable

FleetDM label ID for device management

isFleetSetupCompletedboolean

Whether FleetDM setup is completed

primaryColorstring nullable

Organization primary color in hex format

createdAtstring date-time

When the organization was created

authType'api-key' | 'session'

How the request was authenticated

Example response

{
  "id": "org_abc123def456",
  "name": "New Acme Corporation",
  "slug": "new-acme-corp",
  "logo": "https://example.com/logo.png",
  "metadata": "{\"theme\": \"dark\", \"preferences\": {}}",
  "website": "https://acme-corp.com",
  "onboardingCompleted": true,
  "hasAccess": true,
  "fleetDmLabelId": 123,
  "primaryColor": "#3B82F6"
}

Changes

  • 8d8d15c8f24dRevision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • d7d0199d846fRevision changes
    • info

      the endpoint scheme security oauth2 was removed from the API