UpdateAccount
- Print
- DarkLight
UpdateAccount
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Patch
/v1/accounts/{accountId}
Availability
Early Access: July 1, 2026
Early Access is gated; contact the Backblaze Sales team for access.
Limited Availability: July 1, 2026
This API is available only to customers with access to the Backblaze Enterprise Web Console. For more information, contact the Backblaze Sales team.
Update account fields
The updateMask query parameter is not required; when omitted, the server determines which fields to update from the JSON body.
Parent changes are not permitted via UpdateAccount. To move an account between its organization and an Organizational Unit, use MoveAccount.
Security
HTTP
Type bearer
Short-lived bearer token obtained from GET /orgs/v1/authorize. Sent as Authorization - Bearer .
Path parameters
accountId
stringRequired
The numeric identifier of the account. Valid account IDs match 9[0-4][0-9]{10}.
Pattern^9[0-4][0-9]{10}$
Example912345678901
Query parameters
updateMask
string
Comma-separated list of fields to update. Supported value(s) - displayName.
ExampledisplayName
Body parameters
{
"displayName": "tenant-prod-renamed",
"etag": "BwXk9a2J8p0="
}object
displayName
string
Exampletenant-prod-renamed
etag
string
Optional concurrency token.
ExampleBwXk9a2J8p0=
Responses
200
The request succeeded.
{
"name": "accounts/912345678901",
"accountId": "912345678901",
"parent": "organizations/org-acme-prod",
"organization": "organizations/org-acme-prod",
"displayName": "tenant-prod-renamed",
"billingAccount": "billingAccounts/456",
"state": "ACTIVE",
"suspensionReasons": [],
"etag": "CwYk3M1L9q2=",
"createTime": "2026-02-03T21:10:00Z",
"updateTime": "2026-02-04T09:01:00Z",
"deleteTime": null,
"purgeTime": null
}object
name
string
Resource name in the form accounts/.
Exampleaccounts/912345678901
accountId
string
The numeric account identifier. Valid values match 9[0-4][0-9]{10}.
Example912345678901
parent
string
Parent resource name. May be an organization or an Organizational Unit.
Exampleorganizations/org-acme-prod
organization
string
The organization the account belongs to. Always populated, even if parent is an Organizational Unit.
Exampleorganizations/org-acme-prod
billingAccount
string
Billing account reference, in the form billingAccounts/. Must belong to the same organization as the account. Cannot be changed after creation.
ExamplebillingAccounts/456
displayName
string
Exampletenant-prod
state
string
Account lifecycle state. An account is SUSPENDED while one or more suspension reasons are active.
Valid values[ "ACTIVE", "SUSPENDED", "DELETED" ]
ExampleACTIVE
suspensionReasons
Array of string
Reasons the account is suspended. Values are unique and array order is unspecified.
Example[]
string
Valid values[ "BACKBLAZE_INITIATED", "EXTERNALLY_INITIATED" ]
etag
string
ExampleBwXk9a2J8p0=
createTime
string (date-time)
updateTime
string (date-time)
deleteTime
string (date-time) | null
purgeTime
string (date-time) | null
400
The request was malformed or failed validation.
| HTTP Status | Code | Description |
|---|---|---|
| 400 | INVALID_ARGUMENT | One or more request parameters were invalid. |
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 Status | Code | Description |
|---|---|---|
| 401 | UNAUTHORIZED | Missing, expired, or invalid bearer token. |
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 Status | Code | Description |
|---|---|---|
| 403 | FORBIDDEN | The authenticated principal lacks permission for this action. |
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 Status | Code | Description |
|---|---|---|
| 404 | NOT_FOUND | The resource does not exist or has been purged. |
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 Status | Code | Description |
|---|---|---|
| 409 | CONFLICT | etag mismatch, resource already exists, or precondition failed. |
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 Status | Code | Description |
|---|---|---|
| 429 | TOO_MANY_REQUESTS | Rate limit exceeded. Use exponential backoff. |
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 Status | Code | Description |
|---|---|---|
| 500 | INTERNAL | Unexpected server error. Include the requestId when contacting support. |
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?