Contents x
UpdateOrganizationalUnit
    • Print
    • Dark
      Light
    Contents

    UpdateOrganizationalUnit

      • Print
      • Dark
        Light
      Article summary

      Patch
      /v1/organizationalUnits/{organizationalUnitId}

      Availability

      Early Access: Planned; date not yet confirmed

      Early Access is gated; contact the Backblaze Sales team for access.

      Limited Availability: Planned; date not yet confirmed

      This API is available only to customers with access to the Backblaze Enterprise Web Console. For more information, contact the Backblaze Sales team.

      Update organizational unit metadata

      The updateMask query parameter is optional; when omitted, the server determines which mutable fields to update from the JSON body.

      Parent changes are not permitted. Organizational Units cannot currently be nested or moved.

      Security
      HTTP
      Type bearer

      Short-lived bearer token obtained from GET /orgs/v1/authorize. Sent as Authorization - Bearer .

      Path parameters
      organizationalUnitId
      stringRequired

      The opaque identifier of the organizational unit.

      Pattern^[a-z0-9_-]{8,64}$
      Exampleou-prod-east
      Query parameters
      updateMask
      string

      Comma-separated list of fields to update. Supported value(s) - displayName.

      ExampledisplayName
      Body parameters
      {
  "displayName": "Production - Renamed",
  "etag": "BwXk9a2J8p0="
}
      object
      displayName
      string
      ExampleProduction - Renamed
      etag
      string

      Optional concurrency token. If supplied, the update fails with 409 if it does not match the server-side etag.

      ExampleBwXk9a2J8p0=
      Responses
      200

      The request succeeded.

      {
  "name": "organizationalUnits/ou-prod",
  "parent": "organizations/org-acme-prod",
  "displayName": "Production - Renamed",
  "etag": "CwYk3M1L9q2=",
  "createTime": "2026-02-06T22:55:33Z",
  "updateTime": "2026-02-06T23:01:10Z"
}
      object
      name
      string

      Resource name in the form organizationalUnits/.

      ExampleorganizationalUnits/ou-prod
      parent
      string

      Parent resource name in the form organizations/. Organizational Unit nesting is not currently supported.

      Exampleorganizations/org-acme-prod
      displayName
      string
      ExampleProduction
      etag
      string
      ExampleBwXk9a2J8p0=
      createTime
      string (date-time)
      updateTime
      string (date-time)
      400

      The request was malformed or failed validation.

      HTTP StatusCodeDescription
      400INVALID_ARGUMENTOne or more request parameters were invalid.
      Expand All
      object
      requestId
      string

      Opaque correlation identifier matching the Request-Id response header. Include in support requests.

      Example4bf92f3577b34da6a3ce929d0e0e4736
      error
      object
      code
      integer

      Numeric error code.

      Example10
      message
      string

      Human-readable description of the error.

      Exampleetag mismatch
      details
      object

      Reserved for structured, non-sensitive diagnostic information related to the error condition.

      401

      The request was not authenticated.

      HTTP StatusCodeDescription
      401UNAUTHORIZEDMissing, expired, or invalid bearer token.
      Expand All
      object
      requestId
      string

      Opaque correlation identifier matching the Request-Id response header. Include in support requests.

      Example4bf92f3577b34da6a3ce929d0e0e4736
      error
      object
      code
      integer

      Numeric error code.

      Example10
      message
      string

      Human-readable description of the error.

      Exampleetag mismatch
      details
      object

      Reserved for structured, non-sensitive diagnostic information related to the error condition.

      403

      The caller is not authorized to perform this operation.

      HTTP StatusCodeDescription
      403FORBIDDENThe authenticated principal lacks permission for this action.
      Expand All
      object
      requestId
      string

      Opaque correlation identifier matching the Request-Id response header. Include in support requests.

      Example4bf92f3577b34da6a3ce929d0e0e4736
      error
      object
      code
      integer

      Numeric error code.

      Example10
      message
      string

      Human-readable description of the error.

      Exampleetag mismatch
      details
      object

      Reserved for structured, non-sensitive diagnostic information related to the error condition.

      404

      The requested resource was not found.

      HTTP StatusCodeDescription
      404NOT_FOUNDThe resource does not exist or has been purged.
      Expand All
      object
      requestId
      string

      Opaque correlation identifier matching the Request-Id response header. Include in support requests.

      Example4bf92f3577b34da6a3ce929d0e0e4736
      error
      object
      code
      integer

      Numeric error code.

      Example10
      message
      string

      Human-readable description of the error.

      Exampleetag mismatch
      details
      object

      Reserved for structured, non-sensitive diagnostic information related to the error condition.

      409

      The request conflicted with the current state of the resource.

      HTTP StatusCodeDescription
      409CONFLICTetag mismatch, resource already exists, or precondition failed.
      Expand All
      object
      requestId
      string

      Opaque correlation identifier matching the Request-Id response header. Include in support requests.

      Example4bf92f3577b34da6a3ce929d0e0e4736
      error
      object
      code
      integer

      Numeric error code.

      Example10
      message
      string

      Human-readable description of the error.

      Exampleetag mismatch
      details
      object

      Reserved for structured, non-sensitive diagnostic information related to the error condition.

      429

      The request was rate-limited.

      HTTP StatusCodeDescription
      429TOO_MANY_REQUESTSRate limit exceeded. Use exponential backoff.
      Expand All
      object
      requestId
      string

      Opaque correlation identifier matching the Request-Id response header. Include in support requests.

      Example4bf92f3577b34da6a3ce929d0e0e4736
      error
      object
      code
      integer

      Numeric error code.

      Example10
      message
      string

      Human-readable description of the error.

      Exampleetag mismatch
      details
      object

      Reserved for structured, non-sensitive diagnostic information related to the error condition.

      500

      The server encountered an unexpected condition.

      HTTP StatusCodeDescription
      500INTERNALUnexpected server error. Include the requestId when contacting support.
      Expand All
      object
      requestId
      string

      Opaque correlation identifier matching the Request-Id response header. Include in support requests.

      Example4bf92f3577b34da6a3ce929d0e0e4736
      error
      object
      code
      integer

      Numeric error code.

      Example10
      message
      string

      Human-readable description of the error.

      Exampleetag mismatch
      details
      object

      Reserved for structured, non-sensitive diagnostic information related to the error condition.

      Was this article helpful?
      What's Next