Box Developer Documentation
Log in
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

TypeScript Gen
await client.retentionPolicyAssignments.deleteRetentionPolicyAssignmentById(
  retentionPolicyAssignment.id,
);
Python Gen
client.retention_policy_assignments.delete_retention_policy_assignment_by_id(
    retention_policy_assignment.id
)
.NET Gen
await client.RetentionPolicyAssignments.DeleteRetentionPolicyAssignmentByIdAsync(retentionPolicyAssignmentId: retentionPolicyAssignment.Id);
Swift Gen (Beta)
try await client.retentionPolicyAssignments.deleteRetentionPolicyAssignmentById(retentionPolicyAssignmentId: retentionPolicyAssignment.id)
Java
BoxRetentionPolicyAssignment assignment = new BoxRetentionPolicyAssignment(api, id);
assignment.delete();
Node
client.retentionPolicies.deleteAssignment('12345')
	.then(() => {
		// deletion succeeded — no value returned
	});
iOS
client.retentionPolicy.deleteAssignment(assignmentId: "123456")  { result in
    guard case let .success = result else {
        print("Error deleting retention policy assignment")
        return
    }
    
    print("Retention policy assignment was deleted")
}