Update organization

PATCH /api/organizations/{id}

Update organization details by ID with the given data.

Path parameters

  • id string Required

    The unique identifier of the organization.

application/json

Body Required

  • 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

  • createdAt number

Responses

  • • 200 application/json

    The organization was updated successfully.

    Hide response attributes Show response attributes object
    • 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

    • 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 "Content-Type: application/json" \
 -d '{"id":"string","name":"string","description":"string","customData":{},"createdAt":42.0}'
Request example 
{
  "id": "string",
  "name": "string",
  "description": "string",
  "customData": {},
  "createdAt": 42.0
}
Response examples (200) 
{
  "id": "string",
  "name": "string",
  "description": "string",
  "customData": {},
  "createdAt": 42.0
}