Box

box

Box is a cloud content management platform for secure file storage, sharing, collaboration, and governance.

File Management & Storage Documents Web del proveedor

Acciones

273

Triggers

Autenticación

—

OAuth gestionado

Sí

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (273)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add classification to fileBOX_ADD_CLASSIFICATION_TO_FILEAcción

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`.

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
Box__Security__Classification__Keystring
The name of the classification to apply to this file. To list the available classifications in an enterprise, use the classification API to retrieve the [classification template](e://get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema) which lists all available classification keys.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add classification to folderBOX_ADD_CLASSIFICATION_TO_FOLDERAcción

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`.

Parámetros de entrada

folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.
Box__Security__Classification__Keystring
The name of the classification to apply to this folder. To list the available classifications in an enterprise, use the classification API to retrieve the [classification template](e://get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema) which lists all available classification keys.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add domain to list of allowed collaboration domainsBOX_ADD_DOMAIN_TO_LIST_OF_ALLOWED_COLLABORATION_DOMAINSAcción

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

Parámetros de entrada

domainstringObligatorio
The domain to add to the list of allowed domains.
directionstringObligatorioenum
The direction in which to allow collaborations.
bothinboundoutbound

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add initial classificationsBOX_ADD_INITIAL_CLASSIFICATIONSAcción

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.

Parámetros de entrada

scopestringObligatorioenum
The scope in which to create the classifications. This should be `enterprise` or `enterprise_{id}` where `id` is the unique ID of the enterprise.
enterprise
fieldsobject[]Obligatorio
The classification template requires exactly one field, which holds all the valid classification values.
hiddenboolean
Determines if the classification template is hidden or available on web and mobile devices.
displayNamestringObligatorioenum
The name of the template as shown in web and mobile interfaces.
Classification
templateKeystringObligatorioenum
Defines the list of metadata templates.
securityClassification-6VMVochwUWo
copyInstanceOnItemCopyboolean
Determines if classifications are copied along when the file or folder is copied.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add or update user avatarBOX_ADD_OR_UPDATE_USER_AVATARAcción

Adds or updates a user avatar.

Parámetros de entrada

picobjectbinary
Pic
user_idstringObligatorio
The ID of the user.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add shared link to fileBOX_ADD_SHARED_LINK_TO_FILEAcción

Adds a shared link to a file.

Parámetros de entrada

fieldsstringObligatorio
Explicitly request the `shared_link` fields to be returned for this item.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
shared__link__accessstringenum
The level of access for the shared link. This can be restricted to anyone with the link (`open`), only people within the company (`company`) and only those who have been invited to the file (`collaborators`). If not set, this field defaults to the access level specified by the enterprise admin. To create a shared link with this default setting pass the `shared_link` object with no `access` field, for example `{ "shared_link": {} }`. The `company` access level is only available to paid accounts.
collaboratorscompanyopen
shared__link__passwordstring
The password required to access the shared link. Set the password to `null` to remove it. Passwords must now be at least eight characters long and include a number, upper case letter, or a non-numeric or non-alphabetic character. A password can only be set when `access` is set to `open`.
shared__link__unshared__atstringdate-time
The timestamp at which this shared link will expire. This field can only be set by users with paid accounts. The value must be greater than the current date and time.
shared__link__vanity__namestring
Defines a custom vanity name to use in the shared link URL, for example `https://app.box.com/v/my-shared-link`. Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
shared__link__permissions__can__editboolean
If the shared link allows for editing of files. This can only be set when `access` is set to `open` or `company`. This value can only be `true` is `can_download` is also `true`.
shared__link__permissions__can__previewboolean
If the shared link allows for previewing of files. This value is always `true`. For shared links on folders this also applies to any items in the folder.
shared__link__permissions__can__downloadboolean
If the shared link allows for downloading of files. This can only be set when `access` is set to `open` or `company`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add shared link to folderBOX_ADD_SHARED_LINK_TO_FOLDERAcción

Adds a shared link to a folder.

Parámetros de entrada

fieldsstringObligatorio
Explicitly request the `shared_link` fields to be returned for this item.
folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.
shared__link__accessstringenum
The level of access for the shared link. This can be restricted to anyone with the link (`open`), only people within the company (`company`) and only those who have been invited to the folder (`collaborators`). If not set, this field defaults to the access level specified by the enterprise admin. To create a shared link with this default setting pass the `shared_link` object with no `access` field, for example `{ "shared_link": {} }`. The `company` access level is only available to paid accounts.
collaboratorscompanyopen
shared__link__passwordstring
The password required to access the shared link. Set the password to `null` to remove it. Passwords must now be at least eight characters long and include a number, upper case letter, or a non-numeric or non-alphabetic character. A password can only be set when `access` is set to `open`.
shared__link__unshared__atstringdate-time
The timestamp at which this shared link will expire. This field can only be set by users with paid accounts. The value must be greater than the current date and time.
shared__link__vanity__namestring
Defines a custom vanity name to use in the shared link URL, for example `https://app.box.com/v/my-shared-link`. Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
shared__link__permissions__can__editboolean
This value can only be `false` for items with a `type` of `folder`.
shared__link__permissions__can__previewboolean
If the shared link allows for previewing of files. This value is always `true`. For shared links on folders this also applies to any items in the folder.
shared__link__permissions__can__downloadboolean
If the shared link allows for downloading of files. This can only be set when `access` is set to `open` or `company`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add shared link to web linkBOX_ADD_SHARED_LINK_TO_WEB_LINKAcción

Adds a shared link to a web link.

Parámetros de entrada

fieldsstringObligatorio
Explicitly request the `shared_link` fields to be returned for this item.
web_link_idstringObligatorio
The ID of the web link.
shared__link__accessstringenum
The level of access for the shared link. This can be restricted to anyone with the link (`open`), only people within the company (`company`) and only those who have been invited to the file (`collaborators`). If not set, this field defaults to the access level specified by the enterprise admin. To create a shared link with this default setting pass the `shared_link` object with no `access` field, for example `{ "shared_link": {} }`. The `company` access level is only available to paid accounts.
collaboratorscompanyopen
shared__link__passwordstring
The password required to access the shared link. Set the password to `null` to remove it. Passwords must now be at least eight characters long and include a number, upper case letter, or a non-numeric or non-alphabetic character. A password can only be set when `access` is set to `open`.
shared__link__unshared__atstringdate-time
The timestamp at which this shared link will expire. This field can only be set by users with paid accounts. The value must be greater than the current date and time.
shared__link__vanity__namestring
Defines a custom vanity name to use in the shared link URL, for example `https://app.box.com/v/my-shared-link`. Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
shared__link__permissions__can__editboolean
This value can only be `true` is `type` is `file`.
shared__link__permissions__can__previewboolean
If the shared link allows for previewing of files. This value is always `true`. For shared links on folders this also applies to any items in the folder.
shared__link__permissions__can__downloadboolean
If the shared link allows for downloading of files. This can only be set when `access` is set to `open` or `company`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add user to groupBOX_ADD_USER_TO_GROUPAcción

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

Parámetros de entrada

rolestringenum
The role of the user in the group.
adminmember
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
user__idstring
The ID of the user to add to the group
group__idstring
The ID of the group to add the user to
configurable_permissionsobject
Custom configuration for the permissions an admin if a group will receive. This option has no effect on members with a role of `member`. Setting these permissions overwrites the default access levels of an admin. Specifying a value of `null` for this object will disable all configurable permissions. Specifying permissions will set them accordingly, omitted permissions will be enabled by default.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Apply watermark to fileBOX_APPLY_WATERMARK_TO_FILEAcción

Applies or update a watermark on a file.

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
watermark__imprintstringenum
The type of watermark to apply. Currently only supports one option.
default

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Apply watermark to folderBOX_APPLY_WATERMARK_TO_FOLDERAcción

Applies or update a watermark on a folder.

Parámetros de entrada

folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.
watermark__imprintstringenum
The type of watermark to apply. Currently only supports one option.
default

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Ask questionBOX_ASK_QUESTIONAcción

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

Parámetros de entrada

modestringObligatorioenum
Box AI handles text documents with text representations up to 1MB in size, or a maximum of 25 files, whichever comes first. If the text file size exceeds 1MB, the first 1MB of text representation will be processed. Box AI handles image documents with a resolution of 1024 x 1024 pixels, with a maximum of 5 images or 5 pages for multi-page images. If the number of image or image pages exceeds 5, the first 5 images or pages will be processed. If you set mode parameter to `single_item_qa`, the items array can have one element only. Currently Box AI does not support multi-modal requests. If both images and text are sent Box AI will only process the text.
multiple_item_qasingle_item_qa
itemsobject[]Obligatorio
The items to be processed by the LLM, often files.
promptstringObligatorio
The prompt provided by the client to be answered by the LLM. The prompt"s length is limited to 10000 characters.
dialogue_historyobject[]
The history of prompts and answers previously passed to the LLM. This provides additional context to the LLM in generating the response.
include_citationsboolean
A flag to indicate whether citations should be returned.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Assign legal hold policyBOX_ASSIGN_LEGAL_HOLD_POLICYAcción

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

Parámetros de entrada

policy_idstringObligatorio
The ID of the policy to assign.
assign__to__idstring
The ID of item to assign the policy to
assign__to__typestringenum
The type of item to assign the policy to
filefile_versionfolderuser

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Assign retention policyBOX_ASSIGN_RETENTION_POLICYAcción

Assigns a retention policy to an item.

Parámetros de entrada

policy_idstringObligatorio
The ID of the retention policy to assign
filter_fieldsobject[]
If the `assign_to` type is `metadata_template`, then optionally add the `filter_fields` parameter which will require an array of objects with a field entry and a value entry. Currently only one object of `field` and `value` is supported.
assign__to__idstring
The ID of item to assign the policy to. Set to `null` or omit when `type` is set to `enterprise`.
assign__to__typestringenum
The type of item to assign the policy to.
enterprisefoldermetadata_template
start_date_fieldstring
The date the retention policy assignment begins. If the `assigned_to` type is `metadata_template`, this field can be a date field"s metadata attribute key id.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Assign storage policyBOX_ASSIGN_STORAGE_POLICYAcción

Creates a storage policy assignment for an enterprise or user.

Parámetros de entrada

assigned__to__idstring
The ID of the user or enterprise
assigned__to__typestringenum
The type to assign the policy to.
enterpriseuser
storage__policy__idstring
The ID of the storage policy to assign.
storage__policy__typestringenum
The type to assign.
storage_policy

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Assign taskBOX_ASSIGN_TASKAcción

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

Parámetros de entrada

task__idstring
The ID of the task
task__typestringenum
The type of the item to assign.
task
assign__to__idstring
The ID of the user to assign to the task. To specify a user by their email address use the `login` parameter.
assign__to__loginstring
The email address of the user to assign to the task. To specify a user by their user ID please use the `id` parameter.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Authorize userBOX_AUTHORIZE_USERAcción

Authorize a user by sending them through the [box](https://box.com) 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.

Parámetros de entrada

scopestring
A space-separated list of application scopes you"d like to authenticate the user for. This defaults to all the scopes configured for the application in its configuration page.
statestring
A custom string of your choice. Box will pass the same string to the redirect URL when authentication is complete. This parameter can be used to identify a user on redirect, as well as protect against hijacked sessions and other exploits.
client_idstringObligatorio
The Client ID of the application that is requesting to authenticate the user. To get the Client ID for your application, log in to your Box developer console and click the **Edit Application** link for the application you"re working with. In the OAuth 2.0 Parameters section of the configuration page, find the item labelled `client_id`. The text of that item is your application"s Client ID.
redirect_uristring
The URI to which Box redirects the browser after the user has granted or denied the application permission. This URI match one of the redirect URIs in the configuration of your application. It must be a valid HTTPS URI and it needs to be able to handle the redirection to complete the next step in the OAuth 2.0 flow. Although this parameter is optional, it must be a part of the authorization URL if you configured multiple redirect URIs for the application in the developer console. A missing parameter causes a `redirect_uri_missing` error after the user grants application access.
response_typestringObligatorioenum
The type of response we"d like to receive.
code

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Cancel box sign requestBOX_CANCEL_BOX_SIGN_REQUESTAcción

Cancels a sign request.

Parámetros de entrada

sign_request_idstringObligatorio
The ID of the signature request

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Change shield information barrier statusBOX_CHANGE_SHIELD_INFORMATION_BARRIER_STATUSAcción

Change status of shield information barrier with the specified id.

Parámetros de entrada

idstringObligatorio
The ID of the shield information barrier.
statusstringObligatorioenum
The desired status for the shield information barrier.
disabledpending

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Commit upload sessionBOX_COMMIT_UPLOAD_SESSIONAcción

Close an upload session and create a file from the uploaded chunks. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) and [`get upload session`](e://get-files-upload-sessions-id) endpoints.

Parámetros de entrada

partsarrayObligatorio
The list details for the uploaded parts
upload_session_idstringObligatorio
The ID of the upload session.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Copy fileBOX_COPY_FILEAcción

Creates a copy of a file.

Parámetros de entrada

namestring
An optional new name for the copied file. There are some restrictions to the file name. Names containing non-printable ASCII characters, forward and backward slashes (`/`, ``), and protected names like `.` and `..` are automatically sanitized by removing the non-allowed characters.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
versionstring
An optional ID of the specific file version to copy.
parent__idstring
The ID of folder to copy the file to.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Copy file requestBOX_COPY_FILE_REQUESTAcción

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

Parámetros de entrada

file_request_idstringObligatorio
The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Copy folderBOX_COPY_FOLDERAcción

Creates a copy of a folder within a destination folder. the original folder will not be changed.

Parámetros de entrada

namestring
An optional new name for the copied folder. There are some restrictions to the file name. Names containing non-printable ASCII characters, forward and backward slashes (`/`, ``), as well as names with trailing spaces are prohibited. Additionally, the names `.` and `..` are not allowed either.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
folder_idstringObligatorio
The unique identifier of the folder to copy. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder with the ID `0` can not be copied.
parent__idstring
The ID of parent folder

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ai agentBOX_CREATE_AI_AGENTAcción

Creates an ai agent. at least one of the following capabilities must be provided: `ask`, `text gen`, `extract`.

Parámetros de entrada

namestringObligatorio
The name of the AI Agent.
typestringObligatorioenum
The type of agent used to handle queries.
ai_agent
ask__typestringenum
The type of AI agent used to handle queries.
ai_agent_ask
access_statestringObligatorio
The state of the AI Agent. Possible values are: `enabled`, `disabled`, and `enabled_for_selected_users`.
extract__typestringenum
The type of AI agent to be used for extraction.
ai_agent_extract
icon_referencestring
The icon reference of the AI Agent. It should have format of the URL `https://cdn01.boxcdn.net/app-assets/aistudio/avatars/<file_name>` where possible values of `file_name` are: `logo_boxAi.png`,`logo_stamp.png`,`logo_legal.png`,`logo_finance.png`,`logo_config.png`,`logo_handshake.png`,`logo_analytics.png`,`logo_classification.png`
text__gen__typestringenum
The type of AI agent used for generating text.
ai_agent_text_gen
allowed_entitiesobject[]
List of allowed users or groups.
ask__descriptionstring
The description of the AI Agent.
ask__access__statestring
The state of the AI Agent capability. Possible values are: `enabled` and `disabled`.
extract__descriptionstring
The description of the AI Agent.
extract__access__statestring
The state of the AI Agent capability. Possible values are: `enabled` and `disabled`.
text__gen__descriptionstring
The description of the AI Agent.
text__gen__access__statestring
The state of the AI Agent capability. Possible values are: `enabled` and `disabled`.
ask__custom__instructionsstring
Custom instructions for the agent.
extract__custom__instructionsstring
Custom instructions for the agent.
text__gen__custom__instructionsstring
Custom instructions for the agent.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create box sign requestBOX_CREATE_BOX_SIGN_REQUESTAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create box skill cards on fileBOX_CREATE_BOX_SKILL_CARDS_ON_FILEAcción

Applies one or more box skills metadata cards to a file.

Parámetros de entrada

cardsobject[]Obligatorio
A list of Box Skill cards to apply to this file.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create collaborationBOX_CREATE_COLLABORATIONAcción

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`.

Parámetros de entrada

rolestringObligatorioenum
The level of access granted.
co-ownereditorpreviewerpreviewer uploaderuploaderviewerviewer uploader
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
notifyboolean
Determines if users should receive email notification for the action performed.
item__idstring
The ID of the item that will be granted access to
expires_atstringdate-time
Set the expiration date for the collaboration. At this date, the collaboration will be automatically removed from the item. This feature will only work if the **Automatically remove invited collaborators: Allow folder owners to extend the expiry date** setting has been enabled in the **Enterprise Settings** of the **Admin Console**. When the setting is not enabled, collaborations can not have an expiry date and a value for this field will be result in an error.
item__typestringenum
The type of the item that this collaboration will be granted access to
filefolder
can_view_pathboolean
Determines if the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore can not see content the user is not collaborated on. Be aware that this meaningfully increases the time required to load the invitee"s **All Files** page. We recommend you limit the number of collaborations with `can_view_path` enabled to 1,000 per user. Only owner or co-owners can invite collaborators with a `can_view_path` of `true`. `can_view_path` can only be used for folder collaborations.
is_access_onlyboolean
If set to `true`, collaborators have access to shared items, but such items won"t be visible in the All Files list. Additionally, collaborators won"t see the the path to the root folder for the shared item.
accessible__by__idstring
The ID of the user or group. Alternatively, use `login` to specify a user by email address.
accessible__by__typestringenum
The type of collaborator to invite.
groupuser
accessible__by__loginstring
The email address of the user to grant access to the item. Alternatively, use `id` to specify a user by user ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create commentBOX_CREATE_COMMENTAcción

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

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
messagestringObligatorio
The text of the comment. To mention a user, use the `tagged_message` parameter instead.
item__idstring
The ID of the item
item__typestringenum
The type of the item that this comment will be placed on.
commentfile
tagged_messagestring
The text of the comment, including `@[user_id:name]` somewhere in the message to mention another user, which will send them an email notification, letting them know they have been mentioned. The `user_id` is the target user"s ID, where the `name` can be any custom phrase. In the Box UI this name will link to the user"s profile. If you are not mentioning another user, use `message` instead.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create email aliasBOX_CREATE_EMAIL_ALIASAcción

Adds a new email alias to a user account..

Parámetros de entrada

emailstringObligatorio
The email address to add to the account as an alias. Note: The domain of the email alias needs to be registered to your enterprise. See the [domain verification guide]( https://support.box.com/hc/en-us/articles/4408619650579-Domain-Verification ) for steps to add a new domain.
user_idstringObligatorio
The ID of the user.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create folderBOX_CREATE_FOLDERAcción

Creates a new empty folder within the specified parent folder.

Parámetros de entrada

namestringObligatorio
The name for the new folder. There are some restrictions to the file name. Names containing non-printable ASCII characters, forward and backward slashes (`/`, ``), as well as names with trailing spaces are prohibited. Additionally, the names `.` and `..` are not allowed either.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
parent__idstring
The ID of parent folder
sync_statestringenum
Specifies whether a folder should be synced to a user"s device or not. This is used by Box Sync (discontinued) and is not used by Box Drive.
not_syncedpartially_syncedsynced

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create folder lockBOX_CREATE_FOLDER_LOCKAcción

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.

Parámetros de entrada

folder__idstring
The ID of the folder.
folder__typestring
The content type the lock is being applied to. Only `folder` is supported.
locked__operations__moveboolean
Whether moving the folder should be locked.
locked__operations__deleteboolean
Whether deleting the folder should be locked.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create groupBOX_CREATE_GROUPAcción

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

Parámetros de entrada

namestringObligatorio
The name of the new group to be created. This name must be unique within the enterprise.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
provenancestring
Keeps track of which external source this group is coming, for example `Active Directory`, or `Okta`. Setting this will also prevent Box admins from editing the group name and its members directly via the Box web application. This is desirable for one-way syncing of groups.
descriptionstring
A human readable description of the group.
invitability_levelstringenum
Specifies who can invite the group to collaborate on folders. When set to `admins_only` the enterprise admin, co-admins, and the group"s admin can invite the group. When set to `admins_and_members` all the admins listed above and group members can invite the group. When set to `all_managed_users` all managed users in the enterprise can invite the group.
admins_and_membersadmins_onlyall_managed_users
external_sync_identifierstring
An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group. Example values of this field could be an **Active Directory Object ID** or a **Google Group ID**. We recommend you use of this field in order to avoid issues when group names are updated in either Box or external systems.
member_viewability_levelstringenum
Specifies who can see the members of the group. * `admins_only` - the enterprise admin, co-admins, group"s group admin * `admins_and_members` - all admins and group members * `all_managed_users` - all managed users in the enterprise
admins_and_membersadmins_onlyall_managed_users

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create jobs to terminate user group sessionBOX_CREATE_JOBS_TO_TERMINATE_USER_GROUP_SESSIONAcción

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.

Parámetros de entrada

group_idsstring[]Obligatorio
A list of group IDs

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create jobs to terminate users sessionBOX_CREATE_JOBS_TO_TERMINATE_USERS_SESSIONAcción

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.

Parámetros de entrada

user_idsstring[]Obligatorio
A list of user IDs
user_loginsstring[]Obligatorio
A list of user logins

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create legal hold policyBOX_CREATE_LEGAL_HOLD_POLICYAcción

Create a new legal hold policy.

Parámetros de entrada

is_ongoingboolean
Whether new assignments under this policy should continue applying to files even after initialization. When this policy is applied using a legal hold assignment, it will continue applying the policy to any new file versions even after it has been applied. For example, if a legal hold assignment is placed on a user today, and that user uploads a file tomorrow, that file will get held. This will continue until the policy is retired. Required if no filter dates are set.
descriptionstring
A description for the policy.
policy_namestringObligatorio
The name of the policy.
filter_ended_atstringdate-time
The filter end date. When this policy is applied using a `custodian` legal hold assignments, it will only apply to file versions created or uploaded inside of the date range. Other assignment types, such as folders and files, will ignore the date filter. Required if `is_ongoing` is set to `false`.
filter_started_atstringdate-time
The filter start date. When this policy is applied using a `custodian` legal hold assignments, it will only apply to file versions created or uploaded inside of the date range. Other assignment types, such as folders and files, will ignore the date filter. Required if `is_ongoing` is set to `false`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create metadata cascade policyBOX_CREATE_METADATA_CASCADE_POLICYAcción

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.

Parámetros de entrada

scopestringObligatorioenum
The scope of the targeted metadata template. This template will need to already have an instance applied to the targeted folder.
enterpriseglobal
folder_idstringObligatorio
The ID of the folder to apply the policy to. This folder will need to already have an instance of the targeted metadata template applied to it.
templateKeystringObligatorio
The key of the targeted metadata template. This template will need to already have an instance applied to the targeted folder. In many cases the template key is automatically derived of its display name, for example `Contract Template` would become `contractTemplate`. In some cases the creator of the template will have provided its own template key. Please [list the templates for an enterprise][list], or get all instances on a [file][file] or [folder][folder] to inspect a template"s key. [list]: e://get-metadata-templates-enterprise [file]: e://get-files-id-metadata [folder]: e://get-folders-id-metadata

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create metadata instance on fileBOX_CREATE_METADATA_INSTANCE_ON_FILEAcción

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.

Parámetros de entrada

scopestringObligatorioenum
The scope of the metadata template
enterpriseglobal
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
template_keystringObligatorio
The name of the metadata template

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create metadata instance on folderBOX_CREATE_METADATA_INSTANCE_ON_FOLDERAcción

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.

Parámetros de entrada

scopestringObligatorioenum
The scope of the metadata template
enterpriseglobal
folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.
template_keystringObligatorio
The name of the metadata template

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create metadata templateBOX_CREATE_METADATA_TEMPLATEAcción

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

Parámetros de entrada

scopestringObligatorio
The scope of the metadata template to create. Applications can only create templates for use within the authenticated user"s enterprise. This value needs to be set to `enterprise`, as `global` scopes can not be created by applications.
fieldsobject[]
An ordered list of template fields which are part of the template. Each field can be a regular text field, date field, number field, as well as a single or multi-select list.
hiddenboolean
Defines if this template is visible in the Box web app UI, or if it is purely intended for usage through the API.
displayNamestringObligatorio
The display name of the template.
templateKeystring
A unique identifier for the template. This identifier needs to be unique across the enterprise for which the metadata template is being created. When not provided, the API will create a unique `templateKey` based on the value of the `displayName`.
copyInstanceOnItemCopyboolean
Whether or not to copy any metadata attached to a file or folder when it is copied. By default, metadata is not copied along with a file or folder when it is copied.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create retention policyBOX_CREATE_RETENTION_POLICYAcción

Creates a retention policy.

Parámetros de entrada

descriptionstring
The additional text description of the retention policy.
policy_namestringObligatorio
The name for the retention policy
policy_typestringObligatorioenum
The type of the retention policy. A retention policy type can either be `finite`, where a specific amount of time to retain the content is known upfront, or `indefinite`, where the amount of time to retain the content is still unknown.
finiteindefinite
retention_typestringenum
Specifies the retention type: * `modifiable`: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes. * `non_modifiable`: You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies.
modifiablenon_modifiable
retention_lengthstringint32
The length of the retention policy. This value specifies the duration in days that the retention policy will be active for after being assigned to content. If the policy has a `policy_type` of `indefinite`, the `retention_length` will also be `indefinite`.
disposition_actionstringObligatorioenum
The disposition action of the retention policy. `permanently_delete` deletes the content retained by the policy permanently. `remove_retention` lifts retention policy from the content, allowing it to be deleted by users once the retention policy has expired.
permanently_deleteremove_retention
are_owners_notifiedboolean
Whether owner and co-owners of a file are notified when the policy nears expiration.
can_owner_extend_retentionboolean
Whether the owner of a file will be allowed to extend the retention.
custom_notification_recipientsarray
A list of users notified when the retention policy duration is about to end.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create shield information barrierBOX_CREATE_SHIELD_INFORMATION_BARRIERAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create shield information barrier reportBOX_CREATE_SHIELD_INFORMATION_BARRIER_REPORTAcción

Creates a shield information barrier report for a given barrier.

Parámetros de entrada

shield__information__barrier__idstring
The unique identifier for the shield information barrier
shield__information__barrier__typestringenum
The type of the shield information barrier
shield_information_barrier

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create shield information barrier segmentBOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENTAcción

Creates a shield information barrier segment.

Parámetros de entrada

namestringObligatorio
Name of the shield information barrier segment
descriptionstring
Description of the shield information barrier segment
shield__information__barrier__idstring
The unique identifier for the shield information barrier
shield__information__barrier__typestringenum
The type of the shield information barrier
shield_information_barrier

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create shield information barrier segment memberBOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBERAcción

Creates a new shield information barrier segment member.

Parámetros de entrada

typestringenum
-| A type of the shield barrier segment member.
shield_information_barrier_segment_member
shield__information__barrier__idstring
The unique identifier for the shield information barrier
shield__information__barrier__typestringenum
The type of the shield information barrier
shield_information_barrier
shield__information__barrier__segment__idstring
The ID reference of the requesting shield information barrier segment.
shield__information__barrier__segment__typestringenum
The type of the shield barrier segment for this member.
shield_information_barrier_segment

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create shield information barrier segment restrictionBOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTIONAcción

Creates a shield information barrier segment restriction object.

Parámetros de entrada

typestringObligatorioenum
The type of the shield barrier segment restriction for this member.
shield_information_barrier_segment_restriction
restricted__segment__idstring
The ID reference of the restricted shield information barrier segment.
restricted__segment__typestringenum
The type of the restricted shield information barrier segment.
shield_information_barrier_segment
shield__information__barrier__idstring
The unique identifier for the shield information barrier
shield__information__barrier__typestringenum
The type of the shield information barrier
shield_information_barrier
shield__information__barrier__segment__idstring
The ID reference of the requesting shield information barrier segment.
shield__information__barrier__segment__typestringenum
The type of the shield barrier segment for this member.
shield_information_barrier_segment

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create slack integration mappingBOX_CREATE_SLACK_INTEGRATION_MAPPINGAcción

Creates a [slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-box-as-the-content-layer-for-slack) by mapping a slack channel to a box item. you need admin or co-admin role to use this endpoint.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create taskBOX_CREATE_TASKAcción

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

Parámetros de entrada

actionstringenum
The action the task assignee will be prompted to do. Must be * `review` defines an approval task that can be approved or rejected * `complete` defines a general task which can be completed
completereview
due_atstringdate-time
Defines when the task is due. Defaults to `null` if not provided.
messagestring
An optional message to include with the task.
item__idstring
The ID of the file
item__typestringenum
`file`
file
completion_rulestringenum
Defines which assignees need to complete this task before the task is considered completed. * `all_assignees` (default) requires all assignees to review or approve the the task in order for it to be considered completed. * `any_assignee` accepts any one assignee to review or approve the the task in order for it to be considered completed.
all_assigneesany_assignee

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create teams integration mappingBOX_CREATE_TEAMS_INTEGRATION_MAPPINGAcción

Creates a [teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-using-box-for-teams) by mapping a teams channel to a box item. you need admin or co-admin role to use this endpoint.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create terms of serviceBOX_CREATE_TERMS_OF_SERVICEAcción

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

Parámetros de entrada

textstringObligatorio
The terms of service text to display to users. The text can be set to empty if the `status` is set to `disabled`.
statusstringObligatorioenum
Whether this terms of service is active.
disabledenabled
tos_typestringenum
The type of user to set the terms of service for.
externalmanaged

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create terms of service status for new userBOX_CREATE_TERMS_OF_SERVICE_STATUS_FOR_NEW_USERAcción

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

Parámetros de entrada

tos__idstring
The ID of terms of service
user__idstring
The ID of user
tos__typestringenum
The type of object.
terms_of_service
user__typestringenum
The type of object.
user
is_acceptedbooleanObligatorio
Whether the user has accepted the terms.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create upload sessionBOX_CREATE_UPLOAD_SESSIONAcción

Creates an upload session for a new file.

Parámetros de entrada

file_namestringObligatorio
The name of new file
file_sizeintegerObligatorio
The total number of bytes of the file to be uploaded
folder_idstringObligatorio
The ID of the folder to upload the new file to.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create upload session for existing fileBOX_CREATE_UPLOAD_SESSION_FOR_EXISTING_FILEAcción

Creates an upload session for an existing file.

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
file_namestring
The optional new name of new file
file_sizeintegerObligatorio
The total number of bytes of the file to be uploaded

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create userBOX_CREATE_USERAcción

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

Parámetros de entrada

namestringObligatorio
The name of the user
rolestringenum
The user’s enterprise role
coadminuser
loginstring
The email address the user uses to log in Required, unless `is_platform_access_only` is set to `true`.
phonestring
The user’s phone number
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
statusstringenum
The user"s account status
activecannot_delete_editcannot_delete_edit_uploadinactive
addressstring
The user’s address
languagestring
The language of the user, formatted in modified version of the [ISO 639-1](/guides/api-calls/language-codes) format.
timezonestringtimezone
The user"s timezone
job_titlestring
The user’s job title
space_amountinteger
The user’s total available space in bytes. Set this to `-1` to indicate unlimited storage.
tracking_codesobject[]
Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. This setting must be enabled for an enterprise before it can be used.
is_sync_enabledboolean
Whether the user can use Box Sync
external_app_user_idstring
An external identifier for an app user, which can be used to look up the user. This can be used to tie user IDs from external identity providers to Box users.
can_see_managed_usersboolean
Whether the user can see other enterprise users in their contact list
is_platform_access_onlyboolean
Specifies that the user is an app user.
is_exempt_from_device_limitsboolean
Whether to exempt the user from enterprise device limits
is_external_collab_restrictedboolean
Whether the user is allowed to collaborate with users outside their enterprise
is_exempt_from_login_verificationboolean
Whether the user must use two-factor authentication

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create user exemption from collaboration domain restrictionsBOX_CREATE_USER_EXEMPTION_FROM_COLLABORATION_DOMAIN_RESTRICTIONSAcción

Create user exemption from collaboration domain restrictions.

Parámetros de entrada

user__idstring
The ID of the user to exempt.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create user inviteBOX_CREATE_USER_INVITEAcción

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.

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
enterprise__idstring
The ID of the enterprise
actionable__by__loginstring
The login of the invited user

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create webhookBOX_CREATE_WEBHOOKAcción

Creates a webhook.

Parámetros de entrada

addressstringObligatorio
The URL that is notified by this webhook
triggersstring[]Obligatorio
An array of event names that this webhook is to be triggered for
target__idstring
The ID of the item to trigger a webhook
target__typestringenum
The type of item to trigger a webhook
filefolder

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create web linkBOX_CREATE_WEB_LINKAcción

Creates a web link object within a folder.

Parámetros de entrada

urlstringObligatorio
The URL that this web link links to. Must start with `"http://"` or `"https://"`.
namestring
Name of the web link. Defaults to the URL if not set.
parent__idstring
The ID of parent folder
descriptionstring
Description of the web link.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create zip downloadBOX_CREATE_ZIP_DOWNLOADAcción

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.

Parámetros de entrada

itemsobject[]Obligatorio
A list of items to add to the `zip` archive. These can be folders or files.
download_file_namestring
The optional name of the `zip` archive. This name will be appended by the `.zip` file extension, for example `January Financials.zip`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ai agentBOX_DELETE_AI_AGENTAcción

Deletes an ai agent using the provided parameters.

Parámetros de entrada

agent_idstringObligatorio
The ID of the agent to delete.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete fileBOX_DELETE_FILEAcción

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.

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete file requestBOX_DELETE_FILE_REQUESTAcción

Deletes a file request permanently.

Parámetros de entrada

file_request_idstringObligatorio
The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete folderBOX_DELETE_FOLDERAcción

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

Parámetros de entrada

folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.
recursiveboolean
Delete a folder that is not empty by recursively deleting the folder and all of its content.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete folder lockBOX_DELETE_FOLDER_LOCKAcción

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.

Parámetros de entrada

folder_lock_idstringObligatorio
The ID of the folder lock.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete retention policyBOX_DELETE_RETENTION_POLICYAcción

Permanently deletes a retention policy.

Parámetros de entrada

retention_policy_idstringObligatorio
The ID of the retention policy.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete shield information barrier segmentBOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENTAcción

Deletes the shield information barrier segment based on provided id.

Parámetros de entrada

shield_information_barrier_segment_idstringObligatorio
The ID of the shield information barrier segment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete shield information barrier segment member by idBOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_IDAcción

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

Parámetros de entrada

shield_information_barrier_segment_member_idstringObligatorio
The ID of the shield information barrier segment Member.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete shield information barrier segment restriction by idBOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION_BY_IDAcción

Delete shield information barrier segment restriction by id.

Parámetros de entrada

shield_information_barrier_segment_restriction_idstringObligatorio
The ID of the shield information barrier segment Restriction.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete slack integration mappingBOX_DELETE_SLACK_INTEGRATION_MAPPINGAcción

Deletes a [slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-box-as-the-content-layer-for-slack). you need admin or co-admin role to use this endpoint.

Parámetros de entrada

integration_mapping_idstringObligatorio
An ID of an integration mapping

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete teams integration mappingBOX_DELETE_TEAMS_INTEGRATION_MAPPINGAcción

Deletes a [teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-using-box-for-teams). you need admin or co-admin role to use this endpoint.

Parámetros de entrada

integration_mapping_idstringObligatorio
An ID of an integration mapping

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete userBOX_DELETE_USERAcción

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.

Parámetros de entrada

forceboolean
Whether the user should be deleted even if this user still own files
notifyboolean
Whether the user will receive email notification of the deletion
user_idstringObligatorio
The ID of the user.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete user avatarBOX_DELETE_USER_AVATARAcción

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

Parámetros de entrada

user_idstringObligatorio
The ID of the user.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Download fileBOX_DOWNLOAD_FILEAcción

Returns the contents of a file in binary format.

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
versionstring
The file version to download
access_tokenstring
An optional access token that can be used to pre-authenticate this request, which means that a download link can be shared with a browser or a third party service without them needing to know how to handle the authentication. When using this parameter, please make sure that the access token is sufficiently scoped down to only allow read access to that file and no other files or folders.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Download zip archiveBOX_DOWNLOAD_ZIP_ARCHIVEAcción

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](e://post zip downloads) api to request to create a `zip` archive, and then follow the `download url` field in the response to this endpoint.

Parámetros de entrada

zip_download_idstringObligatorio
The unique identifier that represent this `zip` archive.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Extract metadata freeformBOX_EXTRACT_METADATA_FREEFORMAcción

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.

Parámetros de entrada

itemsobject[]Obligatorio
The items that LLM will process. Currently, you can use files only.
promptstringObligatorio
The prompt provided to a Large Language Model (LLM) in the request. The prompt can be up to 10000 characters long and it can be an XML or a JSON schema.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Extract metadata structuredBOX_EXTRACT_METADATA_STRUCTUREDAcción

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](https://support.box.com/hc/en-us/articles/360044194033-customizing-metadata-templates) or use the [metadata template api](g://metadata/templates/create).

Parámetros de entrada

itemsobject[]Obligatorio
The items to be processed by the LLM. Currently you can use files only.
fieldsobject[]
The fields to be extracted from the provided items. For your request to work, you must provide either `metadata_template` or `fields`, but not both.
metadata__template__typestringenum
Value is always `metadata_template`.
metadata_template
metadata__template__scopestring
The scope of the metadata template that can either be global or enterprise. * The **global** scope is used for templates that are available to any Box enterprise. * The **enterprise** scope represents templates created within a specific enterprise, containing the ID of that enterprise.
metadata__template__template__keystring
The name of the metadata template.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Find app item for shared linkBOX_FIND_APP_ITEM_FOR_SHARED_LINKAcción

Returns the app item represented by a shared link. the link can originate from the current enterprise or another.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Find file for shared linkBOX_FIND_FILE_FOR_SHARED_LINKAcción

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.

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Find folder for shared linkBOX_FIND_FOLDER_FOR_SHARED_LINKAcción

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.

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Find metadata template by instance idBOX_FIND_METADATA_TEMPLATE_BY_INSTANCE_IDAcción

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

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
metadata_instance_idstringObligatorio
The ID of an instance of the metadata template to find.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Find web link for shared linkBOX_FIND_WEB_LINK_FOR_SHARED_LINKAcción

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.

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Force apply metadata cascade policy to folderBOX_FORCE_APPLY_METADATA_CASCADE_POLICY_TO_FOLDERAcción

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.

Parámetros de entrada

conflict_resolutionstringObligatorioenum
Describes the desired behavior when dealing with the conflict where a metadata template already has an instance applied to a child. * `none` will preserve the existing value on the file * `overwrite` will force-apply the templates values over any existing values.
noneoverwrite
metadata_cascade_policy_idstringObligatorio
The ID of the cascade policy to force-apply.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate textBOX_GENERATE_TEXTAcción

Sends an ai request to supported large language models (llms) and returns generated text based on the provided prompt.

Parámetros de entrada

itemsobject[]Obligatorio
The items to be processed by the LLM, often files. The array can include **exactly one** element. **Note**: Box AI handles documents with text representations up to 1MB in size. If the file size exceeds 1MB, the first 1MB of text representation will be processed.
promptstringObligatorio
The prompt provided by the client to be answered by the LLM. The prompt"s length is limited to 10000 characters.
dialogue_historyobject[]
The history of prompts and answers previously passed to the LLM. This parameter provides the additional context to the LLM when generating the response.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ai agent by agent idBOX_GET_AI_AGENT_BY_AGENT_IDAcción

Gets an ai agent using the `agent id` parameter.

Parámetros de entrada

fieldsstring[]
The fields to return in the response.
agent_idstringObligatorio
The agent id to get.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ai agent default configurationBOX_GET_AI_AGENT_DEFAULT_CONFIGURATIONAcción

Get the ai agent default config

Parámetros de entrada

modestringObligatorioenum
The mode to filter the agent config to return.
askextractextract_structuredtext_gen
modelstring
The model to return the default agent config for.
languagestring
The ISO language code to return the agent config for. If the language is not supported the default agent config is returned.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get allowed collaboration domainBOX_GET_ALLOWED_COLLABORATION_DOMAINAcción

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

Parámetros de entrada

collaboration_whitelist_entry_idstringObligatorio
The ID of the entry in the list.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get box sign request by idBOX_GET_BOX_SIGN_REQUEST_BY_IDAcción

Gets a sign request by id.

Parámetros de entrada

sign_request_idstringObligatorio
The ID of the signature request

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get box sign template by idBOX_GET_BOX_SIGN_TEMPLATE_BY_IDAcción

Fetches details of a specific box sign template.

Parámetros de entrada

template_idstringObligatorio
The ID of a Box Sign template.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get classification on fileBOX_GET_CLASSIFICATION_ON_FILEAcción

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`.

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get classification on folderBOX_GET_CLASSIFICATION_ON_FOLDERAcción

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`.

Parámetros de entrada

folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get collaborationBOX_GET_COLLABORATIONAcción

Retrieves a single collaboration.

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
collaboration_idstringObligatorio
The ID of the collaboration

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get collection by idBOX_GET_COLLECTION_BY_IDAcción

Retrieves a collection by its id.

Parámetros de entrada

collection_idstringObligatorio
The ID of the collection.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get commentBOX_GET_COMMENTAcción

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

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
comment_idstringObligatorio
The ID of the comment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get current userBOX_GET_CURRENT_USERAcción

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.

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get device pinBOX_GET_DEVICE_PINAcción

Retrieves information about an individual device pin.

Parámetros de entrada

device_pinner_idstringObligatorio
The ID of the device pin

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get events long poll endpointBOX_GET_EVENTS_LONG_POLL_ENDPOINTAcción

The listevents endpoint provides information about the events available in the box system. this options method allows developers to discover the capabilities and requirements for interacting with the /events endpoint. it's particularly useful for understanding the types of events that can be monitored, the format of event data, and any constraints or limitations on event retrieval. this endpoint should be used when setting up event monitoring or webhook integrations to ensure proper configuration and understanding of the event system. while it doesn't directly fetch events, it offers crucial metadata for effectively working with box's event streaming and notification features.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get file informationBOX_GET_FILE_INFORMATIONAcción

Retrieves the details about a file.

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example `?fields=metadata.enterprise_12345.contractTemplate`.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get file requestBOX_GET_FILE_REQUESTAcción

Retrieves the information about a file request.

Parámetros de entrada

file_request_idstringObligatorio
The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get files under retentionBOX_GET_FILES_UNDER_RETENTIONAcción

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

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
retention_policy_assignment_idstringObligatorio
The ID of the retention policy assignment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get file thumbnailBOX_GET_FILE_THUMBNAILAcción

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][1]. [1]: https://community.box.com/t5/migrating-and-previewing-content/file-types-and-fonts-supported-in-box-content-preview/ta-p/327

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
extensionstringObligatorioenum
The file format for the thumbnail
jpgpng
max_widthinteger
The maximum width of the thumbnail
min_widthinteger
The minimum width of the thumbnail
max_heightinteger
The maximum height of the thumbnail
min_heightinteger
The minimum height of the thumbnail

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get file versionBOX_GET_FILE_VERSIONAcción

Retrieve a specific version of a file. versions are only tracked for box users with premium accounts.

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
file_version_idstringObligatorio
The ID of the file version

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get file version legal holdBOX_GET_FILE_VERSION_LEGAL_HOLDAcción

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

Parámetros de entrada

file_version_legal_hold_idstringObligatorio
The ID of the file version legal hold

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get file versions under retentionBOX_GET_FILE_VERSIONS_UNDER_RETENTIONAcción

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

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
retention_policy_assignment_idstringObligatorio
The ID of the retention policy assignment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get folder informationBOX_GET_FOLDER_INFORMATIONAcción

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](r://folder--full#param-item-collection). to fetch more items within the folder, use the [get items in a folder](e://get-folders-id-items) endpoint.

Parámetros de entrada

sortstringenum
Defines the **second** attribute by which items are sorted. The folder type affects the way the items are sorted: * **Standard folder**: Items are always sorted by their `type` first, with folders listed before files, and files listed before web links. * **Root folder**: This parameter is not supported for marker-based pagination on the root folder (the folder with an `id` of `0`). * **Shared folder with parent path to the associated folder visible to the collaborator**: Items are always sorted by their `type` first, with folders listed before files, and files listed before web links.
dateidnamesize
limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example `?fields=metadata.enterprise_12345.contractTemplate`.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
directionstringenum
The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order.
ASCDESC
folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get groupBOX_GET_GROUPAcción

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

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
group_idstringObligatorio
The ID of the group.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get group membershipBOX_GET_GROUP_MEMBERSHIPAcción

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

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
group_membership_idstringObligatorio
The ID of the group membership.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get legal hold policyBOX_GET_LEGAL_HOLD_POLICYAcción

Retrieve a legal hold policy.

Parámetros de entrada

legal_hold_policy_idstringObligatorio
The ID of the legal hold policy

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get legal hold policy assignmentBOX_GET_LEGAL_HOLD_POLICY_ASSIGNMENTAcción

Retrieve a legal hold policy assignment.

Parámetros de entrada

legal_hold_policy_assignment_idstringObligatorio
The ID of the legal hold policy assignment

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get metadata cascade policyBOX_GET_METADATA_CASCADE_POLICYAcción

Retrieve a specific metadata cascade policy assigned to a folder.

Parámetros de entrada

metadata_cascade_policy_idstringObligatorio
The ID of the metadata cascade policy.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get metadata instance on fileBOX_GET_METADATA_INSTANCE_ON_FILEAcción

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

Parámetros de entrada

scopestringObligatorioenum
The scope of the metadata template
enterpriseglobal
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
template_keystringObligatorio
The name of the metadata template

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get metadata instance on folderBOX_GET_METADATA_INSTANCE_ON_FOLDERAcción

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`.

Parámetros de entrada

scopestringObligatorioenum
The scope of the metadata template
enterpriseglobal
folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.
template_keystringObligatorio
The name of the metadata template

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get metadata template by idBOX_GET_METADATA_TEMPLATE_BY_IDAcción

Retrieves a metadata template by its id.

Parámetros de entrada

template_idstringObligatorio
The ID of the template

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get metadata template by nameBOX_GET_METADATA_TEMPLATE_BY_NAMEAcción

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.

Parámetros de entrada

scopestringObligatorioenum
The scope of the metadata template
enterpriseglobal
template_keystringObligatorio
The name of the metadata template

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get retention on fileBOX_GET_RETENTION_ON_FILEAcción

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](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

Parámetros de entrada

file_version_retention_idstringObligatorio
The ID of the file version retention

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get retention policyBOX_GET_RETENTION_POLICYAcción

Retrieves a retention policy.

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
retention_policy_idstringObligatorio
The ID of the retention policy.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get retention policy assignmentBOX_GET_RETENTION_POLICY_ASSIGNMENTAcción

Retrieves a retention policy assignment

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
retention_policy_assignment_idstringObligatorio
The ID of the retention policy assignment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get shared link for fileBOX_GET_SHARED_LINK_FOR_FILEAcción

Gets the information for a shared link on a file.

Parámetros de entrada

fieldsstringObligatorio
Explicitly request the `shared_link` fields to be returned for this item.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get shared link for folderBOX_GET_SHARED_LINK_FOR_FOLDERAcción

Gets the information for a shared link on a folder.

Parámetros de entrada

fieldsstringObligatorio
Explicitly request the `shared_link` fields to be returned for this item.
folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get shared link for web linkBOX_GET_SHARED_LINK_FOR_WEB_LINKAcción

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

Parámetros de entrada

fieldsstringObligatorio
Explicitly request the `shared_link` fields to be returned for this item.
web_link_idstringObligatorio
The ID of the web link.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get shield information barrier report by idBOX_GET_SHIELD_INFORMATION_BARRIER_REPORT_BY_IDAcción

Retrieves a shield information barrier report by its id.

Parámetros de entrada

shield_information_barrier_report_idstringObligatorio
The ID of the shield information barrier Report.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get shield information barrier segment member by idBOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_IDAcción

Retrieves a shield information barrier segment member by its id.

Parámetros de entrada

shield_information_barrier_segment_member_idstringObligatorio
The ID of the shield information barrier segment Member.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get shield information barrier segment restriction by idBOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION_BY_IDAcción

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

Parámetros de entrada

shield_information_barrier_segment_restriction_idstringObligatorio
The ID of the shield information barrier segment Restriction.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get shield information barrier segment with specified idBOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_WITH_SPECIFIED_IDAcción

Retrieves shield information barrier segment based on provided id..

Parámetros de entrada

shield_information_barrier_segment_idstringObligatorio
The ID of the shield information barrier segment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get shield information barrier with specified idBOX_GET_SHIELD_INFORMATION_BARRIER_WITH_SPECIFIED_IDAcción

Get shield information barrier based on provided id.

Parámetros de entrada

shield_information_barrier_idstringObligatorio
The ID of the shield information barrier.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get storage policyBOX_GET_STORAGE_POLICYAcción

Fetches a specific storage policy.

Parámetros de entrada

storage_policy_idstringObligatorio
The ID of the storage policy.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get storage policy assignmentBOX_GET_STORAGE_POLICY_ASSIGNMENTAcción

Fetches a specific storage policy assignment.

Parámetros de entrada

storage_policy_assignment_idstringObligatorio
The ID of the storage policy assignment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get taskBOX_GET_TASKAcción

Retrieves information about a specific task.

Parámetros de entrada

task_idstringObligatorio
The ID of the task.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get task assignmentBOX_GET_TASK_ASSIGNMENTAcción

Retrieves information about a task assignment.

Parámetros de entrada

task_assignment_idstringObligatorio
The ID of the task assignment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get terms of serviceBOX_GET_TERMS_OF_SERVICEAcción

Fetches a specific terms of service.

Parámetros de entrada

terms_of_service_idstringObligatorio
The ID of the terms of service.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get trashed fileBOX_GET_TRASHED_FILEAcción

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`](e://get folders id trash) api. to list all items that have been moved to the trash, please use the [`get /folders/trash/items`](e://get-folders-trash-items/) api.

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get trashed folderBOX_GET_TRASHED_FOLDERAcción

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`](e://get folders id trash) api. to list all items that have been moved to the trash, please use the [`get /folders/trash/items`](e://get-folders-trash-items/) api.

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get trashed web linkBOX_GET_TRASHED_WEB_LINKAcción

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

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
web_link_idstringObligatorio
The ID of the web link.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get upload sessionBOX_GET_UPLOAD_SESSIONAcción

Return information about an upload session. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) endpoint.

Parámetros de entrada

upload_session_idstringObligatorio
The ID of the upload session.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get userBOX_GET_USERAcción

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.

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
user_idstringObligatorio
The ID of the user.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get user avatarBOX_GET_USER_AVATARAcción

Retrieves an image of a the user's avatar.

Parámetros de entrada

user_idstringObligatorio
The ID of the user.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get user exempt from collaboration domain restrictionsBOX_GET_USER_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONSAcción

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

Parámetros de entrada

collaboration_whitelist_exempt_target_idstringObligatorio
The ID of the exemption to the list.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get user invite statusBOX_GET_USER_INVITE_STATUSAcción

Returns the status of a user invite.

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
invite_idstringObligatorio
The ID of an invite.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get watermark for folderBOX_GET_WATERMARK_FOR_FOLDERAcción

Retrieve the watermark for a folder.

Parámetros de entrada

folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get watermark on fileBOX_GET_WATERMARK_ON_FILEAcción

Retrieve the watermark for a file.

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get webhookBOX_GET_WEBHOOKAcción

Retrieves a specific webhook

Parámetros de entrada

webhook_idstringObligatorio
The ID of the webhook.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get web linkBOX_GET_WEB_LINKAcción

Retrieve information about a web link.

Parámetros de entrada

web_link_idstringObligatorio
The ID of the web link.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get zip download statusBOX_GET_ZIP_DOWNLOAD_STATUSAcción

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](e://post zip downloads) api to request to create a `zip` archive, and then follow the `status url` field in the response to this endpoint.

Parámetros de entrada

zip_download_idstringObligatorio
The unique identifier that represent this `zip` archive.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ai agentsBOX_LIST_AI_AGENTSAcción

Lists ai agents based on the provided parameters.

Parámetros de entrada

modestring[]
The mode to filter the agent config to return. Possible values are: `ask`, `text_gen`, and `extract`.
limitinteger
The maximum number of items to return per page.
fieldsstring[]
The fields to return in the response.
markerstring
Defines the position marker at which to begin returning results.
agent_statestring[]
The state of the agents to return. Possible values are: `enabled`, `disabled` and `enabled_for_selected_users`.
include_box_defaultboolean
Whether to include the Box default agents in the response.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all classificationsBOX_LIST_ALL_CLASSIFICATIONSAcción

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`.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all collectionsBOX_LIST_ALL_COLLECTIONSAcción

Retrieves all collections for a given user. currently, only the `favorites` collection is supported.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all file versionsBOX_LIST_ALL_FILE_VERSIONSAcción

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.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all global metadata templatesBOX_LIST_ALL_GLOBAL_METADATA_TEMPLATESAcción

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

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all legal hold policiesBOX_LIST_ALL_LEGAL_HOLD_POLICIESAcción

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

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
policy_namestring
Limits results to policies for which the names start with this search term. This is a case-insensitive prefix.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all metadata templates for enterpriseBOX_LIST_ALL_METADATA_TEMPLATES_FOR_ENTERPRISEAcción

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

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List allowed collaboration domainsBOX_LIST_ALLOWED_COLLABORATION_DOMAINSAcción

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

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all webhooksBOX_LIST_ALL_WEBHOOKSAcción

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.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List box sign requestsBOX_LIST_BOX_SIGN_REQUESTSAcción

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.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
sendersstring[]
A list of sender emails to filter the signature requests by sender. If provided, `shared_requests` must be set to `true`.
shared_requestsboolean
If set to `true`, only includes requests that user is not an owner, but user is a collaborator. Collaborator access is determined by the user access level of the sign files of the request. Default is `false`. Must be set to `true` if `senders` are provided.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List box sign templatesBOX_LIST_BOX_SIGN_TEMPLATESAcción

Gets box sign templates created by a user.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List box skill cards on fileBOX_LIST_BOX_SKILL_CARDS_ON_FILEAcción

List the box skills metadata cards that are attached to a file.

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List collection itemsBOX_LIST_COLLECTION_ITEMSAcción

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

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
collection_idstringObligatorio
The ID of the collection.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List enterprise device pinsBOX_LIST_ENTERPRISE_DEVICE_PINSAcción

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.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
directionstringenum
The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order.
ASCDESC
enterprise_idstringObligatorio
The ID of the enterprise

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List enterprise usersBOX_LIST_ENTERPRISE_USERSAcción

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.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
usemarkerboolean
Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By setting this value to true, the API will return a `marker` field that can be passed as a parameter to this endpoint to get the next page of the response.
user_typestringenum
Limits the results to the kind of user specified. * `all` returns every kind of user for whom the `login` or `name` partially matches the `filter_term`. It will only return an external user if the login matches the `filter_term` completely, and in that case it will only return that user. * `managed` returns all managed and app users for whom the `login` or `name` partially matches the `filter_term`. * `external` returns all external users for whom the `login` matches the `filter_term` exactly.
allexternalmanaged
filter_termstring
Limits the results to only users who"s `name` or `login` start with the search term. For externally managed users, the search term needs to completely match the in order to find the user, and it will only return one user at a time.
external_app_user_idstring
Limits the results to app users with the given `external_app_user_id` value. When creating an app user, an `external_app_user_id` value can be set. This value can then be used in this endpoint to find any users that match that `external_app_user_id` value.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List file app item associationsBOX_LIST_FILE_APP_ITEM_ASSOCIATIONSAcción

**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.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
application_typestring
If given, only return app items for this application type

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List file collaborationsBOX_LIST_FILE_COLLABORATIONSAcción

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.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List file commentsBOX_LIST_FILE_COMMENTSAcción

Retrieves a list of comments for a file.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List file version legal holdsBOX_LIST_FILE_VERSION_LEGAL_HOLDSAcción

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.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
policy_idstringObligatorio
The ID of the legal hold policy to get the file version legal holds for.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List file version retentionsBOX_LIST_FILE_VERSION_RETENTIONSAcción

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](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
file_idstring
Filters results by files with this ID.
policy_idstring
Filters results by the retention policy with this ID.
file_version_idstring
Filters results by file versions with this ID.
disposition_afterstring
Filters results by files that will have their disposition come into effect after this date.
disposition_actionstringenum
Filters results by the retention policy with this disposition action.
permanently_deleteremove_retention
disposition_beforestring
Filters results by files that will have their disposition come into effect before this date.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List folder app item associationsBOX_LIST_FOLDER_APP_ITEM_ASSOCIATIONSAcción

**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.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.
application_typestring
If given, returns only app items for this application type

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List folder collaborationsBOX_LIST_FOLDER_COLLABORATIONSAcción

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.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List folder locksBOX_LIST_FOLDER_LOCKSAcción

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.

Parámetros de entrada

folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List group collaborationsBOX_LIST_GROUP_COLLABORATIONSAcción

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.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
group_idstringObligatorio
The ID of the group.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List groups for enterpriseBOX_LIST_GROUPS_FOR_ENTERPRISEAcción

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

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
filter_termstring
Limits the results to only groups whose `name` starts with the search term.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List items in folderBOX_LIST_ITEMS_IN_FOLDERAcción

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](#get-folders-id) endpoint instead.

Parámetros de entrada

sortstringenum
Defines the **second** attribute by which items are sorted. The folder type affects the way the items are sorted: * **Standard folder**: Items are always sorted by their `type` first, with folders listed before files, and files listed before web links. * **Root folder**: This parameter is not supported for marker-based pagination on the root folder (the folder with an `id` of `0`). * **Shared folder with parent path to the associated folder visible to the collaborator**: Items are always sorted by their `type` first, with folders listed before files, and files listed before web links.
dateidnamesize
limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example `?fields=metadata.enterprise_12345.contractTemplate`.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
directionstringenum
The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order.
ASCDESC
folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.
usemarkerboolean
Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By setting this value to true, the API will return a `marker` field that can be passed as a parameter to this endpoint to get the next page of the response.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List legal hold policy assignmentsBOX_LIST_LEGAL_HOLD_POLICY_ASSIGNMENTSAcción

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

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
policy_idstringObligatorio
The ID of the legal hold policy
assign_to_idstring
Filters the results by the ID of item the policy was applied to.
assign_to_typestringenum
Filters the results by the type of item the policy was applied to.
filefile_versionfolderuser

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List members of groupBOX_LIST_MEMBERS_OF_GROUPAcción

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.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
group_idstringObligatorio
The ID of the group.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List metadata cascade policiesBOX_LIST_METADATA_CASCADE_POLICIESAcción

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`.

Parámetros de entrada

markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
folder_idstringObligatorio
Specifies which folder to return policies for. This can not be used on the root folder with ID `0`.
owner_enterprise_idstring
The ID of the enterprise ID for which to find metadata cascade policies. If not specified, it defaults to the current enterprise.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List metadata instances on fileBOX_LIST_METADATA_INSTANCES_ON_FILEAcción

Retrieves all metadata for a given file.

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List metadata instances on folderBOX_LIST_METADATA_INSTANCES_ON_FOLDERAcción

Retrieves all metadata for a given folder. this can not be used on the root folder with id `0`.

Parámetros de entrada

folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List partsBOX_LIST_PARTSAcción

Return a list of the chunks uploaded to the upload session so far. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) and [`get upload session`](e://get-files-upload-sessions-id) endpoints.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
upload_session_idstringObligatorio
The ID of the upload session.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List pending collaborationsBOX_LIST_PENDING_COLLABORATIONSAcción

Retrieves all pending collaboration invites for this user.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
statusstringObligatorioenum
The status of the collaborations to retrieve
pending

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List previous file versions for legal hold policy assignmentBOX_LIST_PREVIOUS_FILE_VERSIONS_FOR_LEGAL_HOLD_POLICY_ASSIGNMENTAcción

List previous file versions for legal hold policy assignment

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
legal_hold_policy_assignment_idstringObligatorio
The ID of the legal hold policy assignment

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List recently accessed itemsBOX_LIST_RECENTLY_ACCESSED_ITEMSAcción

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

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List retention policiesBOX_LIST_RETENTION_POLICIESAcción

Retrieves all of the retention policies for an enterprise.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
policy_namestring
Filters results by a case sensitive prefix of the name of retention policies.
policy_typestringenum
Filters results by the type of retention policy.
finiteindefinite
created_by_user_idstring
Filters results by the ID of the user who created policy.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List retention policy assignmentsBOX_LIST_RETENTION_POLICY_ASSIGNMENTSAcción

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

Parámetros de entrada

typestringenum
The type of the retention policy assignment to retrieve.
enterprisefoldermetadata_template
limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
retention_policy_idstringObligatorio
The ID of the retention policy.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List shield information barrier reportsBOX_LIST_SHIELD_INFORMATION_BARRIER_REPORTSAcción

Lists shield information barrier reports.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
shield_information_barrier_idstringObligatorio
The ID of the shield information barrier.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List shield information barriersBOX_LIST_SHIELD_INFORMATION_BARRIERSAcción

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

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List shield information barrier segment membersBOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBERSAcción

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

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
shield_information_barrier_segment_idstringObligatorio
The ID of the shield information barrier segment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List shield information barrier segment restrictionsBOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTIONSAcción

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

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
shield_information_barrier_segment_idstringObligatorio
The ID of the shield information barrier segment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List shield information barrier segmentsBOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENTSAcción

Retrieves a list of shield information barrier segment objects for the specified information barrier id.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
shield_information_barrier_idstringObligatorio
The ID of the shield information barrier.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List slack integration mappingsBOX_LIST_SLACK_INTEGRATION_MAPPINGSAcción

Lists [slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-box-as-the-content-layer-for-slack) in a users' enterprise. you need admin or co-admin role to use this endpoint.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
box_item_idstring
Box item ID, for which the mappings should be returned
box_item_typestringenum
Box item type, for which the mappings should be returned
folder
partner_item_idstring
ID of the mapped item, for which the mapping should be returned
partner_item_typestringenum
Mapped item type, for which the mapping should be returned
channel
is_manually_createdboolean
Whether the mapping has been manually created

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List storage policiesBOX_LIST_STORAGE_POLICIESAcción

Fetches all the storage policies in the enterprise.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List storage policy assignmentsBOX_LIST_STORAGE_POLICY_ASSIGNMENTSAcción

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

Parámetros de entrada

markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
resolved_for_idstringObligatorio
The ID of the user or enterprise to return assignments for
resolved_for_typestringObligatorioenum
The target type to return assignments for
enterpriseuser

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List task assignmentsBOX_LIST_TASK_ASSIGNMENTSAcción

Lists all of the assignments for a given task.

Parámetros de entrada

task_idstringObligatorio
The ID of the task.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List tasks on fileBOX_LIST_TASKS_ON_FILEAcción

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

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List teams integration mappingsBOX_LIST_TEAMS_INTEGRATION_MAPPINGSAcción

Lists [teams integration mappings](https://support.box.com/hc/en-us/articles/360044681474-using-box-for-teams) in a users' enterprise. you need admin or co-admin role to use this endpoint.

Parámetros de entrada

box_item_idstring
Box item ID, for which the mappings should be returned
box_item_typestringenum
Box item type, for which the mappings should be returned
folder
partner_item_idstring
ID of the mapped item, for which the mapping should be returned
partner_item_typestringenum
Mapped item type, for which the mapping should be returned
channelteam

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List terms of servicesBOX_LIST_TERMS_OF_SERVICESAcción

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

Parámetros de entrada

tos_typestringenum
Limits the results to the terms of service of the given type.
externalmanaged

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List terms of service user statusesBOX_LIST_TERMS_OF_SERVICE_USER_STATUSESAcción

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

Parámetros de entrada

tos_idstringObligatorio
The ID of the terms of service.
user_idstring
Limits results to the given user ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List trashed itemsBOX_LIST_TRASHED_ITEMSAcción

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.

Parámetros de entrada

sortstringenum
Defines the **second** attribute by which items are sorted. Items are always sorted by their `type` first, with folders listed before files, and files listed before web links. This parameter is not supported when using marker-based pagination.
datenamesize
limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
directionstringenum
The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order.
ASCDESC
usemarkerboolean
Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By setting this value to true, the API will return a `marker` field that can be passed as a parameter to this endpoint to get the next page of the response.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List user and enterprise eventsBOX_LIST_USER_AND_ENTERPRISE_EVENTSAcción

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.

Parámetros de entrada

limitinteger
Limits the number of events returned Note: Sometimes, the events less than the limit requested can be returned even when there may be more events remaining. This is primarily done in the case where a number of events have already been retrieved and these retrieved events are returned rather than delaying for an unknown amount of time to see if there are any more results.
event_typestring[]
A comma-separated list of events to filter by. This can only be used when requesting the events with a `stream_type` of `admin_logs` or `adming_logs_streaming`. For any other `stream_type` this value will be ignored.
stream_typestringenum
Defines the type of events that are returned * `all` returns everything for a user and is the default * `changes` returns events that may cause file tree changes such as file updates or collaborations. * `sync` is similar to `changes` but only applies to synced folders * `admin_logs` returns all events for an entire enterprise and requires the user making the API call to have admin permissions. This stream type is for programmatically pulling from a 1 year history of events across all users within the enterprise and within a `created_after` and `created_before` time frame. The complete history of events will be returned in chronological order based on the event time, but latency will be much higher than `admin_logs_streaming`. * `admin_logs_streaming` returns all events for an entire enterprise and requires the user making the API call to have admin permissions. This stream type is for polling for recent events across all users within the enterprise. Latency will be much lower than `admin_logs`, but events will not be returned in chronological order and may contain duplicates.
admin_logsadmin_logs_streamingallchangessync
created_afterstring
The lower bound date and time to return events for. This can only be used when requesting the events with a `stream_type` of `admin_logs`. For any other `stream_type` this value will be ignored.
created_beforestring
The upper bound date and time to return events for. This can only be used when requesting the events with a `stream_type` of `admin_logs`. For any other `stream_type` this value will be ignored.
stream_positionstring
The location in the event stream to start receiving events from. * `now` will return an empty list events and the latest stream position for initialization. * `0` or `null` will return all events.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List user s email aliasesBOX_LIST_USER_S_EMAIL_ALIASESAcción

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

Parámetros de entrada

user_idstringObligatorio
The ID of the user.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List users exempt from collaboration domain restrictionsBOX_LIST_USERS_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONSAcción

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

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List user s groupsBOX_LIST_USER_S_GROUPSAcción

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.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
user_idstringObligatorio
The ID of the user.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List workflowsBOX_LIST_WORKFLOWSAcción

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.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.
trigger_typestring
Type of trigger to search for.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Permanently remove fileBOX_PERMANENTLY_REMOVE_FILEAcción

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

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Permanently remove folderBOX_PERMANENTLY_REMOVE_FOLDERAcción

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

Parámetros de entrada

folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Permanently remove web linkBOX_PERMANENTLY_REMOVE_WEB_LINKAcción

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

Parámetros de entrada

web_link_idstringObligatorio
The ID of the web link.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Preflight check before uploadBOX_PREFLIGHT_CHECK_BEFORE_UPLOADAcción

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

Parámetros de entrada

namestring
The name for the file
sizeinteger
The size of the file in bytes

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Promote file versionBOX_PROMOTE_FILE_VERSIONAcción

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.

Parámetros de entrada

idstring
The file version ID
typestringenum
The type to promote
file_version
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Query files folders by metadataBOX_QUERY_FILES_FOLDERS_BY_METADATAAcción

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.

Parámetros de entrada

fromstringObligatorio
Specifies the template used in the query. Must be in the form `scope.templateKey`. Not all templates can be used in this field, most notably the built-in, Box-provided classification templates can not be used in a query.
limitinteger
A value between 0 and 100 that indicates the maximum number of results to return for a single request. This only specifies a maximum boundary and will not guarantee the minimum number of results returned.
querystring
The query to perform. A query is a logical expression that is very similar to a SQL `SELECT` statement. Values in the search query can be turned into parameters specified in the `query_param` arguments list to prevent having to manually insert search values into the query string. For example, a value of `:amount` would represent the `amount` value in `query_params` object.
fieldsstring[]
By default, this endpoint returns only the most basic info about the items for which the query matches. This attribute can be used to specify a list of additional attributes to return for any item, including its metadata. This attribute takes a list of item fields, metadata template identifiers, or metadata template field identifiers. For example: * `created_by` will add the details of the user who created the item to the response. * `metadata.<scope>.<templateKey>` will return the mini-representation of the metadata instance identified by the `scope` and `templateKey`. * `metadata.<scope>.<templateKey>.<field>` will return all the mini-representation of the metadata instance identified by the `scope` and `templateKey` plus the field specified by the `field` name. Multiple fields for the same `scope` and `templateKey` can be defined.
markerstring
Marker to use for requesting the next page.
order_byobject[]
A list of template fields and directions to sort the metadata query results by. The ordering `direction` must be the same for each item in the array.
query_paramsobject
Set of arguments corresponding to the parameters specified in the `query`. The type of each parameter used in the `query_params` must match the type of the corresponding metadata template field.
ancestor_folder_idstringObligatorio
The ID of the folder that you are restricting the query to. A value of zero will return results from all folders you have access to. A non-zero value will only return results found in the folder corresponding to the ID or in any of its subfolders.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Refresh access tokenBOX_REFRESH_ACCESS_TOKENAcción

Refresh an access token using its client id, secret, and refresh token.

Parámetros de entrada

client_idstringObligatorio
The client ID of the application requesting to refresh the token.
grant_typestringObligatoriournenum
The type of request being made, in this case a refresh request.
refresh_token
client_secretstringObligatorio
The client secret of the application requesting to refresh the token.
refresh_tokenstringObligatoriotoken
The refresh token to refresh.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove box skill cards from fileBOX_REMOVE_BOX_SKILL_CARDS_FROM_FILEAcción

Removes any box skills cards metadata from a file.

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove classification from fileBOX_REMOVE_CLASSIFICATION_FROM_FILEAcción

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`.

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove classification from folderBOX_REMOVE_CLASSIFICATION_FROM_FOLDERAcción

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`.

Parámetros de entrada

folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove collaborationBOX_REMOVE_COLLABORATIONAcción

Deletes a single collaboration.

Parámetros de entrada

collaboration_idstringObligatorio
The ID of the collaboration

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove commentBOX_REMOVE_COMMENTAcción

Permanently deletes a comment.

Parámetros de entrada

comment_idstringObligatorio
The ID of the comment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove device pinBOX_REMOVE_DEVICE_PINAcción

Deletes an individual device pin.

Parámetros de entrada

device_pinner_idstringObligatorio
The ID of the device pin

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove domain from list of allowed collaboration domainsBOX_REMOVE_DOMAIN_FROM_LIST_OF_ALLOWED_COLLABORATION_DOMAINSAcción

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

Parámetros de entrada

collaboration_whitelist_entry_idstringObligatorio
The ID of the entry in the list.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove email aliasBOX_REMOVE_EMAIL_ALIASAcción

Removes an email alias from a user.

Parámetros de entrada

user_idstringObligatorio
The ID of the user.
email_alias_idstringObligatorio
The ID of the email alias.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove file versionBOX_REMOVE_FILE_VERSIONAcción

Move a file version to the trash. versions are only tracked for box users with premium accounts.

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
file_version_idstringObligatorio
The ID of the file version

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove groupBOX_REMOVE_GROUPAcción

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

Parámetros de entrada

group_idstringObligatorio
The ID of the group.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove legal hold policyBOX_REMOVE_LEGAL_HOLD_POLICYAcción

Delete an existing legal hold policy. this is an asynchronous process. the policy will not be fully deleted yet when the response returns.

Parámetros de entrada

legal_hold_policy_idstringObligatorio
The ID of the legal hold policy

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove metadata cascade policyBOX_REMOVE_METADATA_CASCADE_POLICYAcción

Deletes a metadata cascade policy.

Parámetros de entrada

metadata_cascade_policy_idstringObligatorio
The ID of the metadata cascade policy.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove metadata instance from fileBOX_REMOVE_METADATA_INSTANCE_FROM_FILEAcción

Deletes a piece of file metadata.

Parámetros de entrada

scopestringObligatorioenum
The scope of the metadata template
enterpriseglobal
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
template_keystringObligatorio
The name of the metadata template

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove metadata instance from folderBOX_REMOVE_METADATA_INSTANCE_FROM_FOLDERAcción

Deletes a piece of folder metadata.

Parámetros de entrada

scopestringObligatorioenum
The scope of the metadata template
enterpriseglobal
folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.
template_keystringObligatorio
The name of the metadata template

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove metadata templateBOX_REMOVE_METADATA_TEMPLATEAcción

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

Parámetros de entrada

scopestringObligatorioenum
The scope of the metadata template
enterpriseglobal
template_keystringObligatorio
The name of the metadata template

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove retention policy assignmentBOX_REMOVE_RETENTION_POLICY_ASSIGNMENTAcción

Removes a retention policy assignment applied to content.

Parámetros de entrada

retention_policy_assignment_idstringObligatorio
The ID of the retention policy assignment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove shared link from fileBOX_REMOVE_SHARED_LINK_FROM_FILEAcción

Removes a shared link from a file.

Parámetros de entrada

fieldsstringObligatorio
Explicitly request the `shared_link` fields to be returned for this item.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove shared link from folderBOX_REMOVE_SHARED_LINK_FROM_FOLDERAcción

Removes a shared link from a folder.

Parámetros de entrada

fieldsstringObligatorio
Explicitly request the `shared_link` fields to be returned for this item.
folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove shared link from web linkBOX_REMOVE_SHARED_LINK_FROM_WEB_LINKAcción

Removes a shared link from a web link.

Parámetros de entrada

fieldsstringObligatorio
Explicitly request the `shared_link` fields to be returned for this item.
web_link_idstringObligatorio
The ID of the web link.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove taskBOX_REMOVE_TASKAcción

Removes a task from a file.

Parámetros de entrada

task_idstringObligatorio
The ID of the task.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove upload sessionBOX_REMOVE_UPLOAD_SESSIONAcción

Abort an upload session and discard all data uploaded. this cannot be reversed. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) and [`get upload session`](e://get-files-upload-sessions-id) endpoints.

Parámetros de entrada

upload_session_idstringObligatorio
The ID of the upload session.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove User Domain ExemptionBOX_REMOVE_USER_DOMAIN_EXEMPTIONAcción

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

Parámetros de entrada

collaboration_whitelist_exempt_target_idstringObligatorio
The ID of the exemption to the list.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove user from groupBOX_REMOVE_USER_FROM_GROUPAcción

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

Parámetros de entrada

group_membership_idstringObligatorio
The ID of the group membership.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove watermark from fileBOX_REMOVE_WATERMARK_FROM_FILEAcción

Removes the watermark from a file.

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove watermark from folderBOX_REMOVE_WATERMARK_FROM_FOLDERAcción

Removes the watermark from a folder.

Parámetros de entrada

folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove webhookBOX_REMOVE_WEBHOOKAcción

Deletes a webhook.

Parámetros de entrada

webhook_idstringObligatorio
The ID of the webhook.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove web linkBOX_REMOVE_WEB_LINKAcción

Deletes a web link.

Parámetros de entrada

web_link_idstringObligatorio
The ID of the web link.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Request access tokenBOX_REQUEST_ACCESS_TOKENAcción

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](#get-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.

Parámetros de entrada

codestringtoken
The client-side authorization code passed to your application by Box in the browser redirect after the user has successfully granted your application permission to make API calls on their behalf. Used in combination with `authorization_code` as the `grant_type`.
scopestringspace_delimited_list
The space-delimited list of scopes that you want apply to the new access token. The `subject_token` will need to have all of these scopes or the call will error with **401 Unauthorized**.
resourcestringurl
Full URL for the file that the token should be generated for.
assertionstringjwt
A JWT assertion for which to request a new access token. Used in combination with `urn:ietf:params:oauth:grant-type:jwt-bearer` as the `grant_type`.
client_idstring
The Client ID of the application requesting an access token. Used in combination with `authorization_code`, `client_credentials`, or `urn:ietf:params:oauth:grant-type:jwt-bearer` as the `grant_type`.
grant_typestringObligatoriournenum
The type of request being made, either using a client-side obtained authorization code, a refresh token, a JWT assertion, client credentials grant or another access token for the purpose of downscoping a token.
authorization_codeclient_credentialsrefresh_tokenurn:ietf:params:oauth:grant-type:jwt-bearerurn:ietf:params:oauth:grant-type:token-exchange
actor_tokenstringtoken
The token used to create an annotator token. This is a JWT assertion. Used in combination with `urn:ietf:params:oauth:grant-type:token-exchange` as the `grant_type`.
client_secretstring
The client secret of the application requesting an access token. Used in combination with `authorization_code`, `client_credentials`, or `urn:ietf:params:oauth:grant-type:jwt-bearer` as the `grant_type`.
refresh_tokenstringtoken
A refresh token used to get a new access token with. Used in combination with `refresh_token` as the `grant_type`.
subject_tokenstringtoken
The token to exchange for a downscoped token. This can be a regular access token, a JWT assertion, or an app token. Used in combination with `urn:ietf:params:oauth:grant-type:token-exchange` as the `grant_type`.
box_subject_idstring
Used in combination with `client_credentials` as the `grant_type`. Value is determined by `box_subject_type`. If `user` use user ID and if `enterprise` use enterprise ID.
box_shared_linkstringurl
Full URL of the shared link on the file or folder that the token should be generated for.
actor_token_typestringurnenum
The type of `actor_token` passed in. Used in combination with `urn:ietf:params:oauth:grant-type:token-exchange` as the `grant_type`.
urn:ietf:params:oauth:token-type:id_token
box_subject_typestringenum
Used in combination with `client_credentials` as the `grant_type`.
enterpriseuser
subject_token_typestringenum
The type of `subject_token` passed in. Used in combination with `urn:ietf:params:oauth:grant-type:token-exchange` as the `grant_type`.
urn:ietf:params:oauth:token-type:access_token

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Resend box sign requestBOX_RESEND_BOX_SIGN_REQUESTAcción

Resends a signature request email to all outstanding signers.

Parámetros de entrada

sign_request_idstringObligatorio
The ID of the signature request

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Restore fileBOX_RESTORE_FILEAcción

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.

Parámetros de entrada

namestring
An optional new name for the file.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Restore file versionBOX_RESTORE_FILE_VERSIONAcción

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.

Parámetros de entrada

file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
trashed_atstring
Set this to `null` to clear the date and restore the file.
file_version_idstringObligatorio
The ID of the file version

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Restore folderBOX_RESTORE_FOLDERAcción

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.

Parámetros de entrada

namestring
An optional new name for the folder.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Restore web linkBOX_RESTORE_WEB_LINKAcción

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.

Parámetros de entrada

namestring
An optional new name for the web link.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
web_link_idstringObligatorio
The ID of the web link.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Review files on legal hold policy assignmentBOX_REVIEW_FILES_ON_LEGAL_HOLD_POLICY_ASSIGNMENTAcción

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.

Parámetros de entrada

limitinteger
The maximum number of items to return per page.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
markerstring
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
legal_hold_policy_assignment_idstringObligatorio
The ID of the legal hold policy assignment

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Revoke access tokenBOX_REVOKE_ACCESS_TOKENAcción

Revoke an active access token, effectively logging a user out that has been previously authenticated.

Parámetros de entrada

tokenstringtoken
The access token to revoke.
client_idstring
The Client ID of the application requesting to revoke the access token.
client_secretstring
The client secret of the application requesting to revoke an access token.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search for contentBOX_SEARCH_FOR_CONTENTAcción

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

Parámetros de entrada

sortstringenum
Defines the order in which search results are returned. This API defaults to returning items by relevance unless this parameter is explicitly specified. * `relevance` (default) returns the results sorted by relevance to the query search term. The relevance is based on the occurrence of the search term in the items name, description, content, and additional properties. * `modified_at` returns the results ordered in descending order by date at which the item was last modified.
modified_atrelevance
typestringenum
Limits the search results to any items of this type. This parameter only takes one value. By default the API returns items that match any of these types. * `file` - Limits the search results to files * `folder` - Limits the search results to folders * `web_link` - Limits the search results to web links, also known as bookmarks
filefolderweb_link
limitinteger
Defines the maximum number of items to return as part of a page of results.
querystring
The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the different item types. This parameter supports a variety of operators to further refine the results returns. * `""` - by wrapping a query in double quotes only exact matches are returned by the API. Exact searches do not return search matches based on specific character sequences. Instead, they return matches based on phrases, that is, word sequences. For example: A search for `"Blue-Box"` may return search results including the sequence `"blue.box"`, `"Blue Box"`, and `"Blue-Box"`; any item containing the words `Blue` and `Box` consecutively, in the order specified. * `AND` - returns items that contain both the search terms. For example, a search for `marketing AND BoxWorks` returns items that have both `marketing` and `BoxWorks` within its text in any order. It does not return a result that only has `BoxWorks` in its text. * `OR` - returns items that contain either of the search terms. For example, a search for `marketing OR BoxWorks` returns a result that has either `marketing` or `BoxWorks` within its text. Using this operator is not necessary as we implicitly interpret multi-word queries as `OR` unless another supported boolean term is used. * `NOT` - returns items that do not contain the search term provided. For example, a search for `marketing AND NOT BoxWorks` returns a result that has only `marketing` within its text. Results containing `BoxWorks` are omitted. We do not support lower case (that is, `and`, `or`, and `not`) or mixed case (that is, `And`, `Or`, and `Not`) operators. This field is required unless the `mdfilters` parameter is defined.
scopestringenum
Limits the search results to either the files that the user has access to, or to files available to the entire enterprise. The scope defaults to `user_content`, which limits the search results to content that is available to the currently authenticated user. The `enterprise_content` can be requested by an admin through our support channels. Once this scope has been enabled for a user, it will allow that use to query for content across the entire enterprise and not only the content that they have access to.
enterprise_contentuser_content
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
offsetinteger
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
directionstringenum
Defines the direction in which search results are ordered. This API defaults to returning items in descending (`DESC`) order unless this parameter is explicitly specified. When results are sorted by `relevance` the ordering is locked to returning items in descending order of relevance, and this parameter is ignored.
ASCDESC
mdfiltersobject[]
Limits the search results to any items for which the metadata matches the provided filter. This parameter is a list that specifies exactly **one** metadata template used to filter the search results. The parameter is required unless the `query` parameter is provided.
size_rangeinteger[]
Limits the search results to any items with a size within a given file size range. This applied to files and folders. Size ranges are defined as comma separated list of a lower and upper byte size limit (inclusive). The upper and lower bound can be omitted to create open ranges.
content_typesstring[]
Limits the search results to any items that match the search query for a specific part of the file, for example the file description. Content types are defined as a comma separated lists of Box recognized content types. The allowed content types are as follows. * `name` - The name of the item, as defined by its `name` field. * `description` - The description of the item, as defined by its `description` field. * `file_content` - The actual content of the file. * `comments` - The content of any of the comments on a file or folder. * `tags` - Any tags that are applied to an item, as defined by its `tags` field.
trash_contentstringenum
Determines if the search should look in the trash for items. By default, this API only returns search results for items not currently in the trash (`non_trashed_only`). * `trashed_only` - Only searches for items currently in the trash * `non_trashed_only` - Only searches for items currently not in the trash * `all_items` - Searches for both trashed and non-trashed items.
all_itemsnon_trashed_onlytrashed_only
owner_user_idsstring[]
Limits the search results to any items that are owned by the given list of owners, defined as a list of comma separated user IDs. The items still need to be owned or shared with the currently authenticated user for them to show up in the search results. If the user does not have access to any files owned by any of the users an empty result set will be returned. To search across an entire enterprise, we recommend using the `enterprise_content` scope parameter which can be requested with our support team.
file_extensionsstring[]
Limits the search results to any files that match any of the provided file extensions. This list is a comma-separated list of file extensions without the dots.
created_at_rangestring[]
Limits the search results to any items created within a given date range. Date ranges are defined as comma separated RFC3339 timestamps. If the the start date is omitted (`,2014-05-17T13:35:01-07:00`) anything created before the end date will be returned. If the end date is omitted (`2014-05-15T13:35:01-07:00,`) the current date will be used as the end date instead.
deleted_at_rangestring[]
Limits the search results to any items deleted within a given date range. Date ranges are defined as comma separated RFC3339 timestamps. If the the start date is omitted (`2014-05-17T13:35:01-07:00`), anything deleted before the end date will be returned. If the end date is omitted (`2014-05-15T13:35:01-07:00`), the current date will be used as the end date instead. The `trash_content` parameter needs to be set to `trashed_only`. If searching in trash is not performed, then an empty result is returned. Data available from 2023-02-01 onwards.
deleted_user_idsstring[]
Limits the search results to items that were deleted by the given list of users, defined as a list of comma separated user IDs. The `trash_content` parameter needs to be set to `trashed_only`. If searching in trash is not performed, an empty result set is returned. The items need to be owned or shared with the currently authenticated user for them to show up in the search results. If the user does not have access to any files owned by any of the users, an empty result set is returned. Data available from 2023-02-01 onwards.
updated_at_rangestring[]
Limits the search results to any items updated within a given date range. Date ranges are defined as comma separated RFC3339 timestamps. If the start date is omitted (`,2014-05-17T13:35:01-07:00`) anything updated before the end date will be returned. If the end date is omitted (`2014-05-15T13:35:01-07:00,`) the current date will be used as the end date instead.
ancestor_folder_idsstring[]
Limits the search results to items within the given list of folders, defined as a comma separated lists of folder IDs. Search results will also include items within any subfolders of those ancestor folders. The folders still need to be owned or shared with the currently authenticated user. If the folder is not accessible by this user, or it does not exist, a `HTTP 404` error code will be returned instead. To search across an entire enterprise, we recommend using the `enterprise_content` scope parameter which can be requested with our support team.
recent_updater_user_idsstring[]
Limits the search results to any items that have been updated by the given list of users, defined as a list of comma separated user IDs. The items still need to be owned or shared with the currently authenticated user for them to show up in the search results. If the user does not have access to any files owned by any of the users an empty result set will be returned. This feature only searches back to the last 10 versions of an item.
include_recent_shared_linksboolean
Defines whether the search results should include any items that the user recently accessed through a shared link. When this parameter has been set to true, the format of the response of this API changes to return a list of [Search Results with Shared Links](r://search_results_with_shared_links)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Starts workflow based on request bodyBOX_STARTS_WORKFLOW_BASED_ON_REQUEST_BODYAcción

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.

Parámetros de entrada

typestringenum
The type of the parameters object
workflow_parameters
filesobject[]Obligatorio
The array of files for which the workflow should start. All files must be in the workflow"s configured folder.
flow__idstring
The id of the flow
outcomesobject[]
A configurable outcome the workflow should complete.
flow__typestring
The type of the flow object
folder__idstring
The id of the folder
workflow_idstringObligatorio
The ID of the workflow.
folder__typestringenum
The type of the folder object
folder

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Transfer owned foldersBOX_TRANSFER_OWNED_FOLDERSAcción

Transfers ownership of a specific folder (with id 0) from one user to another in the box cloud storage system. this endpoint should be used when you need to change the owner of a user's root folder, effectively transferring all of their content to another user. it's particularly useful in scenarios such as employee offboarding or role transitions within an organization. the operation is irreversible, so it should be used with caution. note that this endpoint specifically targets the folder with id 0, which typically represents a user's root folder in box.

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
notifyboolean
Determines if users should receive email notification for the action performed.
user_idstringObligatorio
The ID of the user.
owned__by__idstring
The ID of the user who the folder will be transferred to

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unassign legal hold policyBOX_UNASSIGN_LEGAL_HOLD_POLICYAcción

Remove a legal hold from an item. this is an asynchronous process. the policy will not be fully removed yet when the response returns.

Parámetros de entrada

legal_hold_policy_assignment_idstringObligatorio
The ID of the legal hold policy assignment

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unassign storage policyBOX_UNASSIGN_STORAGE_POLICYAcción

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.

Parámetros de entrada

storage_policy_assignment_idstringObligatorio
The ID of the storage policy assignment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unassign taskBOX_UNASSIGN_TASKAcción

Deletes a specific task assignment.

Parámetros de entrada

task_assignment_idstringObligatorio
The ID of the task assignment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ai agentBOX_UPDATE_AI_AGENTAcción

Updates an ai agent.

Parámetros de entrada

namestringObligatorio
The name of the AI Agent.
typestringObligatorioenum
The type of agent used to handle queries.
ai_agent
agent_idstringObligatorio
The ID of the agent to update.
ask__typestringenum
The type of AI agent used to handle queries.
ai_agent_ask
access_statestringObligatorio
The state of the AI Agent. Possible values are: `enabled`, `disabled`, and `enabled_for_selected_users`.
extract__typestringenum
The type of AI agent to be used for extraction.
ai_agent_extract
icon_referencestring
The icon reference of the AI Agent. It should have format of the URL `https://cdn01.boxcdn.net/app-assets/aistudio/avatars/<file_name>` where possible values of `file_name` are: `logo_boxAi.png`,`logo_stamp.png`,`logo_legal.png`,`logo_finance.png`,`logo_config.png`,`logo_handshake.png`,`logo_analytics.png`,`logo_classification.png`
text__gen__typestringenum
The type of AI agent used for generating text.
ai_agent_text_gen
allowed_entitiesobject[]
List of allowed users or groups.
ask__descriptionstring
The description of the AI Agent.
ask__access__statestring
The state of the AI Agent capability. Possible values are: `enabled` and `disabled`.
extract__descriptionstring
The description of the AI Agent.
extract__access__statestring
The state of the AI Agent capability. Possible values are: `enabled` and `disabled`.
text__gen__descriptionstring
The description of the AI Agent.
text__gen__access__statestring
The state of the AI Agent capability. Possible values are: `enabled` and `disabled`.
ask__custom__instructionsstring
Custom instructions for the agent.
extract__custom__instructionsstring
Custom instructions for the agent.
text__gen__custom__instructionsstring
Custom instructions for the agent.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update all box skill cards on fileBOX_UPDATE_ALL_BOX_SKILL_CARDS_ON_FILEAcción

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

Parámetros de entrada

statusstringObligatorioenum
Defines the status of this invocation. Set this to `success` when setting Skill cards.
invokedpermanent_failureprocessingsuccesstransient_failure
file__idstring
The ID of the file
skill_idstringObligatorio
The ID of the skill to apply this metadata for.
file__typestringenum
`file`
file
usage__unitstring
`file`
usage__valueinteger
`1`
metadata__cardsobject[]
A list of Box Skill cards to apply to this file.
file__version__idstring
The ID of the file version
file__version__typestringenum
`file_version`
file_version

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update collaborationBOX_UPDATE_COLLABORATIONAcción

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

Parámetros de entrada

rolestringObligatorioenum
The level of access granted.
co-ownereditorownerpreviewerpreviewer uploaderuploaderviewerviewer uploader
statusstringenum
 Set the status of a `pending` collaboration invitation, effectively accepting, or rejecting the invite.
acceptedpendingrejected
expires_atstringdate-time
Update the expiration date for the collaboration. At this date, the collaboration will be automatically removed from the item. This feature will only work if the **Automatically remove invited collaborators: Allow folder owners to extend the expiry date** setting has been enabled in the **Enterprise Settings** of the **Admin Console**. When the setting is not enabled, collaborations can not have an expiry date and a value for this field will be result in an error. Additionally, a collaboration can only be given an expiration if it was created after the **Automatically remove invited collaborator** setting was enabled.
can_view_pathboolean
Determines if the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore can not see content the user is not collaborated on. Be aware that this meaningfully increases the time required to load the invitee"s **All Files** page. We recommend you limit the number of collaborations with `can_view_path` enabled to 1,000 per user. Only owner or co-owners can invite collaborators with a `can_view_path` of `true`. `can_view_path` can only be used for folder collaborations.
collaboration_idstringObligatorio
The ID of the collaboration

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update commentBOX_UPDATE_COMMENTAcción

Update the message of a comment.

Parámetros de entrada

fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
messagestring
The text of the comment to update
comment_idstringObligatorio
The ID of the comment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update fileBOX_UPDATE_FILEAcción

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

Parámetros de entrada

namestring
An optional different name for the file. This can be used to rename the file.
tagsstring[]
The tags for this item. These tags are shown in the Box web app and mobile apps next to an item. To add or remove a tag, retrieve the item"s current tags, modify them, and then update this field. There is a limit of 100 tags per item, and 10,000 unique tags per enterprise.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
collectionsobject[]
An array of collections to make this file a member of. Currently we only support the `favorites` collection. To get the ID for a collection, use the [List all collections][1] endpoint. Passing an empty array `[]` or `null` will remove the file from all collections. [1]: e://get-collections
descriptionstring
The description for a file. This can be seen in the right-hand sidebar panel when viewing a file in the Box web app. Additionally, this index is used in the search index of the file, allowing users to find the file by the content in the description.
lock__accessstringenum
The type of this object.
lock
disposition_atstringdate-time
The retention expiration timestamp for the given file. This date cannot be shortened once set on a file.
lock__expires__atstringdate-time
Defines the time at which the lock expires.
permissions__can__downloadstringenum
Defines who is allowed to download this file. The possible values are either `open` for everyone or `company` for the other members of the user"s enterprise. This setting overrides the download permissions that are normally part of the `role` of a collaboration. When set to `company`, this essentially removes the download option for external users with `viewer` or `editor` a roles.
companyopen
lock__is__download__preventedboolean
Defines if the file can be downloaded while it is locked.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update file requestBOX_UPDATE_FILE_REQUESTAcción

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

Parámetros de entrada

titlestring
An optional new title for the file request. This can be used to change the title of the file request. This will default to the value on the existing file request.
statusstringenum
An optional new status of the file request. When the status is set to `inactive`, the file request will no longer accept new submissions, and any visitor to the file request URL will receive a `HTTP 404` status code. This will default to the value on the existing file request.
activeinactive
expires_atstringdate-time
The date after which a file request will no longer accept new submissions. After this date, the `status` will automatically be set to `inactive`. This will default to the value on the existing file request.
descriptionstring
An optional new description for the file request. This can be used to change the description of the file request. This will default to the value on the existing file request.
file_request_idstringObligatorio
The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`.
is_email_requiredboolean
Whether a file request submitter is required to provide their email address. When this setting is set to true, the Box UI will show an email field on the file request form. This will default to the value on the existing file request.
is_description_requiredboolean
Whether a file request submitter is required to provide a description of the files they are submitting. When this setting is set to true, the Box UI will show a description field on the file request form. This will default to the value on the existing file request.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update folderBOX_UPDATE_FOLDERAcción

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

Parámetros de entrada

namestring
The optional new name for this folder.
tagsstring[]
The tags for this item. These tags are shown in the Box web app and mobile apps next to an item. To add or remove a tag, retrieve the item"s current tags, modify them, and then update this field. There is a limit of 100 tags per item, and 10,000 unique tags per enterprise.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.
sync_statestringenum
Specifies whether a folder should be synced to a user"s device or not. This is used by Box Sync (discontinued) and is not used by Box Drive.
not_syncedpartially_syncedsynced
collectionsobject[]
An array of collections to make this folder a member of. Currently we only support the `favorites` collection. To get the ID for a collection, use the [List all collections][1] endpoint. Passing an empty array `[]` or `null` will remove the folder from all collections. [1]: e://get-collections
descriptionstring
The optional description of this folder
can_non_owners_inviteboolean
Specifies if users who are not the owner of the folder can invite new collaborators to the folder.
can_non_owners_view_collaboratorsboolean
Restricts collaborators who are not the owner of this folder from viewing other collaborations on this folder. It also restricts non-owners from inviting new collaborators. When setting this field to `false`, it is required to also set `can_non_owners_invite_collaborators` to `false` if it has not already been set.
is_collaboration_restricted_to_enterpriseboolean
Specifies if new invites to this folder are restricted to users within the enterprise. This does not affect existing collaborations.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update groupBOX_UPDATE_GROUPAcción

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

Parámetros de entrada

namestring
The name of the new group to be created. Must be unique within the enterprise.
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
group_idstringObligatorio
The ID of the group.
provenancestring
Keeps track of which external source this group is coming, for example `Active Directory`, or `Okta`. Setting this will also prevent Box admins from editing the group name and its members directly via the Box web application. This is desirable for one-way syncing of groups.
descriptionstring
A human readable description of the group.
invitability_levelstringenum
Specifies who can invite the group to collaborate on folders. When set to `admins_only` the enterprise admin, co-admins, and the group"s admin can invite the group. When set to `admins_and_members` all the admins listed above and group members can invite the group. When set to `all_managed_users` all managed users in the enterprise can invite the group.
admins_and_membersadmins_onlyall_managed_users
external_sync_identifierstring
An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group. Example values of this field could be an **Active Directory Object ID** or a **Google Group ID**. We recommend you use of this field in order to avoid issues when group names are updated in either Box or external systems.
member_viewability_levelstringenum
Specifies who can see the members of the group. * `admins_only` - the enterprise admin, co-admins, group"s group admin * `admins_and_members` - all admins and group members * `all_managed_users` - all managed users in the enterprise
admins_and_membersadmins_onlyall_managed_users

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update group membershipBOX_UPDATE_GROUP_MEMBERSHIPAcción

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

Parámetros de entrada

rolestringenum
The role of the user in the group.
adminmember
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
group_membership_idstringObligatorio
The ID of the group membership.
configurable_permissionsobject
Custom configuration for the permissions an admin if a group will receive. This option has no effect on members with a role of `member`. Setting these permissions overwrites the default access levels of an admin. Specifying a value of `null` for this object will disable all configurable permissions. Specifying permissions will set them accordingly, omitted permissions will be enabled by default.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update legal hold policyBOX_UPDATE_LEGAL_HOLD_POLICYAcción

Update legal hold policy.

Parámetros de entrada

descriptionstring
A description for the policy.
policy_namestring
The name of the policy.
release_notesstring
Notes around why the policy was released.
legal_hold_policy_idstringObligatorio
The ID of the legal hold policy

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update retention policyBOX_UPDATE_RETENTION_POLICYAcción

Updates a retention policy.

Parámetros de entrada

statusstring
Used to retire a retention policy. If not retiring a policy, do not include this parameter or set it to `null`.
descriptionstring
The additional text description of the retention policy.
policy_namestring
The name for the retention policy
retention_typestring
Specifies the retention type: * `modifiable`: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes. * `non-modifiable`: You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies. When updating a retention policy, you can use `non-modifiable` type only. You can convert a `modifiable` policy to `non-modifiable`, but not the other way around.
retention_lengthstringint32
The length of the retention policy. This value specifies the duration in days that the retention policy will be active for after being assigned to content. If the policy has a `policy_type` of `indefinite`, the `retention_length` will also be `indefinite`.
disposition_actionstringenum
The disposition action of the retention policy. This action can be `permanently_delete`, which will cause the content retained by the policy to be permanently deleted, or `remove_retention`, which will lift the retention policy from the content, allowing it to be deleted by users, once the retention policy has expired. You can use `null` if you don"t want to change `disposition_action`.
permanently_deleteremove_retention
are_owners_notifiedboolean
Determines if owners and co-owners of items under the policy are notified when the retention duration is about to end.
retention_policy_idstringObligatorio
The ID of the retention policy.
can_owner_extend_retentionboolean
Determines if the owner of items under the policy can extend the retention when the original retention duration is about to end.
custom_notification_recipientsobject[]
A list of users notified when the retention duration is about to end.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update shared link on fileBOX_UPDATE_SHARED_LINK_ON_FILEAcción

Updates a shared link on a file.

Parámetros de entrada

fieldsstringObligatorio
Explicitly request the `shared_link` fields to be returned for this item.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
shared__link__accessstringenum
The level of access for the shared link. This can be restricted to anyone with the link (`open`), only people within the company (`company`) and only those who have been invited to the folder (`collaborators`). If not set, this field defaults to the access level specified by the enterprise admin. To create a shared link with this default setting pass the `shared_link` object with no `access` field, for example `{ "shared_link": {} }`. The `company` access level is only available to paid accounts.
collaboratorscompanyopen
shared__link__passwordstring
The password required to access the shared link. Set the password to `null` to remove it. Passwords must now be at least eight characters long and include a number, upper case letter, or a non-numeric or non-alphabetic character. A password can only be set when `access` is set to `open`.
shared__link__unshared__atstringdate-time
The timestamp at which this shared link will expire. This field can only be set by users with paid accounts. The value must be greater than the current date and time.
shared__link__vanity__namestring
Defines a custom vanity name to use in the shared link URL, for example `https://app.box.com/v/my-shared-link`. Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
shared__link__permissions__can__editboolean
If the shared link allows for editing of files. This can only be set when `access` is set to `open` or `company`. This value can only be `true` is `can_download` is also `true`.
shared__link__permissions__can__previewboolean
If the shared link allows for previewing of files. This value is always `true`. For shared links on folders this also applies to any items in the folder.
shared__link__permissions__can__downloadboolean
If the shared link allows for downloading of files. This can only be set when `access` is set to `open` or `company`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update shared link on folderBOX_UPDATE_SHARED_LINK_ON_FOLDERAcción

Updates a shared link on a folder.

Parámetros de entrada

fieldsstringObligatorio
Explicitly request the `shared_link` fields to be returned for this item.
folder_idstringObligatorio
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.
shared__link__accessstringenum
The level of access for the shared link. This can be restricted to anyone with the link (`open`), only people within the company (`company`) and only those who have been invited to the folder (`collaborators`). If not set, this field defaults to the access level specified by the enterprise admin. To create a shared link with this default setting pass the `shared_link` object with no `access` field, for example `{ "shared_link": {} }`. The `company` access level is only available to paid accounts.
collaboratorscompanyopen
shared__link__passwordstring
The password required to access the shared link. Set the password to `null` to remove it. Passwords must now be at least eight characters long and include a number, upper case letter, or a non-numeric or non-alphabetic character. A password can only be set when `access` is set to `open`.
shared__link__unshared__atstringdate-time
The timestamp at which this shared link will expire. This field can only be set by users with paid accounts. The value must be greater than the current date and time.
shared__link__vanity__namestring
Defines a custom vanity name to use in the shared link URL, for example `https://app.box.com/v/my-shared-link`. Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
shared__link__permissions__can__editboolean
This value can only be `false` for items with a `type` of `folder`.
shared__link__permissions__can__previewboolean
If the shared link allows for previewing of files. This value is always `true`. For shared links on folders this also applies to any items in the folder.
shared__link__permissions__can__downloadboolean
If the shared link allows for downloading of files. This can only be set when `access` is set to `open` or `company`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update shared link on web linkBOX_UPDATE_SHARED_LINK_ON_WEB_LINKAcción

Updates a shared link on a web link.

Parámetros de entrada

fieldsstringObligatorio
Explicitly request the `shared_link` fields to be returned for this item.
web_link_idstringObligatorio
The ID of the web link.
shared__link__accessstringenum
The level of access for the shared link. This can be restricted to anyone with the link (`open`), only people within the company (`company`) and only those who have been invited to the folder (`collaborators`). If not set, this field defaults to the access level specified by the enterprise admin. To create a shared link with this default setting pass the `shared_link` object with no `access` field, for example `{ "shared_link": {} }`. The `company` access level is only available to paid accounts.
collaboratorscompanyopen
shared__link__passwordstring
The password required to access the shared link. Set the password to `null` to remove it. Passwords must now be at least eight characters long and include a number, upper case letter, or a non-numeric or non-alphabetic character. A password can only be set when `access` is set to `open`.
shared__link__unshared__atstringdate-time
The timestamp at which this shared link will expire. This field can only be set by users with paid accounts. The value must be greater than the current date and time.
shared__link__vanity__namestring
Defines a custom vanity name to use in the shared link URL, for example `https://app.box.com/v/my-shared-link`. Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
shared__link__permissions__can__editboolean
This value can only be `true` is `type` is `file`.
shared__link__permissions__can__previewboolean
If the shared link allows for previewing of files. This value is always `true`. For shared links on folders this also applies to any items in the folder.
shared__link__permissions__can__downloadboolean
If the shared link allows for downloading of files. This can only be set when `access` is set to `open` or `company`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update shield information barrier segment with specified idBOX_UPDATE_SHIELD_INFORMATION_BARRIER_SEGMENT_WITH_SPECIFIED_IDAcción

Update shield information barrier segment with specified id

Parámetros de entrada

namestring
The updated name for the shield information barrier segment.
descriptionstring
The updated description for the shield information barrier segment.
shield_information_barrier_segment_idstringObligatorio
The ID of the shield information barrier segment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update slack integration mappingBOX_UPDATE_SLACK_INTEGRATION_MAPPINGAcción

Updates a [slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-box-as-the-content-layer-for-slack). supports updating the box folder id and options. you need admin or co-admin role to use this endpoint.

Parámetros de entrada

integration_mapping_idstringObligatorio
An ID of an integration mapping

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update storage policy assignmentBOX_UPDATE_STORAGE_POLICY_ASSIGNMENTAcción

Updates a specific storage policy assignment.

Parámetros de entrada

storage__policy__idstring
The ID of the storage policy to assign.
storage__policy__typestringenum
The type to assign.
storage_policy
storage_policy_assignment_idstringObligatorio
The ID of the storage policy assignment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update taskBOX_UPDATE_TASKAcción

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

Parámetros de entrada

actionstringenum
The action the task assignee will be prompted to do. Must be * `review` defines an approval task that can be approved or rejected * `complete` defines a general task which can be completed
completereview
due_atstringdate-time
When the task is due at.
messagestring
The message included with the task.
task_idstringObligatorio
The ID of the task.
completion_rulestringenum
Defines which assignees need to complete this task before the task is considered completed. * `all_assignees` (default) requires all assignees to review or approve the the task in order for it to be considered completed. * `any_assignee` accepts any one assignee to review or approve the the task in order for it to be considered completed.
all_assigneesany_assignee

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update task assignmentBOX_UPDATE_TASK_ASSIGNMENTAcción

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

Parámetros de entrada

messagestring
An optional message by the assignee that can be added to the task.
resolution_statestringenum
The state of the task assigned to the user. * For a task with an `action` value of `complete` this can be `incomplete` or `completed`. * For a task with an `action` of `review` this can be `incomplete`, `approved`, or `rejected`.
approvedcompletedincompleterejected
task_assignment_idstringObligatorio
The ID of the task assignment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update teams integration mappingBOX_UPDATE_TEAMS_INTEGRATION_MAPPINGAcción

Updates a [teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-using-box-for-teams). supports updating the box folder id and options. you need admin or co-admin role to use this endpoint.

Parámetros de entrada

integration_mapping_idstringObligatorio
An ID of an integration mapping

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update terms of serviceBOX_UPDATE_TERMS_OF_SERVICEAcción

Updates a specific terms of service.

Parámetros de entrada

textstringObligatorio
The terms of service text to display to users. The text can be set to empty if the `status` is set to `disabled`.
statusstringObligatorioenum
Whether this terms of service is active.
disabledenabled
terms_of_service_idstringObligatorio
The ID of the terms of service.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update terms of service status for existing userBOX_UPDATE_TERMS_OF_SERVICE_STATUS_FOR_EXISTING_USERAcción

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

Parámetros de entrada

is_acceptedbooleanObligatorio
Whether the user has accepted the terms.
terms_of_service_user_status_idstringObligatorio
The ID of the terms of service status.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update userBOX_UPDATE_USERAcción

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

Parámetros de entrada

namestring
The name of the user
rolestringenum
The user’s enterprise role
coadminuser
loginstring
The email address the user uses to log in Note: If the target user"s email is not confirmed, then the primary login address cannot be changed.
phonestring
The user’s phone number
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
notifyboolean
Whether the user should receive an email when they are rolled out of an enterprise
statusstringenum
The user"s account status
activecannot_delete_editcannot_delete_edit_uploadinactive
addressstring
The user’s address
user_idstringObligatorio
The ID of the user.
languagestring
The language of the user, formatted in modified version of the [ISO 639-1](/guides/api-calls/language-codes) format.
timezonestringtimezone
The user"s timezone
job_titlestring
The user’s job title
enterprisestring
Set this to `null` to roll the user out of the enterprise and make them a free user
space_amountinteger
The user’s total available space in bytes. Set this to `-1` to indicate unlimited storage.
tracking_codesobject[]
Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. This setting must be enabled for an enterprise before it can be used.
is_sync_enabledboolean
Whether the user can use Box Sync
external_app_user_idstring
An external identifier for an app user, which can be used to look up the user. This can be used to tie user IDs from external identity providers to Box users. Note: In order to update this field, you need to request a token using the application that created the app user.
can_see_managed_usersboolean
Whether the user can see other enterprise users in their contact list
is_password_reset_requiredboolean
Whether the user is required to reset their password
notification__email__emailstring
The email address to send the notifications to.
is_exempt_from_device_limitsboolean
Whether to exempt the user from enterprise device limits
is_external_collab_restrictedboolean
Whether the user is allowed to collaborate with users outside their enterprise
is_exempt_from_login_verificationboolean
Whether the user must use two-factor authentication

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update webhookBOX_UPDATE_WEBHOOKAcción

Updates a webhook.

Parámetros de entrada

addressstring
The URL that is notified by this webhook
triggersstring[]
An array of event names that this webhook is to be triggered for
target__idstring
The ID of the item to trigger a webhook
webhook_idstringObligatorio
The ID of the webhook.
target__typestringenum
The type of item to trigger a webhook
filefolder

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update web linkBOX_UPDATE_WEB_LINKAcción

Updates a web link object.

Parámetros de entrada

urlstring
The new URL that the web link links to. Must start with `"http://"` or `"https://"`.
namestring
A new name for the web link. Defaults to the URL if not set.
descriptionstring
A new description of the web link.
web_link_idstringObligatorio
The ID of the web link.
shared__link__accessstringenum
The level of access for the shared link. This can be restricted to anyone with the link (`open`), only people within the company (`company`) and only those who have been invited to the folder (`collaborators`). If not set, this field defaults to the access level specified by the enterprise admin. To create a shared link with this default setting pass the `shared_link` object with no `access` field, for example `{ "shared_link": {} }`. The `company` access level is only available to paid accounts.
collaboratorscompanyopen
shared__link__passwordstring
The password required to access the shared link. Set the password to `null` to remove it. Passwords must now be at least eight characters long and include a number, upper case letter, or a non-numeric or non-alphabetic character. A password can only be set when `access` is set to `open`.
shared__link__unshared__atstringdate-time
The timestamp at which this shared link will expire. This field can only be set by users with paid accounts. The value must be greater than the current date and time.
shared__link__vanity__namestring
Defines a custom vanity name to use in the shared link URL, for example `https://app.box.com/v/my-shared-link`. Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload fileBOX_UPLOAD_FILEAcción

Uploads a small file to box. for file sizes over 50mb we recommend using the chunk upload apis. the `attributes` part of the body must come **before** the `file` part. requests that do not follow this format when uploading the file will receive a http `400` error with a `metadata after file contents` error code.

Parámetros de entrada

fileobjectbinary
File
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
attributesobject
Attributes

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload file versionBOX_UPLOAD_FILE_VERSIONAcción

Update a file's content. for file sizes over 50mb we recommend using the chunk upload apis. the `attributes` part of the body must come **before** the `file` part. requests that do not follow this format when uploading the file will receive a http `400` error with a `metadata after file contents` error code.

Parámetros de entrada

fileobjectbinary
File
fieldsstring[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
file_idstringObligatorio
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
attributesobject
Attributes

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload part of fileBOX_UPLOAD_PART_OF_FILEAcción

Uploads a chunk of a file for an upload session. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) and [`get upload session`](e://get-files-upload-sessions-id) endpoints.

Parámetros de entrada

fileobject
Path to file
upload_session_idstringObligatorio
The ID of the upload session.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Triggers (20)

Los triggers son eventos externos que pueden iniciar un flujo en tus agentes (ej: nuevo email, mensaje recibido, registro creado).

Collaboration Details ChangedBOX_COLLABORATION_DETAILS_CHANGED_TRIGGERTrigger

Triggers when a collaboration's details change (e.g., role, status, expiration). This trigger monitors a specific collaboration and detects when any meaningful field changes, such as role, status, expiration date, access type, or acknowledgment status.

Configuración

collaboration_idstringObligatorio
The unique identifier of the collaboration to monitor for changes. This is a numeric string ID returned when creating or listing collaborations (e.g., '69886391395').
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload del evento

changed_fieldsstring[]
List of field names that changed (e.g., 'role', 'status', 'expires_at')
collaborationobjectObligatorio
The collaboration with updated details
current_valuesobject
Current values of changed fields
event_typestring
Type of event that occurred
previous_valuesobject
Previous values of changed fields

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific collaboration for changes to its details. - You must provide a collaboration_id to monitor that specific collaboration. - The trigger will detect when meaningful fields change, including: - role: Changes in permission level (viewer, editor, co-owner, etc.) - status: Changes in collaboration status (pending, accepted, rejected) - expires_at: Changes to expiration date - is_access_only: Changes to access-only setting - acknowledged_at: When the collaboration is acknowledged - modified_at: When any modification occurs - You can get collaboration IDs from listing collaborations on files/folders.

Comment ChangedBOX_COMMENT_CHANGED_TRIGGERTrigger

Triggers when a comment's content or details change in Box. This trigger monitors a specific Box comment and detects when any meaningful field changes, such as message text edits, tagged message changes, or modification timestamp updates.

Configuración

comment_idstringObligatorio
The unique identifier of the comment to monitor for changes. Comment IDs can be obtained from the 'list_file_comments' action or when creating a comment. Example: '12345678'.
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload del evento

changed_fieldsstring[]
List of field names that changed (e.g., 'message', 'modified_at')
commentobjectObligatorio
The comment with updated content
current_valuesobject
Current values of changed fields
event_typestring
Type of event that occurred
previous_valuesobject
Previous values of changed fields

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific comment for changes to its content or details. - You must provide a comment_id to monitor that specific comment. - The trigger will detect when meaningful fields change, including: - message: Changes to the comment text - tagged_message: Changes to mentions in the comment - modified_at: When the comment was last modified - You can get comment IDs from the 'list_file_comments' action or when creating comments. **Example Use Cases:** - Track when important comments are edited - Monitor changes to feedback or review comments - Detect updates to collaboration discussions

New File Comment AddedBOX_FILE_COMMENT_ADDED_TRIGGERTrigger

Triggers when a new comment is added to a file in Box. This trigger monitors a specific Box file and fires when new comments are detected.

Configuración

file_idstringObligatorio
The unique identifier of the file to monitor for new comments. File IDs can be obtained from file URLs or from actions like 'list_items_in_folder'. Example: '2090489102308'.
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
limitinteger
Maximum number of comments to check in each poll (default: 100)

Payload del evento

commentobjectObligatorio
The newly added comment
event_typestring
Type of event that occurred

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Box file for newly added comments. - You must provide the file_id of the file you want to monitor. - The trigger will detect new comments added after the trigger is set up. - The file_id can be obtained from the file URL or from actions like 'list_items_in_folder'. - Example file_id: '2090489102308' **Example Use Cases:** - Get notified when someone comments on a shared document - Track feedback and discussions on important files - Monitor collaboration activity on specific files

File Metadata ChangedBOX_FILE_METADATA_CHANGED_TRIGGERTrigger

Triggers when a file's metadata or properties change in Box. This trigger monitors a specific Box file and fires when changes are detected in key fields like name, description, size, modification time, parent folder, or status.

Configuración

file_idstringObligatorio
The unique identifier of the file to monitor for metadata or property changes. File IDs can be obtained from the 'upload_file', 'list_items_in_folder', or 'search_for_content' actions. Example: '2119320206124'.
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload del evento

changed_fieldsstring[]
List of field names that changed in this update
event_typestring
Type of event that occurred
fileobjectObligatorio
The file with updated metadata

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Box file for metadata or property changes. - You must provide the file_id of the file you want to monitor. - The trigger will detect changes in: - File name - File description - File size (when a new version is uploaded) - File modification time - File version (sha1, version ID) - Parent folder (when file is moved) - Item status (active, trashed, deleted) - File etag and sequence_id - Content creation/modification timestamps - Owner or modifier information - The file_id can be obtained from the 'upload_file', 'list_items_in_folder', or 'search_for_content' actions. - Example file_id: '2119320206124' **Example Use Cases:** - Get notified when a file is renamed - Track when a file is moved to a different folder - Monitor when a new version of a file is uploaded - Detect when a file's description is updated - Alert when a file is moved to trash

File Shared Link ChangedBOX_FILE_SHARED_LINK_CHANGED_TRIGGERTrigger

Triggers when a file's shared link settings change in Box. This trigger monitors a specific Box file's shared link and fires when changes are detected in the shared link configuration, such as access level, permissions, password protection, expiration date, or vanity URL.

Configuración

file_idstringObligatorio
The unique identifier of the file to monitor for shared link changes. File IDs can be obtained from the 'upload_file', 'list_items_in_folder', or 'search_for_content' actions. Example: '2090483963494'.
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload del evento

change_typestringObligatorio
Type of change: 'created', 'modified', or 'removed'
changed_fieldsstring[]
List of shared link field names that changed
event_typestring
Type of event that occurred
file_idstringObligatorio
The unique identifier of the file
file_namestringObligatorio
The name of the file
shared_linkobject
Shared link information for the file.

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Box file for shared link setting changes. - You must provide the file_id of the file you want to monitor. - The trigger will detect changes in: - Shared link creation (when shared link is added to a file) - Shared link removal (when shared link is disabled/removed) - Access level (open, company, collaborators) - Permissions (can_download, can_preview, can_edit) - Password protection (is_password_enabled) - Expiration date (unshared_at) - Vanity URL settings (vanity_url, vanity_name) - Effective access and permissions - The file_id can be obtained from 'upload_file', 'list_items_in_folder', or 'search_for_content' actions. - Example file_id: '2090483963494' **Example Use Cases:** - Get notified when a file's shared link is created or removed - Track when shared link access level changes - Monitor when shared link permissions are modified - Alert when a shared link expiration is set or changed - Detect when password protection is enabled/disabled

New File Version UploadedBOX_FILE_VERSION_UPLOADED_TRIGGERTrigger

Triggers when a new file version is uploaded to a file in Box. This trigger monitors a specific Box file and fires when new versions are detected.

Configuración

file_idstringObligatorio
The unique identifier of the file to monitor for new versions. The ID for any file can be determined by visiting this file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
limitinteger
Maximum number of versions to check in each poll (1-1000)

Payload del evento

event_typestring
Type of event that occurred
file_idstringObligatorio
The ID of the file this version belongs to
file_versionobjectObligatorio
The newly uploaded file version

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Box file for newly uploaded versions. - You must provide the file_id of the file you want to monitor. - The trigger will detect new file versions uploaded after the trigger is set up. - The file_id can be obtained from the file URL in Box (e.g., '123' from 'https://*.app.box.com/files/123'). - You can optionally set the limit to control how many versions to check in each poll (default: 100). - Note: Box only tracks versions for users with premium accounts. **Example Use Cases:** - Get notified when a document is updated with a new version - Track when contracts or agreements are revised - Monitor when design files receive new iterations - Automate workflows when important files are updated

New Item Added to FolderBOX_FOLDER_ITEM_ADDED_TRIGGERTrigger

Triggers when a new item (file, folder, or web link) is added to a folder in Box. This trigger monitors a specific Box folder and fires when new items are detected.

Configuración

folder_idstringObligatorio
The unique identifier of the folder to monitor for new items. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
limitinteger
Maximum number of items to check in each poll (1-1000)

Payload del evento

event_typestring
Type of event that occurred
itemobjectObligatorio
The newly added item

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Box folder for newly added items (files, folders, or web links). - You must provide the folder_id of the folder you want to monitor. - The trigger will detect new items added after the trigger is set up. - The folder_id can be obtained from the folder URL in Box (e.g., '123' from 'https://*.app.box.com/folder/123'). - Use folder_id '0' to monitor the root folder. - You can optionally set the limit to control how many items to check in each poll (default: 100). **Example Use Cases:** - Get notified when new files are uploaded to a shared folder - Track when new folders are created in a project directory - Monitor when new web links are added to a resource folder - Automate workflows when documents are added to specific folders

Folder Properties ChangedBOX_FOLDER_PROPERTIES_CHANGED_TRIGGERTrigger

Triggers when a folder's core properties change in Box. This trigger monitors a specific Box folder and fires when changes are detected in properties like name, description, modification time, parent folder, item status, or shared link settings.

Configuración

folder_idstringObligatorio
The unique identifier of the folder to monitor for property changes. Folder IDs can be obtained from actions like 'create_folder', 'list_items_in_folder', or 'search_for_content'. The root folder is always represented by ID '0'. Example: '353353898191'.
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload del evento

changed_fieldsstring[]
List of property field names that changed.
descriptionstring
Current folder description.
event_typestring
Type of event that occurred.
folder_idstringObligatorio
The unique identifier of the folder.
folder_namestringObligatorio
The current name of the folder.
item_statusstring
Current item status: 'active', 'trashed', or 'deleted'.
modified_atstring
Last modification timestamp.
namestring
Current folder name.
parentobject
Schema for folder mini representation.
shared_linkobject
Shared link information for the folder.

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Box folder for core property changes. - You must provide the folder_id of the folder you want to monitor. - The trigger will detect changes in: - **name**: When the folder is renamed - **description**: When the folder description is updated - **modified_at**: When the folder's last modified timestamp changes - **parent**: When the folder is moved to a different parent folder - **item_status**: When the folder status changes (active → trashed, etc.) - **shared_link**: When any shared link property changes (creation, removal, or modification) - The folder_id can be obtained from actions like 'create_folder', 'list_items_in_folder', or 'search_for_content'. - The root folder is always represented by ID '0'. - Example folder_id: '353353898191' **Example Use Cases:** - Get notified when a folder is renamed - Track when a folder's description is updated - Monitor when a folder is moved to a different location - Detect when a folder is moved to trash - Alert when shared link settings change for a folder - Track folder modification times for audit purposes

Folder Shared Link ChangedBOX_FOLDER_SHARED_LINK_CHANGED_TRIGGERTrigger

Triggers when a folder's shared link settings change in Box. This trigger monitors a specific Box folder's shared link and fires when changes are detected in the shared link configuration, such as access level, permissions, password protection, expiration date, or vanity URL.

Configuración

folder_idstringObligatorio
The unique identifier of the folder to monitor for shared link changes. Folder IDs can be obtained from the 'create_folder', 'list_items_in_folder', or 'search_for_content' actions. The root folder is always represented by ID '0'. Example: '353353898191'.
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload del evento

change_typestringObligatorio
Type of change: 'created', 'modified', or 'removed'
changed_fieldsstring[]
List of shared link field names that changed
event_typestring
Type of event that occurred
folder_idstringObligatorio
The unique identifier of the folder
folder_namestringObligatorio
The name of the folder
shared_linkobject
Shared link information for the folder.

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Box folder for shared link setting changes. - You must provide the folder_id of the folder you want to monitor. - The trigger will detect changes in: - Shared link creation (when shared link is added to a folder) - Shared link removal (when shared link is disabled/removed) - Access level (open, company, collaborators) - Permissions (can_download, can_preview, can_edit) - Password protection (is_password_enabled) - Expiration date (unshared_at) - Vanity URL settings (vanity_url, vanity_name) - Effective access and permissions - The folder_id can be obtained from 'create_folder', 'list_items_in_folder', or 'search_for_content' actions. - The root folder is always represented by ID '0'. - Example folder_id: '353353898191' **Example Use Cases:** - Get notified when a folder's shared link is created or removed - Track when shared link access level changes - Monitor when shared link permissions are modified - Alert when a shared link expiration is set or changed - Detect when password protection is enabled/disabled

New File Added to FolderBOX_NEW_FILE_ADDED_TRIGGERTrigger

Triggers when a new file is added to a folder in Box. This trigger monitors a specific Box folder and fires when new files are detected. Only files (not folders or web links) are monitored.

Configuración

folder_idstringObligatorio
The unique identifier of the folder to monitor for new files. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`.
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
limitinteger
Maximum number of items to check in each poll (1-1000)

Payload del evento

event_typestring
Type of event that occurred
fileobjectObligatorio
The newly added file

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Box folder for newly added files. - You must provide the folder_id of the folder you want to monitor. - The trigger will detect new files added after the trigger is set up. - The folder_id can be obtained from the folder URL in Box (e.g., '123' from 'https://*.app.box.com/folder/123'). - Use folder_id '0' to monitor the root folder. - You can optionally set the limit to control how many items to check in each poll (default: 100). - Note: This trigger only detects files, not folders or web links. **Example Use Cases:** - Get notified when new documents are uploaded to a shared folder - Track when new reports are added to a project directory - Monitor when new images are uploaded to a media folder - Automate workflows when files are added to specific folders

New Folder Collaboration CreatedBOX_NEW_FOLDER_COLLABORATION_CREATED_TRIGGERTrigger

Triggers when a new collaboration is created on a specific folder in Box. This trigger monitors a specific Box folder and fires when new collaborations are detected.

Configuración

folder_idstringObligatorio
The unique identifier of the folder to monitor for collaborations. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
limitinteger
Maximum number of collaborations to check in each poll (1-1000)

Payload del evento

collaborationobjectObligatorio
The newly created folder collaboration
event_typestring
Type of event that occurred

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Box folder for newly created collaborations. - You must provide the folder_id of the folder you want to monitor. - The trigger will detect new collaborations added after the trigger is set up. - The folder_id can be found in the URL when viewing the folder in Box web application. - Example folder_id: '123456789' **Example Use Cases:** - Get notified when someone is given access to a sensitive folder - Track when new team members are added to project folders - Monitor collaboration changes for compliance purposes - Receive alerts when external users are granted folder access

New Pending Collaboration InviteBOX_NEW_PENDING_COLLABORATION_TRIGGERTrigger

Triggers when a new pending collaboration invite is created. This trigger monitors the user's pending collaborations and fires when new pending collaboration invites are detected.

Configuración

intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
limitinteger
Maximum number of pending collaborations to check in each poll (1-1000)

Payload del evento

collaborationobjectObligatorio
The new pending collaboration invite
event_typestring
Type of event that occurred

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors your Box account for new pending collaboration invites. - It will detect new collaboration invites that are in "pending" status. - The trigger will fire when someone invites you to collaborate on a file or folder. - You can configure the maximum number of pending collaborations to check in each poll. **Example Use Cases:** - Get notified when someone invites you to collaborate on a document - Track collaboration requests that need your acceptance - Monitor collaboration invites across your organization

New Sign Request CreatedBOX_NEW_SIGN_REQUEST_CREATED_TRIGGERTrigger

Triggers when a new Box sign request is created. This trigger monitors Box sign requests and fires when new sign requests are detected.

Configuración

intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
limitinteger
Maximum number of sign requests to check in each poll (1-1000)

Payload del evento

event_typestring
Type of event that occurred
sign_requestobjectObligatorio
The newly created Box sign request

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors Box sign requests for newly created requests. - The trigger will detect sign requests created after the trigger is set up. - Use limit to control how many sign requests to check in each poll (default: 100).

New Task Assignment AddedBOX_NEW_TASK_ASSIGNMENT_TRIGGERTrigger

Triggers when a new assignment is added to a task in Box. This trigger monitors a specific Box task and fires when new assignments are detected.

Configuración

intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
task_idstringObligatorio
The unique identifier of the task to monitor for new assignments. Task IDs can be obtained from the 'create_task' or 'list_tasks_on_file' actions. Example: '39641675308'.

Payload del evento

event_typestring
Type of event that occurred
task_assignmentobjectObligatorio
The newly added task assignment

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Box task for newly added assignments. - You must provide the task_id of the task you want to monitor. - The trigger will detect new assignments added after the trigger is set up. - The task_id can be obtained from the 'create_task' or 'list_tasks_on_file' actions. - Example task_id: '39641675308' **Example Use Cases:** - Get notified when someone is assigned to a review task - Track when team members are assigned to collaboration tasks - Monitor task delegation in your Box workflow

New Task Created on FileBOX_NEW_TASK_CREATED_TRIGGERTrigger

Triggers when a new task is created on a Box file. This trigger monitors a specific Box file and fires when new tasks are detected.

Configuración

file_idstringObligatorio
The unique identifier of the file to monitor for new tasks. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload del evento

event_typestring
Type of event that occurred
taskobjectObligatorio
The newly created task on the file

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Box file for newly created tasks. - You must provide the file_id of the file you want to monitor. - The trigger will detect new tasks created after the trigger is set up. - The file_id can be obtained from the Box web application URL or by using file listing actions. - Example file_id: '123456789' **Example Use Cases:** - Get notified when a review task is created on a document - Track when collaboration tasks are assigned to a file - Monitor approval workflows on important files

Box Sign Request Status ChangedBOX_SIGN_REQUEST_STATUS_CHANGED_TRIGGERTrigger

Triggers when a Box Sign request's status or meaningful fields change. This trigger monitors a specific Box Sign request and fires when changes are detected in key fields like status, signer decisions, document readiness, or completion state.

Configuración

intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
sign_request_idstringObligatorio
The unique identifier (UUID) of the Box Sign request to monitor for status or detail changes. This ID can be obtained from the response when creating a sign request or by listing all sign requests. Example: 'c5c832e7-b890-4a48-96f5-27ce66d1e3b9'.

Payload del evento

changed_fieldsstring[]
List of field names that changed in this update
event_typestring
Type of event that occurred
sign_requestobjectObligatorio
The Box Sign request with updated state

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Box Sign request for status or detail changes. - You must provide the sign_request_id of the sign request you want to monitor. - The trigger will detect changes in: - Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, etc.) - Signer decisions (signed, declined) - Document readiness (is_ready_for_download) - Signer view status (has_viewed_document) - Completion timestamp (finished_at) - Expiration date changes - Email subject or message updates - The sign_request_id can be obtained from the 'BOX_CREATE_BOX_SIGN_REQUEST' or 'BOX_LIST_BOX_SIGN_REQUESTS' actions. - Example sign_request_id: 'c5c832e7-b890-4a48-96f5-27ce66d1e3b9' **Example Use Cases:** - Get notified when all signers have signed a document - Track when a signer declines a signature request - Monitor when documents are ready for download after signing - Detect when a sign request is cancelled or expires - Track when signers view the document

Task Assignment State ChangedBOX_TASK_ASSIGNMENT_STATE_CHANGED_TRIGGERTrigger

Triggers when a task assignment's state changes. This trigger monitors task assignments for a specific task and detects when the resolution_state changes (e.g., from incomplete to completed, or from completed to approved/rejected).

Configuración

intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
task_idstringObligatorio
The unique identifier of the task to monitor for assignment state changes. Task IDs can be obtained from the 'create_task' or 'list_tasks_on_file' actions.

Payload del evento

assignmentobjectObligatorio
The task assignment with updated state
current_statestring
The current resolution state of the assignment
event_typestring
Type of event that occurred
previous_statestring
The previous resolution state of the assignment

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors task assignments for state changes. - You must provide a task_id to monitor assignments for that specific task. - The trigger will detect when assignment states change (incomplete, completed, approved, rejected). - The trigger fires when any field in the assignment changes, with focus on resolution_state.

Task State ChangedBOX_TASK_STATE_CHANGED_TRIGGERTrigger

Triggers when a task's status or details change in Box. This trigger monitors a specific Box task and fires when changes are detected in key fields like status, due date, message, or completion state.

Configuración

intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
task_idstringObligatorio
The unique identifier of the task to monitor for status or detail changes. Task IDs can be obtained from the 'create_task' or 'list_tasks_on_file' actions. Example: '39641675308'.

Payload del evento

changed_fieldsstring[]
List of field names that changed in this update
event_typestring
Type of event that occurred
taskobjectObligatorio
The task with updated state

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Box task for status or detail changes. - You must provide the task_id of the task you want to monitor. - The trigger will detect changes in: - Task completion status (is_completed) - Due date (due_at) - Task message - Task action type (review/complete) - Completion rule (all_assignees/any_assignee) - Number of assignments - The task_id can be obtained from the 'create_task' or 'list_tasks_on_file' actions. - Example task_id: '39641675308' **Example Use Cases:** - Get notified when a task is marked as completed - Track when task due dates are changed - Monitor when task messages or instructions are updated - Detect when task completion rules change

Trashed File State ChangedBOX_TRASHED_FILE_STATE_CHANGED_TRIGGERTrigger

Triggers when a file's trash state changes in Box. This trigger monitors a specific Box file and fires when its trash state changes (e.g., moved to trash or restored from trash).

Configuración

file_idstringObligatorio
The unique identifier of the file to monitor for trash state changes. The file ID can be obtained from the 'get_file_information' or 'list_items_in_folder' actions. Example: '2119317417511'.
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload del evento

changed_fieldsstring[]
List of field names that changed in this update
current_statestring
Current item_status value ('active', 'trashed', or 'deleted')
event_typestring
Type of event that occurred
fileobjectObligatorio
The file with updated trash state
previous_statestring
Previous item_status value ('active', 'trashed', or 'deleted')

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Box file for trash state changes. - You must provide the file_id of the file you want to monitor. - The trigger will detect changes in: - item_status (active, trashed, deleted) - trashed_at timestamp - purged_at timestamp - The file_id can be obtained from the 'get_file_information' or 'list_items_in_folder' actions. - Example file_id: '2119317417511' **Example Use Cases:** - Get notified when a file is moved to trash - Track when a file is restored from trash - Monitor when a file's trash state changes - Detect when a file is permanently deleted

Trashed Folder State ChangedBOX_TRASHED_FOLDER_STATE_CHANGED_TRIGGERTrigger

Triggers when a folder's trash state changes in Box. This trigger monitors a specific Box folder and fires when its trash state changes (e.g., moved to trash or restored from trash).

Configuración

folder_idstringObligatorio
The unique identifier of the folder to monitor for trash state changes. The folder ID can be obtained from the 'get_folder_information' or 'list_items_in_folder' actions. Example: '353353898191'.
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload del evento

changed_fieldsstring[]
List of field names that changed in this update
current_statestring
Current item_status value ('active', 'trashed', or 'deleted')
event_typestring
Type of event that occurred
folderobjectObligatorio
The folder with updated trash state
previous_statestring
Previous item_status value ('active', 'trashed', or 'deleted')

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Box folder for trash state changes. - You must provide the folder_id of the folder you want to monitor. - The trigger will detect changes in: - item_status (active, trashed, deleted) - trashed_at timestamp - purged_at timestamp - The folder_id can be obtained from the 'get_folder_information' or 'list_items_in_folder' actions. - Example folder_id: '353353898191' **Example Use Cases:** - Get notified when a folder is moved to trash - Track when a folder is restored from trash - Monitor when a folder's trash state changes - Detect when a folder is permanently deleted