Sign in

v1

latestOpenAPI 3.0.12026-07-2491247233.8 KB
Organizations

Update child organization

Update a child organization's display name and delegation settings, returning the full child organization.

patch/v0/organizations/mine/child-organizations/{id}

Path parameters

idstring uuid required

ID of the child organization to patch.

Example:019263d1-7c1a-7c8e-9c66-f1c2a9b1f4e2

ID of the child organization to patch.

Request body

can_add_childrenboolean nullable

Set whether this organization may create its own child organizations. Granting requires the target to be below the maximum hierarchy depth.

can_manage_child_licensesboolean nullable

Set whether this organization may manage licenses on its descendants. Granting requires child-organization license management to be enabled for the root organization and the target's immediate parent to already hold this permission; revoking is always allowed.

namestring nullable

New display name for the organization. Must be non-empty after trimming whitespace.

Example request

{
  "can_add_children": true,
  "name": "Acme Corp (renamed)"
}

Response

OK

active_automation_rule_countinteger

Number of active automation rules

active_detection_rule_countinteger

Number of active detection rules

active_mailbox_countinteger

Number of currently active mailboxes

can_add_childrenboolean nullable

Whether this organization can add child organizations

can_manage_child_licensesboolean nullable

Whether this organization can manage child organization licenses

created_atstring date-time

Time at which the organization was created

deleted_atstring date-time nullable

Time at which org was soft deleted (inaccessible, data not deleted)

idstring

Organization unique ID

namestring

Organization chosen name

parent_org_idstring nullable

ID of this organization's parent in the hierarchy. The top-level organization has no parent.

scheduled_for_deletion_atstring date-time nullable

Time at which hard deletion of org data is scheduled to begin

total_mailbox_countinteger

Total number of mailboxes