Deletes an AI agent using the provided parameters.

Removes a domain from the list of domains that have been deemed safe to create collaborations for within the current enterprise.

Removes a user's exemption from the restrictions set out by the allowed list of domains for collaborations.

Deletes a single collaboration.

Permanently deletes a comment.

Deletes an individual device pin.

Deletes a file request permanently.

Deletes a file, either permanently or by moving it to the trash.

The the enterprise settings determine whether the item will be permanently deleted from Box or moved to the trash.

Removes any classifications from a file.

This API can also be called by including the enterprise ID in the URL explicitly, for example /files/:id//enterprise_12345/securityClassification-6VMVochwUWo.

Removes any Box Skills cards metadata from a file.

Deletes a piece of file metadata.

Permanently deletes a file that is in the trash. This action cannot be undone.

Move a file version to the trash.

Versions are only tracked for Box users with premium accounts.

Removes the watermark from a file.

Abort an upload session and discard all data uploaded.

This cannot be reversed.

The actual endpoint URL is returned by the Create upload session and Get upload session endpoints.

Deletes a folder lock on a given folder.

You must be authenticated as the owner or co-owner of the folder to use this endpoint.

Deletes a folder, either permanently or by moving it to the trash.

Removes any classifications from a folder.

This API can also be called by including the enterprise ID in the URL explicitly, for example /folders/:id/enterprise_12345/securityClassification-6VMVochwUWo.

Deletes a piece of folder metadata.

Permanently deletes a folder that is in the trash. This action cannot be undone.

Removes the watermark from a folder.

Deletes a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Permanently deletes a group. Only users with admin-level permissions will be able to use this API.

Deletes a Slack integration mapping.

You need Admin or Co-Admin role to use this endpoint.

Deletes a Teams integration mapping. You need Admin or Co-Admin role to use this endpoint.

Delete an existing legal hold policy.

This is an asynchronous process. The policy will not be fully deleted yet when the response returns.

Remove a legal hold from an item.

This is an asynchronous process. The policy will not be fully removed yet when the response returns.

Deletes a metadata cascade policy.

Delete a metadata template and its instances. This deletion is permanent and can not be reversed.

Permanently deletes a retention policy.

Removes a retention policy assignment applied to content.

Deletes a shield information barrier segment member based on provided ID.

Delete shield information barrier segment restriction based on provided ID.

Deletes the shield information barrier segment based on provided ID.

Delete a storage policy assignment.

Deleting a storage policy assignment on a user will have the user inherit the enterprise's default storage policy.

There is a rate limit for calling this endpoint of only twice per user in a 24 hour time frame.

Deletes a specific task assignment.

Removes a task from a file.

Deletes a user. By default this will fail if the user still owns any content. Move their owned content first before proceeding, or use the force field to delete the user and their files.

Removes an existing user avatar. You cannot reverse this operation.

Removes an email alias from a user.

Deletes a web link.

Permanently deletes a web link that is in the trash. This action cannot be undone.

Deletes a webhook.

Download a file from Box and get a signed URL

Get the AI agent default config.

Lists AI agents based on the provided parameters.

Gets an AI Agent using the agent_id parameter.

Authorize a user by sending them through the Box website and request their permission to act on their behalf.

This is the first step when authenticating a user using OAuth 2.0. To request a user's authorization to use the Box APIs on their behalf you will need to send a user to the URL with this format.

Returns the list domains that have been deemed safe to create collaborations for within the current enterprise.

Returns a domain that has been deemed safe to create collaborations for within the current enterprise.

Returns a list of users who have been exempt from the collaboration domain restrictions.

Returns a users who has been exempt from the collaboration domain restrictions.

Retrieves all pending collaboration invites for this user.

Retrieves a single collaboration.

Retrieves all collections for a given user.

Currently, only the favorites collection is supported.

Retrieves a collection by its ID.

Retrieves the files and/or folders contained within this collection.

Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment.

Retrieves information about an individual device pin.

Retrieves all the device pins within an enterprise.

The user must have admin privileges, and the application needs the "manage enterprise" scope to make this call.

Returns up to a year of past events for a given user or for the entire enterprise.

By default this returns events for the authenticated user. To retrieve events for the entire enterprise, set the stream_type to admin_logs_streaming for live monitoring of new events, or admin_logs for querying across historical events. The user making the API call will need to have admin privileges, and the application will need to have the scope manage enterprise properties checked.

Retrieves the information about a file request.

Get a list of file versions on legal hold for a legal hold assignment.

Due to ongoing re-architecture efforts this API might not return all file versions for this policy ID.

Instead, this API will only return file versions held in the legacy architecture. Two new endpoints will available to request any file versions held in the new architecture.

For file versions held in the new architecture, the GET /legal_hold_policy_assignments/:id/file_versions_on_hold API can be used to return all past file versions available for this policy assignment, and the GET /legal_hold_policy_assignments/:id/files_on_hold API can be used to return any current (latest) versions of a file under legal hold.

The GET /legal_hold_policy_assignments?policy_id={id} API can be used to find a list of policy assignments for a given policy ID.

Once the re-architecture is completed this API will be deprecated.

Retrieves information about the legal hold policies assigned to a file version.

Retrieves all file version retentions for the given enterprise.

Note: File retention API is now deprecated. To get information about files and file versions under retention, see files under retention or file versions under retention endpoints.

Returns information about a file version retention.

Note: File retention API is now deprecated. To get information about files and file versions under retention, see files under retention or file versions under retention endpoints.

Retrieves the details about a file.

This is a beta feature, which means that its availability might be limited. Returns all app items the file is associated with. This includes app items associated with ancestors of the file. Assuming the context user has access to the file, the type/ids are revealed even if the context user does not have View permission on the app item.

Retrieves a list of pending and active collaborations for a file. This returns all the users that have access to the file or have been invited to the file.

Retrieves a list of comments for a file.

Gets the information for a shared link on a file.

Retrieves all metadata for a given file.

Retrieves the classification metadata instance that has been applied to a file.

This API can also be called by including the enterprise ID in the URL explicitly, for example /files/:id//enterprise_12345/securityClassification-6VMVochwUWo.

List the Box Skills metadata cards that are attached to a file.

Retrieves the instance of a metadata template that has been applied to a file.

Retrieves a list of all the tasks for a file. This endpoint does not support pagination.

Retrieves a thumbnail, or smaller image representation, of a file.

Sizes of 32x32,64x64, 128x128, and 256x256 can be returned in the .png format and sizes of 32x32, 160x160, and 320x320 can be returned in the .jpg format.

Thumbnails can be generated for the image and video file formats listed found on our community site.

Retrieves a file that has been moved to the trash.

Please note that only if the file itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the GET /folders/:id/trash API.

To list all items that have been moved to the trash, please use the GET /folders/trash/items API.

Retrieve a list of the past versions for a file.

Versions are only tracked by Box users with premium accounts. To fetch the ID of the current version of a file, use the GET /file/:id API.

Retrieve a specific version of a file.

Versions are only tracked for Box users with premium accounts.

Retrieve the watermark for a file.

Return information about an upload session.

The actual endpoint URL is returned by the Create upload session endpoint.

Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the Create upload session and Get upload session endpoints.

Retrieves folder lock details for a given folder.

You must be authenticated as the owner or co-owner of the folder to use this endpoint.

Retrieves details for a folder, including the first 100 entries in the folder.

Passing sort, direction, offset, and limit parameters in query allows you to manage the list of returned folder items.

To fetch more items within the folder, use the Get items in a folder endpoint.

This is a beta feature, which means that its availability might be limited. Returns all app items the folder is associated with. This includes app items associated with ancestors of the folder. Assuming the context user has access to the folder, the type/ids are revealed even if the context user does not have View permission on the app item.

Retrieves a list of pending and active collaborations for a folder. This returns all the users that have access to the folder or have been invited to the folder.

Gets the information for a shared link on a folder.

Retrieves a page of items in a folder. These items can be files, folders, and web links.

To request more information about the folder itself, like its size, use the Get a folder endpoint instead.

Retrieves all metadata for a given folder. This can not be used on the root folder with ID 0.

Retrieves the classification metadata instance that has been applied to a folder.

This API can also be called by including the enterprise ID in the URL explicitly, for example /folders/:id/enterprise_12345/securityClassification-6VMVochwUWo.

Retrieves the instance of a metadata template that has been applied to a folder. This can not be used on the root folder with ID 0.

Retrieves a folder that has been moved to the trash.

Please note that only if the folder itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the GET /folders/:id/trash API.

To list all items that have been moved to the trash, please use the GET /folders/trash/items API.

Retrieve the watermark for a folder.

Retrieves the files and folders that have been moved to the trash.

Any attribute in the full files or folders objects can be passed in with the fields parameter to retrieve those specific attributes that are not returned by default.

This endpoint defaults to use offset-based pagination, yet also supports marker-based pagination using the marker parameter.

Retrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups.

Retrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.

Retrieves all the collaborations for a group. The user must have admin permissions to inspect enterprise's groups.

Each collaboration object has details on which files or folders the group has access to and with what role.

Retrieves all the members for a group. Only members of this group or users with admin-level permissions will be able to use this API.

Lists Slack integration mappings in a users' enterprise.

You need Admin or Co-Admin role to use this endpoint.

Lists Teams integration mappings in a users' enterprise. You need Admin or Co-Admin role to use this endpoint.

Returns the status of a user invite.

Retrieves a list of legal hold policies that belong to an enterprise.

Retrieve a legal hold policy.

Retrieves a list of items a legal hold policy has been assigned to.

Retrieve a legal hold policy assignment.

Get a list of previous file versions for a legal hold assignment.

In some cases you may only need the latest file versions instead. In these cases, use the GET /legal_hold_policy_assignments/:id/files_on_hold API instead to return any current (latest) versions of a file for this legal hold policy assignment.

Due to ongoing re-architecture efforts this API might not return all files held for this policy ID. Instead, this API will only return past file versions held in the newly developed architecture. The GET /file_version_legal_holds API can be used to fetch current and past versions of files held within the legacy architecture.

This endpoint does not support returning any content that is on hold due to a Custodian collaborating on a Hub.

The GET /legal_hold_policy_assignments?policy_id={id} API can be used to find a list of policy assignments for a given policy ID.

Get a list of files with current file versions for a legal hold assignment.

In some cases you may want to get previous file versions instead. In these cases, use the GET /legal_hold_policy_assignments/:id/file_versions_on_hold API instead to return any previous versions of a file for this legal hold policy assignment.

Due to ongoing re-architecture efforts this API might not return all file versions held for this policy ID. Instead, this API will only return the latest file version held in the newly developed architecture. The GET /file_version_legal_holds API can be used to fetch current and past versions of files held within the legacy architecture.

This endpoint does not support returning any content that is on hold due to a Custodian collaborating on a Hub.

The GET /legal_hold_policy_assignments?policy_id={id} API can be used to find a list of policy assignments for a given policy ID.

Retrieves a list of all the metadata cascade policies that are applied to a given folder. This can not be used on the root folder with ID 0.

Retrieve a specific metadata cascade policy assigned to a folder.

Finds a metadata template by searching for the ID of an instance of the template.

Used to retrieve all metadata templates created to be used specifically within the user's enterprise.

Retrieves the classification metadata template and lists all the classifications available to this enterprise.

This API can also be called by including the enterprise ID in the URL explicitly, for example /metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema.

Used to retrieve all generic, global metadata templates available to all enterprises using Box.

Retrieves a metadata template by its ID.

Retrieves a metadata template by its scope and templateKey values.

To find the scope and templateKey for a template, list all templates for an enterprise or globally, or list all templates applied to a file or folder.

Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed.

Retrieves all of the retention policies for an enterprise.

Retrieves a retention policy.

Returns a list of all retention policy assignments associated with a specified retention policy.

Retrieves a retention policy assignment.

Returns a list of file versions under retention for a retention policy assignment.

Returns a list of files under retention for a retention policy assignment.

Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.

Returns the file represented by a shared link.

A shared file can be represented by a shared link, which can originate within the current enterprise or within another.

This endpoint allows an application to retrieve information about a shared file when only given a shared link.

The shared_link_permission_options array field can be returned by requesting it in the fields query parameter.

Returns the app item represented by a shared link.

The link can originate from the current enterprise or another.

Return the folder represented by a shared link.

A shared folder can be represented by a shared link, which can originate within the current enterprise or within another.

This endpoint allows an application to retrieve information about a shared folder when only given a shared link.

Returns the web link represented by a shared link.

A shared web link can be represented by a shared link, which can originate within the current enterprise or within another.

This endpoint allows an application to retrieve information about a shared web link when only given a shared link.

Lists shield information barrier reports.

Retrieves a shield information barrier report by its ID.

Lists shield information barrier segment members based on provided segment IDs.

Retrieves a shield information barrier segment member by its ID.

Lists shield information barrier segment restrictions based on provided segment ID.

Retrieves a shield information barrier segment restriction based on provided ID.

Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID.

Retrieves shield information barrier segment based on provided ID..

Retrieves a list of shield information barrier objects for the enterprise of JWT.

Get shield information barrier based on provided ID.

Gets signature requests created by a user. If the sign_files and/or parent_folder are deleted, the signature request will not return in the list.

Gets a sign request by ID.

Gets Box Sign templates created by a user.

Fetches details of a specific Box Sign template.

Fetches all the storage policies in the enterprise.

Fetches a specific storage policy.

Fetches all the storage policy assignment for an enterprise or user.

Fetches a specific storage policy assignment.

Retrieves information about a task assignment.

Retrieves information about a specific task.

Lists all of the assignments for a given task.

Retrieves an overview of users and their status for a terms of service, including Whether they have accepted the terms and when.

Returns the current terms of service text and settings for the enterprise.

Fetches a specific terms of service.

Returns a list of all users for the Enterprise along with their user_id, public_name, and login.

The application and the authenticated user need to have the permission to look up users in the entire enterprise.

Retrieves information about a user in the enterprise.

The application and the authenticated user need to have the permission to look up users in the entire enterprise.

This endpoint also returns a limited set of information for external users who are collaborated on content owned by the enterprise for authenticated users with the right scopes. In this case, disallowed fields will return null instead.

Retrieves an image of a the user's avatar.

Retrieves all email aliases for a user. The collection does not include the primary login for the user.

Retrieves all the groups for a user. Only members of this group or users with admin-level permissions will be able to use this API.

Retrieves information about the user who is currently authenticated.

In the case of a client-side authenticated OAuth 2.0 application this will be the user who authorized the app.

In the case of a JWT, server-side authenticated application this will be the service account that belongs to the application by default.

Use the As-User header to change who this API call is made on behalf of.

Retrieve information about a web link.

Gets the information for a shared link on a web link.

Retrieves a web link that has been moved to the trash.

Returns all defined webhooks for the requesting application.

This API only returns webhooks that are applied to files or folders that are owned by the authenticated user. This means that an admin can not see webhooks created by a service account unless the admin has access to those folders, and vice versa.

Retrieves a specific webhook.

Returns list of workflows that act on a given folder ID, and have a flow with a trigger type of WORKFLOW_MANUAL_START.

You application must be authorized to use the Manage Box Relay application scope within the developer console in to use this endpoint.

Returns the contents of a zip archive in binary format. This URL does not require any form of authentication and could be used in a user's browser to download the archive to a user's device.

By default, this URL is only valid for a few seconds from the creation of the request for this archive. Once a download has started it can not be stopped and resumed, instead a new request for a zip archive would need to be created.

The URL of this endpoint should not be considered as fixed. Instead, use the Create zip download API to request to create a zip archive, and then follow the download_url field in the response to this endpoint.

Returns the download status of a zip archive, allowing an application to inspect the progress of the download as well as the number of items that might have been skipped.

This endpoint can only be accessed once the download has started. Subsequently this endpoint is valid for 12 hours from the start of the download.

The URL of this endpoint should not be considered as fixed. Instead, use the Create zip download API to request to create a zip archive, and then follow the status_url field in the response to this endpoint.

Returns a list of real-time servers that can be used for long-polling updates to the event stream.

Long polling is the concept where a HTTP request is kept open until the server sends a response, then repeating the process over and over to receive updated responses.

Long polling the event stream can only be used for user events, not for enterprise events.

To use long polling, first use this endpoint to retrieve a list of long poll URLs. Next, make a long poll request to any of the provided URLs.

When an event occurs in monitored account a response with the value new_change will be sent. The response contains no other details as it only serves as a prompt to take further action such as sending a request to the events endpoint with the last known stream_position.

After the server sends this response it closes the connection. You must now repeat the long poll process to begin

Performs a check to verify that a file will be accepted by Box before you upload the entire file.

Creates an AI agent. At least one of the following capabilities must be provided: ask, text_gen, extract.

Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.

Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs. In this request, both the prompt and the output can be freeform. Metadata template setup before sending the request is not required.

Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs. For this request, you either need a metadata template or a list of fields you want to extract. Input is either a metadata template or a list of fields to ensure the structure. To learn more about creating templates, see Creating metadata templates in the Admin Console or use the metadata template API.

Sends an AI request to supported Large Language Models (LLMs) and returns generated text based on the provided prompt.

Creates a new entry in the list of allowed domains to allow collaboration for.

Exempts a user from the restrictions set out by the allowed list of domains for collaborations.

Adds a collaboration for a single user or a single group to a file or folder.

Collaborations can be created using email address, user IDs, or a group IDs.

If a collaboration is being created with a group, access to this endpoint is dependent on the group's ability to be invited.

If collaboration is in pending status, the following fields are redacted:

• login and name are hidden if a collaboration was created using user_id,
• name is hidden if a collaboration was created using login.

Adds a comment by the user to a specific file, or as a reply to an other comment.

Copies an existing file request that is already present on one folder, and applies it to another folder.

Restores a file that has been moved to the trash.

An optional new parent ID can be provided to restore the file to in case the original folder has been deleted.

Creates a copy of a file.

Adds a classification to a file by specifying the label of the classification to add.

This API can also be called by including the enterprise ID in the URL explicitly, for example /files/:id//enterprise_12345/securityClassification-6VMVochwUWo.

Applies one or more Box Skills metadata cards to a file.

Applies an instance of a metadata template to a file.

In most cases only values that are present in the metadata template will be accepted, except for the global.properties template which accepts any key-value pair.

Creates an upload session for an existing file.

Promote a specific version of a file.

If previous versions exist, this method can be used to promote one of the older versions to the top of the version history.

This creates a new copy of the old version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the the same hash digest, etag, and name as the original.

Other properties such as comments do not get updated to their former values.

Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

Creates an upload session for a new file.

Close an upload session and create a file from the uploaded chunks.

The actual endpoint URL is returned by the Create upload session and Get upload session endpoints.

Creates a folder lock on a folder, preventing it from being moved and/or deleted.

You must be authenticated as the owner or co-owner of the folder to use this endpoint.

Creates a new empty folder within the specified parent folder.

Restores a folder that has been moved to the trash.

An optional new parent ID can be provided to restore the folder to in case the original folder has been deleted.

During this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder.

For the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.

Creates a copy of a folder within a destination folder.

The original folder will not be changed.

Adds a classification to a folder by specifying the label of the classification to add.

This API can also be called by including the enterprise ID in the URL explicitly, for example /folders/:id/enterprise_12345/securityClassification-6VMVochwUWo.

Applies an instance of a metadata template to a folder.

In most cases only values that are present in the metadata template will be accepted, except for the global.properties template which accepts any key-value pair.

To display the metadata template in the Box web app the enterprise needs to be configured to enable Cascading Folder Level Metadata for the user in the admin console.

Creates a group membership. Only users with admin-level permissions will be able to use this API.

Creates a new group of users in an enterprise. Only users with admin permissions can create new groups.

Validates the roles and permissions of the group, and creates asynchronous jobs to terminate the group's sessions. Returns the status for the POST request.

Creates a Slack integration mapping by mapping a Slack channel to a Box item.

You need Admin or Co-Admin role to use this endpoint.

Creates a Teams integration mapping by mapping a Teams channel to a Box item. You need Admin or Co-Admin role to use this endpoint.

Invites an existing external user to join an enterprise.

The existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to accept the invitation within the Box web application.

This method requires the "Manage An Enterprise" scope enabled for the application, which can be enabled within the developer console.

Create a new legal hold policy.

Assign a legal hold to a file, file version, folder, or user.

Creates a new metadata cascade policy that applies a given metadata template to a given folder and automatically cascades it down to any files within that folder.

In order for the policy to be applied a metadata instance must first be applied to the folder the policy is to be applied to.

Force the metadata on a folder with a metadata cascade policy to be applied to all of its children. This can be used after creating a new cascade policy to enforce the metadata to be cascaded down to all existing files within that folder.

Create a search using SQL-like syntax to return items that match specific metadata.

By default, this endpoint returns only the most basic info about the items for which the query matches. To get additional fields for each item, including any of the metadata, use the fields attribute in the query.

Creates a new metadata template that can be applied to files and folders.

When an enterprise does not yet have any classifications, this API call initializes the classification template with an initial set of classifications.

If an enterprise already has a classification, the template will already exist and instead an API call should be made to add additional classifications.

Revoke an active Access Token, effectively logging a user out that has been previously authenticated.

Request an Access Token using either a client-side obtained OAuth 2.0 authorization code or a server-side JWT assertion.

An Access Token is a string that enables Box to verify that a request belongs to an authorized session. In the normal order of operations you will begin by requesting authentication from the authorize endpoint and Box will send you an authorization code.

You will then send this code to this endpoint to exchange it for an Access Token. The returned Access Token can then be used to to make Box API calls.

Refresh an Access Token using its client ID, secret, and refresh token.

Creates a retention policy.

Assigns a retention policy to an item.

Creates a shield information barrier report for a given barrier.

Creates a new shield information barrier segment member.

Creates a shield information barrier segment restriction object.

Creates a shield information barrier segment.

Creates a shield information barrier to separate individuals/groups within the same firm and prevents confidential information passing between them.

Change status of shield information barrier with the specified ID.

Creates a signature request. This involves preparing a document for signing and sending the signature request to signers.

Cancels a sign request.

Resends a signature request email to all outstanding signers.

Creates a storage policy assignment for an enterprise or user.

Assigns a task to a user.

A task can be assigned to more than one user by creating multiple assignments.

Creates a single task on a file. This task is not assigned to any user and will need to be assigned separately.

Sets the status for a terms of service for a user.

Creates a terms of service for a given enterprise and type of user.

Creates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Adds or updates a user avatar.

Adds a new email alias to a user account..

Validates the roles and permissions of the user, and creates asynchronous jobs to terminate the user's sessions. Returns the status for the POST request.

Creates a web link object within a folder.

Restores a web link that has been moved to the trash.

An optional new parent ID can be provided to restore the web link to in case the original folder has been deleted.

Creates a webhook.

Initiates a flow with a trigger type of WORKFLOW_MANUAL_START.

You application must be authorized to use the Manage Box Relay application scope within the developer console.

Creates a request to download multiple files and folders as a single zip archive file. This API does not return the archive but instead performs all the checks to ensure that the user has access to all the items, and then returns a download_url and a status_url that can be used to download the archive.

The limit for an archive is either the Account's upload limit or 10,000 files, whichever is met first.

Note: Downloading a large file can be affected by various factors such as distance, network latency, bandwidth, and congestion, as well as packet loss ratio and current server load. For these reasons we recommend that a maximum ZIP archive total size does not exceed 25GB.

Updates an AI agent.

Updates a collaboration. Can be used to change the owner of an item, or to accept collaboration invites.

Update the message of a comment.

Updates a file request. This can be used to activate or deactivate a file request.

Updates a file. This can be used to rename or move a file, create a shared link, or lock a file.

Adds a shared link to a file.

Updates a classification on a file.

The classification can only be updated if a classification has already been applied to the file before. When editing classifications, only values are defined for the enterprise will be accepted.

Updates one or more Box Skills metadata cards to a file.

Updates a piece of metadata on a file.

The metadata instance can only be updated if the template has already been applied to the file before. When editing metadata, only values that match the metadata template schema will be accepted.

The update is applied atomically. If any errors occur during the application of the operations, the metadata instance will not be changed.

Removes a shared link from a file.

Updates a shared link on a file.

Restores a specific version of a file after it was deleted. Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

Applies or update a watermark on a file.

Uploads a chunk of a file for an upload session.

The actual endpoint URL is returned by the Create upload session and Get upload session endpoints.

Updates a folder. This can be also be used to move the folder, create shared links, update collaborations, and more.

Adds a shared link to a folder.

Updates a classification on a folder.

The classification can only be updated if a classification has already been applied to the folder before. When editing classifications, only values are defined for the enterprise will be accepted.

Updates a piece of metadata on a folder.

The metadata instance can only be updated if the template has already been applied to the folder before. When editing metadata, only values that match the metadata template schema will be accepted.

The update is applied atomically. If any errors occur during the application of the operations, the metadata instance will not be changed.

Removes a shared link from a folder.

Updates a shared link on a folder.

Applies or update a watermark on a folder.

Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.

Updates a Slack integration mapping. Supports updating the Box folder ID and options.

You need Admin or Co-Admin role to use this endpoint.

Updates a Teams integration mapping. Supports updating the Box folder ID and options. You need Admin or Co-Admin role to use this endpoint.

Update legal hold policy.

Adds one or more new classifications to the list of classifications available to the enterprise.

This API can also be called by including the enterprise ID in the URL explicitly, for example /metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema.

Updates the labels and descriptions of one or more classifications available to the enterprise.

This API can also be called by including the enterprise ID in the URL explicitly, for example /metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema.

Updates a metadata template.

The metadata template can only be updated if the template already exists.

The update is applied atomically. If any errors occur during the application of the operations, the metadata template will not be changed.

Updates a retention policy.

Updates the shield information barrier segment based on provided ID..

An alternative method that can be used to overwrite and update all Box Skill metadata cards on a file.

Updates a specific storage policy assignment.

Updates a task assignment. This endpoint can be used to update the state of a task assigned to a user.

Updates a task. This can be used to update a task's configuration, or to update its completion state.

Updates the status for a terms of service for a user.

Updates a specific terms of service.

Updates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Move all of the items (files, folders and workflows) owned by a user into another user's account

Only the root folder (0) can be transferred.

Folders can only be moved across users by users with administrative permissions.

All existing shared links and folder-level collaborations are transferred during the operation. Please note that while collaborations at the individual file-level are transferred during the operation, the collaborations are deleted when the original user is deleted.

If the user has a large number of items across all folders, the call will be run asynchronously. If the operation is not completed within 10 minutes, the user will receive a 200 OK response, and the operation will continue running.

If the destination path has a metadata cascade policy attached to any of the parent folders, a metadata cascade operation will be kicked off asynchronously.

There is currently no way to check fo

Updates a web link object.

Adds a shared link to a web link.

Removes a shared link from a web link.

Updates a shared link on a web link.

Updates a webhook.

Upload a file to Box

Upload a new version of an existing file to Box