Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Latest version

Update storage policy assignment

put
https://api.box.com/2.0
/storage_policy_assignments/:storage_policy_assignment_id

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Updates a specific storage policy assignment.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
932483

The ID of the storage policy assignment.

Request Body

objectin body

The storage policy to assign to the user or enterprise.

stringin bodyrequired
"1434325"

The ID of the storage policy to assign.

stringin bodyrequired
"storage_policy"

The type to assign.

Value is always storage_policy

Response

application/jsonStorage policy assignment

Returns an updated storage policy assignment object.

application/jsonClient error

An unexpected client error.

put
Update storage policy assignment
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


cURL
curl -i -X PUT "https://api.box.com/2.0/storage_policy_assignments/932483" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "storage_policy": {
         "type": "storage_policy",
         "id": "1434325"
       }
     }'
Node/TypeScript v10
await client.storagePolicyAssignments.updateStoragePolicyAssignmentById(
  storagePolicyAssignment.id,
  {
    storagePolicy:
      new UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField({
        id: storagePolicy2.id,
      }),
  } satisfies UpdateStoragePolicyAssignmentByIdRequestBody,
);
Python v10
client.storage_policy_assignments.update_storage_policy_assignment_by_id(
    storage_policy_assignment.id,
    UpdateStoragePolicyAssignmentByIdStoragePolicy(id=storage_policy_2.id),
)
.NET v10
await client.StoragePolicyAssignments.UpdateStoragePolicyAssignmentByIdAsync(storagePolicyAssignmentId: storagePolicyAssignment.Id, requestBody: new UpdateStoragePolicyAssignmentByIdRequestBody(storagePolicy: new UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField(id: storagePolicy2.Id)));
Swift v10
try await client.storagePolicyAssignments.updateStoragePolicyAssignmentById(storagePolicyAssignmentId: storagePolicyAssignment.id, requestBody: UpdateStoragePolicyAssignmentByIdRequestBody(storagePolicy: UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField(id: storagePolicy2.id)))
Java v10
client.getStoragePolicyAssignments().updateStoragePolicyAssignmentById(storagePolicyAssignment.getId(), new UpdateStoragePolicyAssignmentByIdRequestBody(new UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField(storagePolicy2.getId())))
.NET v6
await client.StoragePolicyAssignments.UpdateStoragePolicyAssignmentByIdAsync(storagePolicyAssignmentId: storagePolicyAssignment.Id, requestBody: new UpdateStoragePolicyAssignmentByIdRequestBody(storagePolicy: new UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField(id: storagePolicy2.Id)));
Node v4
await client.storagePolicyAssignments.updateStoragePolicyAssignmentById(
  storagePolicyAssignment.id,
  {
    storagePolicy:
      new UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField({
        id: storagePolicy2.id,
      }),
  } satisfies UpdateStoragePolicyAssignmentByIdRequestBody,
);

Response Example

{
  "id": "ZW50ZXJwcmlzZV8xMjM0NTY3ODkw",
  "type": "storage_policy_assignment",
  "assigned_to": {
    "id": "11446498",
    "type": "file"
  },
  "storage_policy": {
    "id": "11446498",
    "type": "storage_policy"
  }
}