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

Remove retention policy assignment

delete
https://api.box.com/2.0
/retention_policy_assignments/:retention_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.

Removes a retention policy assignment applied to content.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
1233123

The ID of the retention policy assignment.

Response

none

Returns an empty response when the policy assignment is successfully deleted.

application/jsonClient error

Returns an error when the assignment relates to a retention policy that cannot be modified.

application/jsonClient error

Returns an error when the retention policy assignment does not exist.

application/jsonClient error

An unexpected client error.

delete
Remove retention 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.


Node/TypeScript v10
await client.retentionPolicyAssignments.deleteRetentionPolicyAssignmentById(
  retentionPolicyAssignment.id,
);
Python v10
client.retention_policy_assignments.delete_retention_policy_assignment_by_id(
    retention_policy_assignment.id
)
.NET v10
await client.RetentionPolicyAssignments.DeleteRetentionPolicyAssignmentByIdAsync(retentionPolicyAssignmentId: retentionPolicyAssignment.Id);
Swift v10
try await client.retentionPolicyAssignments.deleteRetentionPolicyAssignmentById(retentionPolicyAssignmentId: retentionPolicyAssignment.id)
Java v10
client.getRetentionPolicyAssignments().deleteRetentionPolicyAssignmentById(retentionPolicyAssignment.getId())
Java v5
BoxRetentionPolicyAssignment assignment = new BoxRetentionPolicyAssignment(api, id);
assignment.delete();
Node v4
client.retentionPolicies.deleteAssignment('12345')
	.then(() => {
		// deletion succeeded — no value returned
	});