Box

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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