> ## Documentation Index > Fetch the complete documentation index at: https://developer.box.com/llms.txt > Use this file to discover all available pages before exploring further. # Methods and Operations > Reference for Box for Salesforce Developer Toolkit methods and operations. export const MultiRelatedLinks = ({sections = []}) => { if (!sections || sections.length === 0) { return null; } return
{sections.map((section, index) => )}
; }; export const RelatedLinks = ({title, items = []}) => { const getBadgeClass = badge => { if (!badge) return "badge-default"; const badgeType = badge.toLowerCase().replace(/\s+/g, "-"); return `badge-${badge === "ガイド" ? "guide" : badgeType}`; }; if (!items || items.length === 0) { return null; } return
{}

{title}

{}
{items.map((item, index) => {} {item.badge} {} {item.label} )}
; }; export const Link = ({href, children, className, ...props}) => { const localizedHref = localizeLink(href); return {children} ; }; ## Toolkit Details Class Name: `box.Toolkit` ## Instance Variables ### `mostRecentError` String to indicate the most recent error that occurred when calling instance methods. The presence of this string does not mean the operation did not succeed. It is possible the error was recoverable; however, the lack of a value in this string does indicate the operation was successful. ### `Enum CollaborationType` Enum to indicate the [type of collaboration][collab-type]. Possible values: `EDITOR`, `VIEWER`, `PREVIEWER`, `UPLOADER`, `COOWNER`, `OWNER`, `PREVIEWERUPLOADER`, or `VIEWERUPLOADER` ## Static Methods ### `deleteServiceUserAssociation` Method to clear association between Service Account and Box for Salesforce integration. This can be used to change the service account if an incorrect one is being used. Parameters: * None Returns: * `true` if the user's account existed and was deleted. * `false` if the user's account was not deleted for any reason (including because it didn't exist). ### `deleteUserAssociation` | Parameter | Type | Description | | --------- | ---- | ------------------------------------------------------- | | `userId` | id | The ID of the user whose credentials are to be cleared. | Returns: * `true` if the user's account existed and was deleted. * `false` if the user's account was not deleted for any reason (including because it didn't exist). ## Instance Methods - Constructors, Destructors ### `box.Toolkit()` Parameters: * None ### `commitChanges` Treat this method as a destructor for the `box.Toolkit()` method. This method is critical. It must be called after all folder / collaboration operations are complete. Every time. No Exceptions. Since Salesforce doesn't allow callouts after database updates / inserts / deletes have occurred, the Toolkit class maintains some collections of objects to be inserted once all callout operations are complete. If this method is not called, those objects won't be in the database, and the tables that keep track of user / record / folder associations will be out of sync and will need some advanced debugging to fix. Parameters: * None Returns: * `Void` ### `commitChanges` with platform event Treat this method as a destructor for the `box.Toolkit()` method. This method is very similar to the `commitChanges` above. However, it uses a platform event to commit changes to the database to perform DML statements in a different transaction and avoid governor limits in some scenarios. | Parameter | Type | Description | | ------------------ | --------- | ----------------------------------------------------------------------------- | | `usePlatformEvent` | `boolean` | `true` if you're using a platform event. `false` to call the original method. | Returns: * `Void` ## Generic Methods The Box for Salesforce Developer Toolkit provides a global method that accepts an [HttpRequest][sf-httprequest] object as a parameter and returns an [HttpResponse][sf-httpresponse] object. This method uses the authentication details of the Service Account to make callouts to Box's APIs, allowing you to focus on the business logic of your integration. ### `sendRequest` | Parameter | Type | Description | | --------- | ----------------------------- | ----------------------------------------------------- | | `request` | [HttpRequest][sf-httprequest] | An HttpRequest object with a set endpoint and method. | Returns: * An [HttpResponse][sf-httpresponse] object with the response details from calling Box's APIs. * `Toolkit.BoxApiException` if there is any missing information from the HttpRequest input. * `null` if there was an issue getting the authentication details for the Service Account. In this case, check `mostRecentError`. ## File Operations ### `createFileFromAttachment` Available in version 3.46 and above. Salesforce has a String length limit of 6 million characters. Due to string bloat in the base64 encoding/decoding process, this results in an effective file size limit of 4.3 megabytes for synchronous Apex and 8.6 megabytes for asynchronous Apex. | Parameter | Type | Description | | ------------------ | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `att` | `Attachment` | The attachment to be converted into a File in Box. | | `fileNameOverride` | `string` | Optional - Name of the new file. If no value is passed in, the name of the attachment is used. | | `folderIdOverride` | `string` | Optional - Box folder ID to place this attachment in. If no value is passed in, the file will be placed in the folder associated with the record that is the `parentId` of the attachment. If the record-specific folder doesn't exist, it will be created. | | `accessToken` | `string` | Optional - if `accessToken` is sent, that value is used for the Box API call. Otherwise, the default account credentials are used. | Returns: * `string` returned is the ID of the Box file that was created. * `null` if there was an error. In this case, check `mostRecentError`. ### `pushFileToBox` Uploads a Salesforce Files `ContentVersion` record to a Box folder. The maximum supported file size is 25 MB, or 26,214,400 bytes. Files exceeding this limit are rejected with an error message showing the file name and size. | Parameter | Type | Required | Description | | ---------- | -------- | -------- | ------------------------------------------------ | | `cvId` | `id` | Yes | The Salesforce `ContentVersion` ID to upload. | | `folderId` | `string` | Yes | The Box folder ID where the file will be placed. | Returns: * `PartnerSyncResponse` object with the upload details. * `null` if the upload fails. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication. * It validates that the `ContentVersion` exists before attempting the upload. * It checks the file size before upload so unsupported files fail early. * Box API and rate-limit errors are surfaced through `mostRecentError`. * Check `mostRecentError` when the method returns `null`. ### `createFileShareLink` Creates a shared link for a Box file. | Parameter | Type | Required | Description | | --------- | -------- | -------- | -------------------------------------------- | | `fileId` | `string` | Yes | The Box file ID to create a shared link for. | Returns: * `string` returned is the shared link URL. * `null` if the shared link is not created. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication. * It creates the shared link with the default Box permissions. * Check `mostRecentError` when the method returns `null`. ### `moveFile` Moves a Box file to a different folder. | Parameter | Type | Required | Description | | --------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- | | `fileId` | `string` | Yes | Box file ID of the file to move. | | `destinationFolderId` | `string` | Yes | Box folder ID of the destination folder. | | `accessToken` | `string` | No | If `accessToken` is sent, that value is used for the Box API call. Otherwise, the default service account credentials are used. | Returns: * `File` object with the updated parent folder. * If the move fails, the returned `File` object can include a `status` value. Check `mostRecentError` for details. Usage notes: * If `accessToken` is blank or `null`, the method uses service account credentials. * Check the returned `File` object's `status` value for operation errors. * Check `mostRecentError` if the operation fails. ## Folder Operations ### `getRootFolderId` Parameters: * None Returns: * `string` returned is the Box folder ID of the Salesforce root folder. ### `getObjectFolderByRecordId` | Parameter | Type | Description | | ---------- | ---- | ---------------------------------------------------------- | | `recordId` | `id` | Salesforce record ID whose root folder ID you want to get. | Returns: * `string` returned is the Box folder ID of the object root folder for the record ID passed in. ### `getFolderUrl` * This method gets the embed widget URL for a particular record so customers can use their own embed logic if desired. * This method respects seamless login settings so the URL will automatically log the user in if seamless login is enabled. | Parameter | Type | Description | | ----------------- | --------- | --------------------------------------------------------------------------- | | `recordId` | `id` | Salesforce record ID whose root folder ID you want to get. | | `isMobileContext` | `boolean` | Boolean to indicate whether the URL should be mobile (true) or not (false). | Returns: * `string` returned is a URL that points to the folder associated with the Salesforce record ID passed. This URL is for the Box Embed Widget and can be embedded in any Visualforce page. ### `createObjectFolderForRecordId` | Parameter | Type | Description | | ---------- | ---- | ---------------------------------------------------------- | | `recordId` | `id` | Salesforce record ID whose root folder ID you want to get. | Returns: * `string` returned is the Box folder ID of the root folder that was created. * If the root folder already existed, the value returned is the Box folder ID of the root folder that already existed. ### `createFolder` | Parameter | Type | Description | | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `folderName` | `string` | Name of the folder to be created. Folder names are subject to some restrictions. See here for more details. | | `parentFolderId` | `string` | Parent Box folder this folder will be created in. | | `accessToken` | `string` | Optional - If `accessToken` is sent, that value is used for the Box API call; otherwise, the default service account credentials are used. | Returns: * `string` returned is the Box folder ID of the folder that was created. * `null` is returned if a folder is not created. In this case, check `mostRecentError` for details. ### `createFolderShareLink` Creates a shared link for a Box folder. | Parameter | Type | Required | Description | | ---------- | -------- | -------- | ---------------------------------------------- | | `folderId` | `string` | Yes | The Box folder ID to create a shared link for. | Returns: * `string` returned is the shared link URL. * `null` if the shared link is not created. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication. * It creates the shared link with the default Box permissions. * Check `mostRecentError` when the method returns `null`. ### `getFolderContents` Retrieves files and subfolders from a Box folder. | Parameter | Type | Required | Description | | ------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- | | `folderId` | `string` | Yes | The Box folder ID to retrieve contents from. | | `accessToken` | `string` | No | If `accessToken` is sent, that value is used for the Box API call. Otherwise, the default service account credentials are used. | Returns: * `FolderContents` object containing the files and folders in the Box folder. * If the request fails, the returned `FolderContents` object can include a `status` value. Check `mostRecentError` for details. Usage notes: * If `accessToken` is blank or `null`, the method uses service account credentials. * The response can include both files and subfolders. * Check the returned `FolderContents` object's `status` value for operation errors. * Check `mostRecentError` if the operation fails. ### `createFolderForRecordId` | Parameter | Type | Description | | --------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | `recordId` | `id` | Salesforce record ID that a Box folder will be created for. | | `folderNameOverride` | `string` | By default, the record's name will be the folder name. If you want to name it something else, send that value here. | | `optCreateRootFolder` | `boolean` | Boolean to indicate whether to create the object root folder if it doesn't exist. If false is sent and the root folder does not exist, the call will fail. | Returns: * `string` returned is the Box folder ID of the folder that was created. * `null` is returned if a folder is not created. In this case, check `mostRecentError` for details. * If the Salesforce record was already associated with a Box folder, the existing Box folder ID is returned. ### `moveFolder` | Parameter | Type | Description | | ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | `folderId` | `string` | Box folder ID of the folder to be moved. | | `newParentFolderId` | `string` | Box folder ID of the folder that will be the new parent folder. | | `accessToken` | `string` | Optional - If `accessToken` is sent, that value is used for the Box API call. Otherwise, the default service account credentials are used. | Returns: * `true` if the folder was moved successfully. * `false` if the folder was not moved successfully. Check `mostRecentError` for details. ### `getUrlForFolder` | Parameter | Type | Description | | ---------- | ---- | ----------------- | | `recordId` | `id` | ID of the record. | Returns: * `pageReference` object with provided URL. * `null` if the parameters are incorrect. ### `createFolderForRecordIdFromTemplate` | Parameter | Type | Description | | --------------------- | --------- | --------------------------------------------------------------------- | | `recordId` | `id` | Salesforce record ID. | | `templateFolderId` | `string` | Source folder which should be the template. | | `folderNameOverride` | `string` | Name override of the new folder. | | `optCreateRootFolder` | `boolean` | Flag that determines if a root folder is created if it doesn't exist. | Returns: * Newly created folder ID. * `null` if the parameters are incorrect. ## Folder Association Methods ### `getFolderAssociationsByRecordId` | Parameter | Type | Description | | ---------- | ---- | ----------------------------------------------------------------------------- | | `recordId` | `id` | Salesforce record ID that the folder mapping entries returned are related to. | Returns: * List returned is a collection of all folder mapping entries associated with this record. * Generally, it will be an empty list if no folder mapping entries exist, but under some circumstances, it could be `null`. ### `getFolderIdByRecordId` | Parameter | Type | Description | | ---------- | ---- | ----------------------------------------------------- | | `recordId` | `id` | Salesforce record ID whose folder ID you want to get. | Returns: * `string` returned is the Box folder ID associated with the Salesforce record ID passed in. ### `getFolderIdsByRecordIds` Retrieves Box folder IDs associated with one or more Salesforce record IDs. | Parameter | Type | Required | Description | | ----------- | ---------- | -------- | --------------------------------- | | `recordIds` | `List` | Yes | Salesforce record IDs to look up. | Returns: * `Map` where each key is a Salesforce record ID and each value is the associated Box folder ID. * An empty map if no folder associations exist. Usage notes: * This method queries Salesforce folder associations and does not call the Box API. * It queries the `Record_ID_Indexed__c` field on the `FRUP__c` object. * It returns only associations where `Box_Folder_ID__c` has a value. * Use this method to look up multiple record-to-folder associations in one call. ### `getRecordIdByFolderId` | Parameter | Type | Description | | ---------- | -------- | -------------- | | `folderId` | `string` | Box folder ID. | Returns: * `id` returned is the Salesforce record ID associated with the Box folder ID passed in. ### `createFolderAssociation` | Parameter | Type | Description | | ---------- | -------- | ---------------------------------------------------------------- | | `recordId` | `id` | Salesforce record ID that is being associated with a Box folder. | | `folderId` | `string` | Box folder ID being associated with a Salesforce record. | Returns: * `box__FRUP__c` object - The FRUP object returned will be `null` if there was an error (check `mostRecentError`). Upon calling the `commitChanges` method, this FRUP entry will be inserted into the database. This method ensures consistency with other folder associations by not allowing the same folder to be associated with multiple records or vice versa. ## Collaboration Methods Collaborations created by the Box for Salesforce Developer Toolkit will not send collaboration emails to collaborators. Only the service account used for the Box for Salesforce integration will receive a collaboration email. ### `createCollaboration` | Parameter | Type | Description | | -------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `folderId` | `string` | Box folder ID to create a collaboration on. | | `boxUserId` | `string` | Box user ID to be collaborated (either `boxUserId` or `emailAddress` is required, but not both). | | `emailAddress` | `string` | Email address of the Box user to be collaborated. | | `collabType` | `box.Toolkit.CollaborationType` | Type of collaboration (see the `CollaborationType` enum definition). | | `accessToken` | `string` | Optional - If sent, this value is used for authentication for the Box API call; if `null`, the service account credentials are used. | Returns: * `string` returned is the ID of the Box collaboration that was created. * `null` returned if there was an error. In this case, check `mostRecentError`. ### `createCollaborationOnRecord` | Parameter | Type | Description | | ----------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `userId` | `id` | Salesforce user ID to be collaborated. | | `recordId` | `id` | Salesforce record ID of the record folder to be collaborated on. | | `collabType` | `box.Toolkit.CollaborationType` | Type of collaboration (see the `CollaborationType` enum definition). | | `optCreateFolder` | `boolean` | Boolean to indicate whether to create the Box folder associated with the Salesforce record ID if it does not already exist. This also creates the root folder if it did not already exist. If set to `false` and the folder does not already exist, the call will fail. | Returns: * `string` returned is the ID of the Box collaboration that was created. * `null` returned if there was an error. In this case, check `mostRecentError`. [collab-type]: https://support.box.com/hc/en-us/articles/360044196413-Understanding-Collaborator-Permission-Levels [sf-httprequest]: https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_restful_http_httprequest.htm [sf-httpresponse]: https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_restful_http_httpresponse.htm#apex_classes_restful_http_httpresponse ### `editCollaboration` | Parameter | Type | Description | | ------------- | -------- | ----------------------------------------------------------------------------------------------------------------- | | `collabId` | `string` | Collaboration ID. | | `collabType` | `enum` | `Box.Toolkit.CollaborationType` enum. | | `accessToken` | `string` | Optional - If sent, this value is used for the Box API call; if `null`, the service account credentials are used. | Returns: * Boolean based on the transaction success. * `false` if the parameters are incorrect. ### `deleteCollaboration` | Parameter | Type | Description | | ------------- | -------- | ----------------------------------------------------------------------------------------------------------------- | | `collabId` | `string` | Collaboration ID. | | `accessToken` | `string` | Optional - If sent, this value is used for the Box API call; if `null`, the service account credentials are used. | Returns: * Boolean based on the transaction success. * `false` if the parameters are incorrect. ## Search and Discovery ### `search` Searches Box content accessible to the service account. | Parameter | Type | Required | Description | | --------- | -------- | -------- | ------------------------ | | `query` | `string` | Yes | The search query string. | Returns: * `SearchResults` object with matching files and folders. * `null` if the search fails. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication. * It searches file names, descriptions, and content accessible to the service account. * Box returns up to 100 results by default. * Use `search` with filters when you need pagination or narrower search scope. * Check `mostRecentError` when the method returns `null`. ### `search` with filters Searches Box content with filtering, pagination, and scope controls. | Parameter | Type | Required | Description | | ------------------- | -------------- | -------- | -------------------------------------------------------------- | | `query` | `string` | Yes | The search query string. | | `scope` | `string` | No | Search scope, such as `user_content` or `enterprise_content`. | | `trashContent` | `string` | No | Trash filter, such as `trashed_only` or `non_trashed_only`. | | `limit` | `integer` | No | Number of results to return. The Box API maximum is 200. | | `offset` | `integer` | No | Starting position for pagination. | | `ancestorFolderIds` | `List` | No | Box folder IDs to restrict the search to. | | `contentTypes` | `string` | No | Content type filter, such as `name`, `description`, or `tags`. | Returns: * `SearchResults` object with matching files and folders. * `null` if the search fails. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication. * Use `scope` to choose between user content and enterprise content. * The Box API supports up to 200 results per request. * Use `offset` to paginate through larger result sets. * Use `ancestorFolderIds` to limit results to specific folder hierarchies. * Check `mostRecentError` when the method returns `null`. ### `getRecentInteractions` Retrieves files and folders recently interacted with by the current user. Parameters: * None Returns: * `RecentItems` object containing recently accessed content. * `null` if the request fails. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication. * Results are returned in order of most recent interaction. * Interactions can include actions such as opening, previewing, downloading, or editing an item. * Box limits the response to the API default, typically 100 items. * Check `mostRecentError` when the method returns `null`. ## Enterprise Events ### `getEnterpriseEvents` Retrieves enterprise events for auditing and monitoring Box activity. | Parameter | Type | Required | Description | | ---------------- | -------------- | -------- | ----------------------------------------------------------------- | | `streamType` | `string` | Yes | Stream type, such as `admin_logs` or `admin_logs_streaming`. | | `limit` | `integer` | No | Number of events to return. The Box API maximum is 500. | | `streamPosition` | `string` | No | Stream position marker for pagination or polling. | | `eventTypes` | `List` | No | Event types to include, such as `ITEM_UPLOAD` or `ITEM_DOWNLOAD`. | | `createdAfter` | `string` | No | ISO 8601 timestamp for events created after this time. | | `createdBefore` | `string` | No | ISO 8601 timestamp for events created before this time. | Returns: * `EnterpriseEvents` object with event entries and the next stream position. * `null` if the request fails. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication and requires enterprise admin privileges. * Use the `streamPosition` from the previous response to continue polling the event stream. * The Box API supports up to 500 events per request. * Date filters must use ISO 8601 format, such as `YYYY-MM-DDTHH:MM:SSZ`. * Check `mostRecentError` when the method returns `null`. ## Metadata Check the `toolkit.mostRecentError` value for detailed error responses for all the methods. ### `getMetadataTemplateByName` Retrieves a metadata template definition by name and scope. | Parameter | Type | Required | Description | | -------------- | -------- | -------- | ------------------------------------------------------------------------------ | | `templateName` | `string` | Yes | The name of the metadata template. | | `scope` | `string` | Yes | The scope of the metadata template. Value is one of \[`global`, `enterprise`]. | Returns: * `MetadataTemplate` object with the template definition. * `null` if the template is not retrieved. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication. * Use it to inspect or validate a metadata template before creating or updating metadata values. * Check `mostRecentError` when the method returns `null`. ### `getBoxMetadataByFileId` This method calls the get metadata instance on file endpoint. | Parameter | Type | Required | Description | | ---------- | -------- | -------- | ------------------------------------------------------------------------------ | | `fileId` | `string` | Yes | The ID of the Box file for which you want to retrieve metadata. | | `scope` | `string` | Yes | The scope of the metadata template. Value is one of \[`global`, `enterprise`]. | | `template` | `string` | Yes | The name of the metadata template. | Returns: * `Metadata` object with the metadata key/value pairs. * `null` if the metadata is not retrieved. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication. * The request returns an error if the metadata instance does not exist on the file. * Check `mostRecentError` when the method returns `null`. ### `createBoxMetadataByFileId` This method calls the create metadata instance on file endpoint. | Parameter | Type | Required | Description | | ---------------- | --------------------- | -------- | ------------------------------------------------------------------------------ | | `fileId` | `string` | Yes | The ID of the Box file for which you want to create metadata. | | `scope` | `string` | Yes | The scope of the metadata template. Value is one of \[`global`, `enterprise`]. | | `template` | `string` | Yes | The name of the metadata template. | | `metadataValues` | `Map` | Yes | Key/value pairs that match fields in the metadata template. | Returns: * `Metadata` object with the created metadata values. * `null` if the metadata is not created. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication. * The method fails if metadata already exists for the specified file, scope, and template. Use `updateBoxMetadataByFileId` to modify existing metadata. * Metadata keys must match the template field names. * Check `mostRecentError` when the method returns `null`. ### `updateBoxMetadataByFileId` This method calls the update metadata instance on file endpoint. | Parameter | Type | Required | Description | | ------------ | --------------------------- | -------- | ---------------------------------------------------------------------------------------- | | `fileId` | `string` | Yes | The ID of the Box file for which you want to update metadata. | | `scope` | `string` | Yes | The scope of the metadata template. Value is one of \[`global`, `enterprise`]. | | `template` | `string` | Yes | The name of the metadata template. | | `operations` | `List>` | Yes | JSON Patch operations. Each operation includes values such as `op`, `path`, and `value`. | Returns: * `Metadata` object with the updated metadata values. * `null` if the metadata is not updated. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication. * The `operations` parameter uses JSON Patch format. * Each operation should include an `op`, `path`, and, when required by the operation, a `value`. * Supported operations include `add`, `replace`, `remove`, and `test`. * Check `mostRecentError` when the method returns `null`. ### `deleteBoxMetadataByFileId` This method calls the delete metadata instance from file endpoint. | Parameter | Type | Required | Description | | ---------- | -------- | -------- | ------------------------------------------------------------------------------ | | `fileId` | `string` | Yes | The ID of the Box file for which you want to delete metadata. | | `scope` | `string` | Yes | The scope of the metadata template. Value is one of \[`global`, `enterprise`]. | | `template` | `string` | Yes | The name of the metadata template. | Returns: * Boolean based on the transaction success. * `false` if the metadata is not deleted. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication. * It deletes the metadata instance from the file. It does not delete the metadata template. * Check `mostRecentError` when the method returns `false`. ### `getBoxMetadataByFolderId` This method calls the get metadata instance on folder endpoint. | Parameter | Type | Description | | -------------- | -------- | --------------------------------------------------------------------------- | | `folderId` | `string` | The ID of the Box folder for which you want to retrieve metadata. | | `scope` | `string` | The scope of the metadata template. Value is one of `[global, enterprise]`. | | `template_key` | `string` | The name of the metadata template. | Returns: * `FolderMetadata` record associated with this folder, scope, and template key. You can find the custom values in `keyValuePairs` variable of this object. * `null`, if: * the parameters are incorrect, * access to the folder is missing, * metadata cascade policy is not found. ### `createBoxMetadataByFolderId` This method calls the create metadata instance on folder endpoint. | Parameter | Type | Description | | --------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `folderId` | `string` | ID of the Box folder for which you want to create metadata. | | `scope` | `string` | Scope of the metadata template. Value is one of \[`global`, `enterprise`]. | | `template_key` | `string` | Name of the metadata template. | | `keyValuePairs` | `List` | This class works as a map. Provide key/value pairs as a list, for the attributes to send to Box Metadata. The key/value mappings follow the same pattern as the API. Number types such as `'3000'` and multi-select values such as `'Customer;Order'` are represented as string inputs in the `value` field, as regular metadata values seen in the code samples. | Returns: * Newly created `FolderMetadata` object. * `null`, if: * the parameters are incorrect, * access to the folder is missing, * metadata cascade policy is not found. ### `updateBoxMetadataByFolderId` Calls the update metadata instance on folder endpoint. | Parameter | Type | Description | | -------------- | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `folderId` | `string` | ID of the Box folder for which you want to update metadata. | | `scope` | `string` | The scope of the metadata template. Value is one of \[`global`, `enterprise`] | | `template_key` | `string` | The name of the metadata template. | | `mdUpdates` | `List` | Metadata updates. Provide the operation, path, and value. The metadata update records follow the same pattern as the API. Number types such as `3000` and multi-select values such as `Customer;Order` are represented as string inputs in the `value` field, just as the regular metadata values in the code samples. | Returns: * Updated `FolderMetadata` object. * `null`, if: * the parameters are incorrect, * access to the folder is missing, * metadata cascade policy is not found. ### `deleteBoxMetadataFolderId` This method calls the delete metadata instance from folder endpoint. | Parameter | Type | Description | | -------------- | -------- | ----------------------------------------------------------------------------- | | `folderId` | `string` | ID of the Box folder for which you want to delete metadata. | | `scope` | `string` | The scope of the metadata template. Value is one of \[`global`, `enterprise`] | | `template_key` | `string` | The name of the metadata template. | Returns: * Boolean based on the transaction success. * `false` is returned if the parameters are incorrect or the metadata is not found. ### `getMetadataCascadePolicyById` This method calls the get metadata cascade policy from folder endpoint. As it requires an ID, you need to call the `getMetadataCascadePoliciesByFolderId` method first. | Parameter | Type | Description | | ---------- | -------- | -------------------------------------------------- | | `policyId` | `string` | The ID of the cascade policy you want to retrieve. | Returns: * `MetadataCascadePolicy` object retrieved from Box. * `null`, if: * the parameters are incorrect, * access to the folder is missing, * metadata cascade policy is not found. ### `getMetadataCascadePoliciesByFolderId` This method retrieves the cascade policies by providing a folder ID and calling the get metadata cascade policies endpoint. | Parameter | Type | Description | Required | | ------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------- | -------- | | `folderId` | `string` | Specifies for which folder to return the policies. This can't be used on the root folder with ID 0. | Yes | | `paginationMarker` | `string` | Defines the position marker at which to begin returning results. This is used for marker-based pagination. | No | | `offset` | `integer` | The offset of the item at which to begin the response. | No | | `ownerEnterpriseId` | `string` | Enterprise ID for which to find the metadata cascade policies. If not specified, it defaults to the current enterprise. | No | Returns: * List of `MetadataCascadePolicy` objects retrieved from Box. * `null`, if: * the parameters are incorrect, * access to the folder is missing, * metadata cascade policy is not found. ### `createMetadataCascadePolicy` This method creates cascade policies by providing a Box folder ID, scope, template key, and by calling the post metadata cascade policies endpoint. | Parameter | Type | Description | | -------------- | -------- | ----------------------------------------------------------------------------------- | | `folderId` | `string` | ID of the Box folder for which you want to create the metadata cascade policy. | | `scope` | `string` | The scope of the metadata cascade policy. Value is one of \[`global`, `enterprise`] | | `template_key` | `string` | The name of the template key. | Returns: * Newly generated `MetadataCascadePolicy`. * `null`, if: * the parameters are incorrect, * access to the folder is missing, * metadata cascade policy details are not found. ### `deleteMetadataCascadePolicy` This method deletes the cascade policies by providing a cascade policy ID and calling the delete metadata cascade policies ID endpoint. | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | | `policyId` | `string` | The ID of the cascade policy you want to delete. | Returns: * Boolean based on the transaction success. * `false` is returned if parameters are incorrect, access to the folder is missing, or the metadata cascade policy is not found. ### `enableAppActivity` This method enables the given folder for App Activities by applying metadata on the folder and cascading it down. | Parameter | Type | Description | | ---------- | -------- | --------------------------------------------------------------------- | | `folderId` | `string` | The ID of the Box folder for which you want to enable App Activities. | Returns: * Boolean based on the transaction success. * `false` in case of incorrect parameters. ## Salesforce and Slack ### `getIntegrationMappings` This toolkit method calls the get integration mappings endpoint to get the existing mappings. | Parameter | Type | Description | | --------------- | ------ | ------------------------------------------------------------------------------------ | | `integration` | String | `Slack` is currently the only supported value. | | `partnerItemId` | String | ID of the mapped item on the provided integration side. Example: a Slack channel ID. | Returns: * A list of `IntegrationMapping` objects. * `null` is returned if the parameters are incorrect, the access is missing, or the integration mapping is not found. ### `createIntegrationMapping` This toolkit method calls the create integration mapping endpoint to create the mappings. When you map to a Slack channel, `access_management_disabled` is set to `FALSE` by default. This causes an automatic removal of collaborators that are not part of the Slack channel member list. Depending on how your organization sets up sharing in Box, we recommend that you either set `access_management_disabled` to `TRUE` by using the `setSlackChannelAccessManagementDisabled` method, or use [groups][12]. This ensures no users are removed, regardless of Slack settings. Collaborations are added or removed from Slack when a file is uploaded to a Slack channel. | Parameter | Type | Description | | ------------- | -------------------- | ---------------------------------------------- | | `integration` | String | `Slack` is currently the only supported value. | | `mapping` | `IntegrationMapping` | Apex defined type `IntegrationMapping`. | Returns: * Boolean based on the transaction success. ### `deleteIntegrationMapping` This toolkit method calls the delete integration mappings endpoint to delete a mapping. | Parameter | Type | Description | | ---------------------- | ------ | ---------------------------------------------- | | `integration` | String | `Slack` is currently the only supported value. | | `integrationMappingId` | String | Retrieved from `getIntegrationMappings`. | Returns: * Boolean based on the transaction success. ### `mapSfdcRecordToSlackChannel` This toolkit method uses the above integration mapping methods and provides a wrapper with four different use cases: 1. If a mapping does not exist in Salesforce or Slack, it creates a folder under the Box for Salesforce folder structure, and an integration mapping to link it with the Slack channel. 2. If a mapping only exists from Salesforce, it continues to use the folder and does not change the location. It creates an integration mapping to link it with the Slack channel. 3. If a mapping only exists from Slack, it continues to use the folder and creates an FRUP record for the Salesforce record to use the existing folder. This folder is likely to be outside of the Salesforce root folder. 4. If Salesforce and Slack have existing mappings but are not related to each other, it throws an error through `Toolkit.mostRecentError` or within a flow action, stating that the mappings already exist. This method/invocable is used in a flow template provided in the Box for Salesforce package `Create Box Folder/Slack Channel Mapping`. When you map to a Slack channel, `access_management_disabled` is set to `FALSE` by default. This causes an automatic removal of collaborators that are not part of the Slack channel member list. Depending on how your organization sets up sharing in Box, we recommend that you either set `access_management_disabled` to `TRUE` by using the `setSlackChannelAccessManagementDisabled` method, or use [groups][12]. This ensures no users are removed, regardless of Slack settings. Collaborations are added or removed from Slack when a file is uploaded to a Slack channel. | Parameter | Type | Description | | ----------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------- | | `recordId` | ID | Salesforce record ID. | | `slackChannelId` | String | The Slack channel ID. | | `slackWorkspaceOrOrgId` | String | If Box for Slack is installed org-wide, provide the Org ID (for example, E1234567) or the Workspace ID (for example, T5555555). | Returns: * Boolean based on the transaction success. ### `setSlackChannelAccessManagementDisabled` This toolkit method calls the put integration mappings endpoint to update the access management deactivated setting. This method/invocable is used in a flow template provided in the Box for Salesforce package `Create Box Folder/Slack Channel Mapping`. | Parameter | Type | Description | | ----------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `channelId` | String | The Slack channel ID. | | `disabled` | Boolean | Indicates whether a channel member's access to the underlying Box item is automatically managed. Depending on the type of the channel, access is managed through creating collaborations or shared links. | Returns: * Boolean based on the transaction success. ## Box Sign ### `sendSignRequests` This method calls the create sign request endpoint to send documents for signature. | **Parameter** | **Type** | **Description** | | ------------- | ---------------------- | -------------------------------------------------------------------------------------------------------- | | `requests` | `List` | List of Box Sign Request objects containing signers, files, and configuration for the signature request. | **Returns:** List of `BoxSignResponse` objects, one for each request processed. Each response contains the sign request ID, status, and any error information. `BoxSignResponse` returns error details, if: * the parameters are incorrect, * access to the files is missing, * file upload fails, * Box Sign API returns an error. ## Document Generation ### `submitDocGenBatch` Submits a batch of documents to generate from a Box document generation template. | Parameter | Type | Required | Description | | ---------------- | --------------------------- | -------- | ------------------------------------------------------------- | | `templateFileId` | `string` | Yes | The Box file ID of the document generation template. | | `documents` | `List>` | Yes | Document configurations and merge data to use for generation. | Returns: * `DocGenBatch` object with the batch ID and status. * `null` if the batch is not submitted. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication. * Each document configuration should include the generated file name and the merge data for the template, such as `fileName` and `data` values. * Document generation runs asynchronously. Use `getDocGenBatch` to check the batch status. * Check `mostRecentError` when the method returns `null`. ### `getDocGenBatch` Retrieves the status and details of a document generation batch. | Parameter | Type | Required | Description | | --------- | -------- | -------- | ----------------------------------------------- | | `batchId` | `string` | Yes | The batch ID returned from `submitDocGenBatch`. | Returns: * `DocGenBatch` object with the batch status and generated file details. * `null` if the batch is not retrieved. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication. * Poll this method periodically to monitor batch progress. * Batch statuses include `pending`, `processing`, `completed`, and `failed`. * Generated file details are available after the batch is complete. * Check `mostRecentError` when the method returns `null`. ## File Requests ### `copyFileRequest` Creates a copy of an existing file request with customizable properties. | Parameter | Type | Required | Description | | ----------------------- | --------- | -------- | ---------------------------------------------------- | | `fileRequestId` | `string` | Yes | The ID of the file request to copy. | | `folderId` | `string` | Yes | The destination Box folder ID for uploaded files. | | `title` | `string` | No | Custom title for the new file request. | | `description` | `string` | No | Custom description for the new file request. | | `status` | `string` | No | File request status, such as `active` or `inactive`. | | `isDescriptionRequired` | `boolean` | No | Whether submitters must provide a description. | | `isEmailRequired` | `boolean` | No | Whether submitters must provide an email address. | Returns: * `FileRequest` object with the new file request details. * `null` if the file request is not copied. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication. * If optional parameters are `null`, the new file request inherits those values from the source file request. * Use `active` to enable the copied file request immediately. * Check `mostRecentError` when the method returns `null`. ### `copyFileRequest` with default settings Creates a copy of an existing file request using the source file request settings and a new destination folder. | Parameter | Type | Required | Description | | --------------- | -------- | -------- | ------------------------------------------------- | | `fileRequestId` | `string` | Yes | The ID of the file request to copy. | | `folderId` | `string` | Yes | The destination Box folder ID for uploaded files. | Returns: * `FileRequest` object with the new file request details. * `null` if the file request is not copied. In this case, check `mostRecentError`. Usage notes: * This method uses service account authentication. * The copied file request inherits settings from the source file request and uses the folder ID you provide. * Use this method when you only need to change the destination folder. * Check `mostRecentError` when the method returns `null`. ## Box Hubs ### Manage Box Hubs #### `getHubById` This method calls the get hub by ID endpoint to retrieve a specific hub. | **Parameter** | **Type** | **Description** | | ------------- | -------- | ------------------------------ | | `hubId` | `string` | The ID of the hub to retrieve. | **Returns:** * Hub object containing the hub details and metadata. * `HubsToolkitException` if: * the hub ID is blank or null, * access to the hub is missing, * the hub is not found. #### `getAllHubs` This method calls the get all hubs endpoint to retrieve a list of all hubs. | **Parameter** | **Type** | **Description** | | ------------- | --------- | --------------------------------------------------------------- | | `limitCount` | `integer` | Optional - maximum number of hubs to return. | | `marker` | `string` | Optional - pagination marker for retrieving additional results. | **Returns:** * `HubsList` object containing the list of hubs and pagination information. * `HubsToolkitException` if: * access to hubs is missing, * API request fails. #### `getEnterpriseHubs` This method calls the get enterprise hubs endpoint to retrieve enterprise-level hubs. | **Parameter** | **Type** | **Description** | | ------------- | --------- | --------------------------------------------------------------- | | `limitCount` | `integer` | Optional - maximum number of hubs to return. | | `marker` | `string` | Optional - pagination marker for retrieving additional results. | **Returns:** * `HubsList` object containing the list of enterprise hubs and pagination information. * `HubsToolkitException` if: * access to enterprise hubs is missing, * API request fails. #### `createHub` This method calls the create hub endpoint to create a new hub. | **Parameter** | **Type** | **Description** | | ------------- | -------- | ---------------------------------------------------- | | `title` | `string` | Required - title of the hub (maximum 50 characters). | | `description` | `string` | Optional - description of the hub. | **Returns:** * Hub object containing the newly created hub details. * `HubsToolkitException` if: * the title is blank or null, * the title exceeds 50 characters, * access to create hubs is missing, * API request fails. #### `updateHub` This method calls the update hub endpoint to modify an existing hub. | **Parameter** | **Type** | **Description** | | --------------- | ------------------ | -------------------------------------------------- | | `hubId` | `string` | Required - the ID of the hub to update. | | `updateRequest` | `HubUpdateRequest` | Required - object containing the fields to update. | **Returns:** * Hub object containing the updated hub details. * `HubsToolkitException` if: * the hub ID is blank or null, * the update request is null, * the title exceeds 50 characters, * access to the hub is missing, * API request fails. #### `copyHub` This method calls the copy hub endpoint to create a copy of an existing hub. | **Parameter** | **Type** | **Description** | | ------------- | -------- | ------------------------------------------------------------ | | `hubId` | `string` | Required - the ID of the hub to copy. | | `title` | `string` | Optional - title for the copied hub (maximum 50 characters). | | `description` | `string` | Optional - description for the copied hub. | **Returns:** * Hub object containing the newly created copied hub details. * `HubsToolkitException` if: * the hub ID is blank or null, * the title exceeds 50 characters, * access to the source hub is missing, * API request fails. ### Box Hub Collaborations #### `createUserCollaboration` This method calls the create hub collaboration endpoint to add a user to a hub. | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------------------- | | `hubId` | `string` | Required - the ID of the hub. | | `userId` | `string` | Required - the ID of the user to add. | | `role` | `string` | Required - the role for the user in the hub. | **Returns:** * `HubCollaboration` object containing the collaboration details. * `HubsToolkitException` if: * the hub ID is blank or null, * the user ID is blank or null, * the role is blank or null, * access to the hub is missing, * API request fails. #### `createHubCollaboration` This method calls the create hub collaboration endpoint to add a collaboration to a hub. | **Parameter** | **Type** | **Description** | | ------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------- | | `request` | `HubCollaborationRequest` | Required - object containing the collaboration details including hub reference and accessible by information. | **Returns:** * `HubCollaboration` object containing the collaboration details. * `HubsToolkitException` if: * the collaboration request is null, * the hub reference with ID is missing, * access to the hub is missing, * API request fails. #### `getHubCollaborations` This method calls the get hub collaborations endpoint to retrieve collaborations for a hub. | **Parameter** | **Type** | **Description** | | ------------- | --------- | --------------------------------------------------------------- | | `hubId` | `string` | Required - the ID of the hub. | | `limitCount` | `integer` | Optional - maximum number of collaborations to return. | | `marker` | `string` | Optional - pagination marker for retrieving additional results. | **Returns:** * `HubCollaborationsList` object containing the list of collaborations and pagination information. * `HubsToolkitException` if: * the hub ID is blank or null, * access to the hub is missing, * API request fails. #### `updateHubCollaboration` This method calls the update hub collaboration endpoint to modify a collaboration. | **Parameter** | **Type** | **Description** | | ----------------- | -------- | ------------------------------------------------- | | `collaborationId` | `string` | Required - the ID of the collaboration to update. | | `role` | `string` | Required - the new role for the collaboration. | **Returns:** * `HubCollaboration` object containing the updated collaboration details. * `HubsToolkitException` if: * the collaboration ID is blank or null, * the role is blank or null, * access to the collaboration is missing, * API request fails. ### Box Hub Items #### `addHubItem` This method calls the manage hub items endpoint to add an item to a hub. | **Parameter** | **Type** | **Description** | | ------------- | -------- | ------------------------------------------------------------------ | | `hubId` | `string` | Required - the ID of the hub. | | `itemId` | `string` | Required - the ID of the item to add. | | `itemType` | `string` | Required - the type of the item (for example, `file` or `folder`). | **Returns:** * `HubItemsManageResponse` object containing the result of the item management operation. * `HubsToolkitException` if: * the hub ID is blank or null, * the item ID is blank or null, * the item type is blank or null, * access to the hub is missing, * API request fails. ## Debugging ### `setEnhancedDebugging` Enables or disables enhanced debug logging for the current Toolkit instance. | Parameter | Type | Required | Description | | --------- | --------- | -------- | -------------------------------------------------------- | | `enabled` | `boolean` | Yes | `true` to enable enhanced debugging; `false` to disable. | Returns: * `Void` Usage notes: * Enhanced debugging applies only to the current Toolkit instance. * When enabled, enhanced debugging logs additional HTTP request and response details. * Use enhanced debugging for troubleshooting, and disable it in production to avoid unnecessary logging. * The setting does not persist across transactions. ### `isEnhancedDebuggingEnabled` Checks whether enhanced debugging is enabled for the current Toolkit instance. Parameters: * None Returns: * `true` if enhanced debugging is enabled. * `false` if enhanced debugging is disabled. Usage notes: * This method has no side effects. * Use it to conditionally run debug-only logic. * The returned value reflects the setting applied by `setEnhancedDebugging`. [12]: https://support.box.com/hc/articles/360043694554-Creating-and-Managing-Groups