Update organization

PATCH /api/organizations/{id}

OAuth2

Update organization details by ID with the given data.

Path parameters

id string Required

The unique identifier of the organization.

application/json

Body Required

tenantId string

Maximum length is 21.
id string

Minimum length is 1, maximum length is 21.
name string

The updated name of the organization.

Minimum length is 1, maximum length is 128.
description string | null

The updated description of the organization.

Maximum length is 256.
customData object

arbitrary
isMfaRequired boolean
branding object
Hide branding attributes Show branding attributes
- logoUrl string(url)
- darkLogoUrl string(url)
- favicon string(url)
- darkFavicon string(url)
createdAt number

Responses

200 application/json

The organization was updated successfully.
Hide response attributes Show response attributes object
- tenantId string Required
  
  Maximum length is 21.
- id string Required
  
  Minimum length is 1, maximum length is 21.
- name string Required
  
  Minimum length is 1, maximum length is 128.
- description string | null Required
  
  Maximum length is 256.
- customData object Required
  
  arbitrary
- isMfaRequired boolean Required
- branding object Required
  
  Hide branding attributes Show branding attributes
  
  logoUrl string(url)
  
  darkLogoUrl string(url)
  
  favicon string(url)
  
  darkFavicon string(url)
- createdAt number Required
400

Bad Request
401

Unauthorized
403

Forbidden
404

Not Found

PATCH /api/organizations/{id}

curl \
 -X PATCH https://[tenant_id].logto.app/api/organizations/{id} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"tenantId":"string","id":"string","name":"string","description":"string","customData":{},"isMfaRequired":true,"branding":{"logoUrl":"string","darkLogoUrl":"string","favicon":"string","darkFavicon":"string"},"createdAt":42.0}'

Request examples

{
  "tenantId": "string",
  "id": "string",
  "name": "string",
  "description": "string",
  "customData": {},
  "isMfaRequired": true,
  "branding": {
    "logoUrl": "string",
    "darkLogoUrl": "string",
    "favicon": "string",
    "darkFavicon": "string"
  },
  "createdAt": 42.0
}

Response examples (200)

{
  "tenantId": "string",
  "id": "string",
  "name": "string",
  "description": "string",
  "customData": {},
  "isMfaRequired": true,
  "branding": {
    "logoUrl": "string",
    "darkLogoUrl": "string",
    "favicon": "string",
    "darkFavicon": "string"
  },
  "createdAt": 42.0
}