Skip to main content
PATCH
/
v1
/
organization
Update organization
curl --request PATCH \
  --url http://localhost:3333/v1/organization \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "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,
  "isFleetSetupCompleted": false
}
'
{
  "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,
  "isFleetSetupCompleted": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "authType": "api-key"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Headers

​
X-Organization-Id
string

Organization ID (required for session auth, optional for API key auth)

Body

application/json

Organization update data

​
name
string

Organization name

Example:

"New Acme Corporation"

​
slug
string

Organization slug

Example:

"new-acme-corp"

Organization logo URL

Example:

"https://example.com/logo.png"

​
metadata
string

Additional metadata in JSON format

Example:

"{\"theme\": \"dark\", \"preferences\": {}}"

​
website
string

Organization website URL

Example:

"https://acme-corp.com"

​
onboardingCompleted
boolean

Whether onboarding is completed

Example:

true

​
hasAccess
boolean

Whether organization has access to the platform

Example:

true

​
fleetDmLabelId
integer

FleetDM label ID for device management

Example:

123

​
isFleetSetupCompleted
boolean

Whether FleetDM setup is completed

Example:

false

Response

Organization updated successfully

​
id
string

The organization ID

Example:

"org_abc123def456"

​
name
string

Organization name

Example:

"New Acme Corporation"

​
slug
string

Organization slug

Example:

"new-acme-corp"

​
logo
string | null

Organization logo URL

Example:

"https://example.com/logo.png"

​
metadata
string | null

Additional metadata in JSON format

Example:

"{\"theme\": \"dark\", \"preferences\": {}}"

​
website
string | null

Organization website URL

Example:

"https://acme-corp.com"

​
onboardingCompleted
boolean

Whether onboarding is completed

Example:

true

​
hasAccess
boolean

Whether organization has access to the platform

Example:

true

​
fleetDmLabelId
integer | null

FleetDM label ID for device management

Example:

123

​
isFleetSetupCompleted
boolean

Whether FleetDM setup is completed

Example:

false

​
createdAt
string<date-time>

When the organization was created

​
authType
enum<string>

How the request was authenticated

Available options:
api-key,
session