Skip to main content

Update an existing organization

PATCH 
/api/v1/orgs/{orgId}

Update the name, description of an existing organization. parentOrgId is immutable in v1.0 and must match the existing value.

Parameters

  • orgId (Guid, required): ID of the organization to update.
  • Request body: CreateUpdateOrgDto with updated values.
    • name (string, required, max length 100): updated organization name. Must be globally unique (case-insensitive, whitespace-normalized).
    • parentOrgId (string, required): must match the existing parentOrgId — modification is not allowed in v1.0.
    • description (string, optional, max length 200): updated organization description.

Responses

  • 200 OK: organization updated successfully.
  • 400 Bad Request: invalid input (name conflict, parentOrgId mismatch, field length exceeded).
  • 403 Forbidden: caller does not have admin role in this organization.
  • 404 Not Found: organization not found.

Security

  • This API requires authentication.

Request​

Responses​

OK