Sample - Box Platform API
PUT/storage_policy_assignments/{storage_policy_assignment_id}

Update a storage policy assignment

Updates a storage policy assignment for a user or enterprise. Provide storage_policy with its storage policy type and identifier to replace the assignment, then use the returned object to confirm the change.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 1 body field
storage_policy_assignment_idstringrequired
The identifier of the storage policy assignment to update.

Storage policy assignment details containing the storage policy to assign.

storage_policyobjectrequired
The storage policy to assign to the user or enterprise.

2 status codes
200Returns the updated storage policy assignment object, including its identifier, resource type, assigned storage policy, and assignment target.
idstringrequired
The unique identifier for a storage policy assignment.
typestringrequired
The value will always be `storage_policy_assignment`.
Allowed:storage_policy_assignment
storage_policyobjectoptional
assigned_toobjectoptional
defaultReturned when an unexpected client error occurs. The response contains an error type, status, code, message, context information, help URL, and request identifier.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

storage_policy is required and must contain both type and id. type must be storage_policy, and storage_policy_assignment_id must identify the assignment you intend to update.