Skip to main content
PATCH
Update box

Authorizations

Authorization
string
header
required

Box bearer token in the form box_.... Service API keys authenticate Box operations.

Path Parameters

boxId
string
required

Public Box id returned by create/list/get box calls.

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Body

application/json
name
string

New display name. Empty strings are rejected; longer names are truncated to 120 chars by the backend.

Required string length: 1 - 120
ttlSeconds
integer | null

New archival TTL. null disables auto-stop.

Required range: 1 <= x <= 2592000
subdomain
string

Rename the Box's stable subdomain (the <subdomain>.on.ascii.dev label). Lowercase letters, digits and hyphens; no leading/trailing/double hyphens; cannot end in -desktop or -<number> (reserved for the desktop and hosted-port URLs). Must be globally unique. The base URL, desktop URL and every live host <port> URL are re-pointed to the new name with no downtime and their access tokens preserved; the old URLs stop resolving. On a transient routing error the rename is saved but returns 502 gateway_error - retry with the same value to finish activating routes.

Required string length: 3 - 40
Pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$

Response

Updated box details.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Example:

"box.info"

box
object
required