Box Platform provides functionality to provide access to content stored within Box. It provides endpoints for basic manipulation of files and folders, management of users within an enterprise, as well as more complex topics such as legal holds and retention policies.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8119550","collectionId":"b5ea2aeb-c82a-425d-baff-ed5dfd1d7659","publishedId":"SWTABe9M","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-01-28T15:15:17.000Z"},"item":[{"name":"Authorization","item":[{"name":"Authorize user","id":"bae2d953-0023-49fa-913f-6528b675a1a9","request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://account.box.com/api/oauth2/authorize?response_type=code&client_id={{client_id}}","description":"Authorize a user by sending them through the Box
\nhttps://developer.box.com/reference/get-authorize
\n","urlObject":{"protocol":"https","path":["api","oauth2","authorize"],"host":["account.box.com"],"query":[{"description":{"content":"The type of response we'd like to receive.
\n","type":"text/plain"},"key":"response_type","value":"code"},{"description":{"content":"The Client ID of the application that is requesting to authenticate\nthe user. To get the Client ID for your application, log in to your\nBox developer console and click the Edit Application link for\nthe application you're working with. In the OAuth 2.0 Parameters section\nof the configuration page, find the item labelled client_id. The\ntext of that item is your application's Client ID.
The URI to which Box redirects the browser after the user has granted\nor denied the application permission. This URI match one of the redirect\nURIs in the configuration of your application. It must be a\nvalid HTTPS URI and it needs to be able to handle the redirection to\ncomplete the next step in the OAuth 2.0 flow.\nAlthough this parameter is optional, it must be a part of the\nauthorization URL if you configured multiple redirect URIs\nfor the application in the developer console. A missing parameter causes\na redirect_uri_missing error after the user grants application access.
A custom string of your choice. Box will pass the same string to\nthe redirect URL when authentication is complete. This parameter\ncan be used to identify a user on redirect, as well as protect\nagainst hijacked sessions and other exploits.
\n","type":"text/plain"},"key":"state","value":"my_state"},{"disabled":true,"description":{"content":"A space-separated list of application scopes you'd like to\nauthenticate the user for. This defaults to all the scopes configured\nfor the application in its configuration page.
\n","type":"text/plain"},"key":"scope","value":"admin_readwrite"}],"variable":[]}},"response":[{"id":"1300e35c-97b7-4d6f-a83c-9a479f8741b7","name":"[200] Does not return any data, but rather should be used in the browser.","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://account.box.com/api/oauth2/authorize?response_type=code&client_id={{client_id}}","protocol":"https","host":["account.box.com"],"path":["api","oauth2","authorize"],"query":[{"key":"response_type","value":"code","description":"The type of response we'd like to receive."},{"key":"client_id","value":"{{client_id}}","description":"The Client ID of the application that is requesting to authenticate\nthe user. To get the Client ID for your application, log in to your\nBox developer console and click the **Edit Application** link for\nthe application you're working with. In the OAuth 2.0 Parameters section\nof the configuration page, find the item labelled `client_id`. The\ntext of that item is your application's Client ID."},{"key":"redirect_uri","value":"http://example.com/auth/callback","description":"The URI to which Box redirects the browser after the user has granted\nor denied the application permission. This URI match one of the redirect\nURIs in the configuration of your application. It must be a\nvalid HTTPS URI and it needs to be able to handle the redirection to\ncomplete the next step in the OAuth 2.0 flow.\nAlthough this parameter is optional, it must be a part of the\nauthorization URL if you configured multiple redirect URIs\nfor the application in the developer console. A missing parameter causes\na `redirect_uri_missing` error after the user grants application access.","disabled":true},{"key":"state","value":"my_state","description":"A custom string of your choice. Box will pass the same string to\nthe redirect URL when authentication is complete. This parameter\ncan be used to identify a user on redirect, as well as protect\nagainst hijacked sessions and other exploits.","disabled":true},{"key":"scope","value":"admin_readwrite","description":"A space-separated list of application scopes you'd like to\nauthenticate the user for. This defaults to all the scopes configured\nfor the application in its configuration page.","disabled":true}]},"description":"Authorize a user by sending them through the Box\n\nhttps://developer.box.com/reference/get-authorize"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"bae2d953-0023-49fa-913f-6528b675a1a9"},{"name":"Request access token","id":"a9df5fa4-428b-4c70-8c20-9ba0cdc9aea1","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","description":"The type of request being made, either using a client-side obtained\nauthorization code, a refresh token, a JWT assertion, client credentials\ngrant or another access token for the purpose of downscoping a token.
\n"},{"key":"client_id","value":"{{client_id}}","description":"The Client ID of the application requesting an access token.
\nUsed in combination with authorization_code, client_credentials, or\nurn:ietf:params:oauth:grant-type:jwt-bearer as the grant_type.
The client secret of the application requesting an access token.
\nUsed in combination with authorization_code, client_credentials, or\nurn:ietf:params:oauth:grant-type:jwt-bearer as the grant_type.
The client-side authorization code passed to your application by\nBox in the browser redirect after the user has successfully\ngranted your application permission to make API calls on their\nbehalf.
\nUsed in combination with authorization_code as the grant_type.
A refresh token used to get a new access token with.
\nUsed in combination with refresh_token as the grant_type.
A JWT assertion for which to request a new access token.
\nUsed in combination with urn:ietf:params:oauth:grant-type:jwt-bearer\nas the grant_type.
The token to exchange for a downscoped token. This can be a regular\naccess token, a JWT assertion, or an app token.
\nUsed in combination with urn:ietf:params:oauth:grant-type:token-exchange\nas the grant_type.
The type of subject_token passed in.
Used in combination with urn:ietf:params:oauth:grant-type:token-exchange\nas the grant_type.
The token used to create an annotator token.\nThis is a JWT assertion.
\nUsed in combination with urn:ietf:params:oauth:grant-type:token-exchange\nas the grant_type.
The type of actor_token passed in.
Used in combination with urn:ietf:params:oauth:grant-type:token-exchange\nas the grant_type.
The space-delimited list of scopes that you want apply to the\nnew access token.
\nThe subject_token will need to have all of these scopes or\nthe call will error with 401 Unauthorized..
Full URL for the file that the token should be generated for.
\n","disabled":true},{"key":"box_subject_type","value":"enterprise","description":"Used in combination with client_credentials as the grant_type.
Used in combination with client_credentials as the grant_type.\nValue is determined by box_subject_type. If user use user ID and if\nenterprise use enterprise ID.
Full URL of the shared link on the file or folder\nthat the token should be generated for.
\n","disabled":true}]},"url":"https://api.box.com/oauth2/token","description":"Request an Access Token using either a client-side obtained OAuth 2.0
\nhttps://developer.box.com/reference/post-oauth2-token
\n","urlObject":{"protocol":"https","path":["oauth2","token"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"70a8e5bd-4d25-494c-be2c-5409db9d1ace","name":"[200] Returns a new Access Token that can be used to make authenticated","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","description":"The type of request being made, either using a client-side obtained\nauthorization code, a refresh token, a JWT assertion, client credentials\ngrant or another access token for the purpose of downscoping a token."},{"key":"client_id","value":"{{client_id}}","description":"The Client ID of the application requesting an access token.\n\nUsed in combination with `authorization_code`, `client_credentials`, or\n`urn:ietf:params:oauth:grant-type:jwt-bearer` as the `grant_type`.","disabled":true},{"key":"client_secret","value":"{{client_secret}}","description":"The client secret of the application requesting an access token.\n\nUsed in combination with `authorization_code`, `client_credentials`, or\n`urn:ietf:params:oauth:grant-type:jwt-bearer` as the `grant_type`.","disabled":true},{"key":"code","value":"n22JPxrh18m4Y0wIZPIqYZK7VRrsMTWW","description":"The client-side authorization code passed to your application by\nBox in the browser redirect after the user has successfully\ngranted your application permission to make API calls on their\nbehalf.\n\nUsed in combination with `authorization_code` as the `grant_type`.","disabled":true},{"key":"refresh_token","value":"{{refresh_token}}","description":"A refresh token used to get a new access token with.\n\nUsed in combination with `refresh_token` as the `grant_type`.","disabled":true},{"key":"assertion","value":"xxxxx.yyyyy.zzzzz","description":"A JWT assertion for which to request a new access token.\n\nUsed in combination with `urn:ietf:params:oauth:grant-type:jwt-bearer`\nas the `grant_type`.","disabled":true},{"key":"subject_token","value":"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ","description":"The token to exchange for a downscoped token. This can be a regular\naccess token, a JWT assertion, or an app token.\n\nUsed in combination with `urn:ietf:params:oauth:grant-type:token-exchange`\nas the `grant_type`.","disabled":true},{"key":"subject_token_type","value":"urn:ietf:params:oauth:token-type:access_token","description":"The type of `subject_token` passed in.\n\nUsed in combination with `urn:ietf:params:oauth:grant-type:token-exchange`\nas the `grant_type`.","disabled":true},{"key":"actor_token","value":"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ","description":"The token used to create an annotator token.\nThis is a JWT assertion.\n\nUsed in combination with `urn:ietf:params:oauth:grant-type:token-exchange`\nas the `grant_type`.","disabled":true},{"key":"actor_token_type","value":"urn:ietf:params:oauth:token-type:id_token","description":"The type of `actor_token` passed in.\n\nUsed in combination with `urn:ietf:params:oauth:grant-type:token-exchange`\nas the `grant_type`.","disabled":true},{"key":"scope","value":"item_upload item_preview base_explorer","description":"The space-delimited list of scopes that you want apply to the\nnew access token.\n\nThe `subject_token` will need to have all of these scopes or\nthe call will error with **401 Unauthorized**..","disabled":true},{"key":"resource","value":"https://api.box.com/2.0/files/123456","description":"Full URL for the file that the token should be generated for.","disabled":true},{"key":"box_subject_type","value":"enterprise","description":"Used in combination with `client_credentials` as the `grant_type`.","disabled":true},{"key":"box_subject_id","value":"123456789","description":"Used in combination with `client_credentials` as the `grant_type`.\nValue is determined by `box_subject_type`. If `user` use user ID and if\n`enterprise` use enterprise ID.","disabled":true},{"key":"box_shared_link","value":"https://cloud.box.com/s/123456","description":"Full URL of the shared link on the file or folder\nthat the token should be generated for.","disabled":true}]},"url":"https://api.box.com/oauth2/token","description":"Request an Access Token using either a client-side obtained OAuth 2.0\n\nhttps://developer.box.com/reference/post-oauth2-token"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ\",\n \"expires_in\": 3600,\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_download\",\n \"object\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n }\n }\n ],\n \"refresh_token\": \"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ\",\n \"issued_token_type\": \"urn:ietf:params:oauth:token-type:access_token\"\n}"},{"id":"48b87df2-517d-476c-98d9-c6db771af8e1","name":"[400] An authentication error.","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","description":"The type of request being made, either using a client-side obtained\nauthorization code, a refresh token, a JWT assertion, client credentials\ngrant or another access token for the purpose of downscoping a token."},{"key":"client_id","value":"{{client_id}}","description":"The Client ID of the application requesting an access token.\n\nUsed in combination with `authorization_code`, `client_credentials`, or\n`urn:ietf:params:oauth:grant-type:jwt-bearer` as the `grant_type`.","disabled":true},{"key":"client_secret","value":"{{client_secret}}","description":"The client secret of the application requesting an access token.\n\nUsed in combination with `authorization_code`, `client_credentials`, or\n`urn:ietf:params:oauth:grant-type:jwt-bearer` as the `grant_type`.","disabled":true},{"key":"code","value":"n22JPxrh18m4Y0wIZPIqYZK7VRrsMTWW","description":"The client-side authorization code passed to your application by\nBox in the browser redirect after the user has successfully\ngranted your application permission to make API calls on their\nbehalf.\n\nUsed in combination with `authorization_code` as the `grant_type`.","disabled":true},{"key":"refresh_token","value":"{{refresh_token}}","description":"A refresh token used to get a new access token with.\n\nUsed in combination with `refresh_token` as the `grant_type`.","disabled":true},{"key":"assertion","value":"xxxxx.yyyyy.zzzzz","description":"A JWT assertion for which to request a new access token.\n\nUsed in combination with `urn:ietf:params:oauth:grant-type:jwt-bearer`\nas the `grant_type`.","disabled":true},{"key":"subject_token","value":"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ","description":"The token to exchange for a downscoped token. This can be a regular\naccess token, a JWT assertion, or an app token.\n\nUsed in combination with `urn:ietf:params:oauth:grant-type:token-exchange`\nas the `grant_type`.","disabled":true},{"key":"subject_token_type","value":"urn:ietf:params:oauth:token-type:access_token","description":"The type of `subject_token` passed in.\n\nUsed in combination with `urn:ietf:params:oauth:grant-type:token-exchange`\nas the `grant_type`.","disabled":true},{"key":"actor_token","value":"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ","description":"The token used to create an annotator token.\nThis is a JWT assertion.\n\nUsed in combination with `urn:ietf:params:oauth:grant-type:token-exchange`\nas the `grant_type`.","disabled":true},{"key":"actor_token_type","value":"urn:ietf:params:oauth:token-type:id_token","description":"The type of `actor_token` passed in.\n\nUsed in combination with `urn:ietf:params:oauth:grant-type:token-exchange`\nas the `grant_type`.","disabled":true},{"key":"scope","value":"item_upload item_preview base_explorer","description":"The space-delimited list of scopes that you want apply to the\nnew access token.\n\nThe `subject_token` will need to have all of these scopes or\nthe call will error with **401 Unauthorized**..","disabled":true},{"key":"resource","value":"https://api.box.com/2.0/files/123456","description":"Full URL for the file that the token should be generated for.","disabled":true},{"key":"box_subject_type","value":"enterprise","description":"Used in combination with `client_credentials` as the `grant_type`.","disabled":true},{"key":"box_subject_id","value":"123456789","description":"Used in combination with `client_credentials` as the `grant_type`.\nValue is determined by `box_subject_type`. If `user` use user ID and if\n`enterprise` use enterprise ID.","disabled":true},{"key":"box_shared_link","value":"https://cloud.box.com/s/123456","description":"Full URL of the shared link on the file or folder\nthat the token should be generated for.","disabled":true}]},"url":"https://api.box.com/oauth2/token","description":"Request an Access Token using either a client-side obtained OAuth 2.0\n\nhttps://developer.box.com/reference/post-oauth2-token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_client\",\n \"error_description\": \"The client credentials are not valid\"\n}"}],"_postman_id":"a9df5fa4-428b-4c70-8c20-9ba0cdc9aea1"},{"name":"Refresh access token","event":[{"listen":"test","script":{"id":"4e3b6e8d-119e-5c90-8095-25bb079039fb","type":"text/javascript","exec":["/* global pm */\n\n/**\n * Test script to run after every API request.\n *\n * Used to automatically pick up on a refreshed access token and store the new values.\n */\n\nconst updateAccessToken = () => {\n // only store a new value if the request was made to the right endpoint\n const isRightAPI = pm.request.url.path.join('/') === 'oauth2/token'\n if (!isRightAPI) { return }\n\n // only store the new value of there actually was a request body\n const hasBody = !!pm.request.body\n if (!hasBody) { return }\n\n // only store the new value if the body was urlencoded\n const isUrlEncoded = pm.request.body.mode === 'urlencoded'\n if (!isUrlEncoded) { return }\n\n // only store the new value if the body had a grant type\n const grantType = pm.request.body.urlencoded.filter(param => param.key === 'grant_type')[0]\n const hasGrantType = !!grantType\n if (!hasGrantType) { return }\n\n // only store the new value if the grant type was \"refresh_token\"\n const isRefreshTokenRequest = grantType.value === 'refresh_token'\n if (!isRefreshTokenRequest) { return }\n\n // only store the new value if the response has an access token\n const response = pm.response.json()\n const hasAccessToken = !!response.access_token\n if (!hasAccessToken) { return }\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + response.expires_in * 1000\n // store the new values\n pm.environment.set('access_token', response.access_token)\n pm.environment.set('refresh_token', response.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n}\n\nupdateAccessToken()\n"]}}],"id":"e7a076f2-f499-4841-b1d3-fdb414995ab0","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"refresh_token","description":"The type of request being made, in this case a refresh request.
\n"},{"key":"client_id","value":"{{client_id}}","description":"The client ID of the application requesting to refresh the token.
\n"},{"key":"client_secret","value":"{{client_secret}}","description":"The client secret of the application requesting to refresh the token.
\n"},{"key":"refresh_token","value":"{{refresh_token}}","description":"The refresh token to refresh.
\n"}]},"url":"https://api.box.com/oauth2/token","description":"Refresh an Access Token using its client ID, secret, and refresh token.
\nhttps://developer.box.com/reference/post-oauth2-token#refresh
\n","urlObject":{"protocol":"https","path":["oauth2","token"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"647603de-53ff-4232-b4af-407fb2469ba8","name":"[200] Returns a new Access Token that can be used to make authenticated","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"refresh_token","description":"The type of request being made, in this case a refresh request."},{"key":"client_id","value":"{{client_id}}","description":"The client ID of the application requesting to refresh the token."},{"key":"client_secret","value":"{{client_secret}}","description":"The client secret of the application requesting to refresh the token."},{"key":"refresh_token","value":"{{refresh_token}}","description":"The refresh token to refresh."}]},"url":"https://api.box.com/oauth2/token","description":"Refresh an Access Token using its client ID, secret, and refresh token.\n\nhttps://developer.box.com/reference/post-oauth2-token#refresh"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ\",\n \"expires_in\": 3600,\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_download\",\n \"object\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n }\n }\n ],\n \"refresh_token\": \"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ\",\n \"issued_token_type\": \"urn:ietf:params:oauth:token-type:access_token\"\n}"},{"id":"ee574150-9b83-439c-97fb-954584dab15e","name":"[400] An authentication error.","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"refresh_token","description":"The type of request being made, in this case a refresh request."},{"key":"client_id","value":"{{client_id}}","description":"The client ID of the application requesting to refresh the token."},{"key":"client_secret","value":"{{client_secret}}","description":"The client secret of the application requesting to refresh the token."},{"key":"refresh_token","value":"{{refresh_token}}","description":"The refresh token to refresh."}]},"url":"https://api.box.com/oauth2/token","description":"Refresh an Access Token using its client ID, secret, and refresh token.\n\nhttps://developer.box.com/reference/post-oauth2-token#refresh"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_client\",\n \"error_description\": \"The client credentials are not valid\"\n}"}],"_postman_id":"e7a076f2-f499-4841-b1d3-fdb414995ab0"},{"name":"Revoke access token","id":"51046863-3763-46e0-8ea1-02a163e7e8e6","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{client_id}}","description":"The Client ID of the application requesting to revoke the\naccess token.
\n","disabled":true},{"key":"client_secret","value":"{{client_secret}}","description":"The client secret of the application requesting to revoke\nan access token.
\n","disabled":true},{"key":"token","value":"n22JPxrh18m4Y0wIZPIqYZK7VRrsMTWW","description":"The access token to revoke.
\n","disabled":true}]},"url":"https://api.box.com/oauth2/revoke","description":"Revoke an active Access Token, effectively logging a user out
\nhttps://developer.box.com/reference/post-oauth2-revoke
\n","urlObject":{"protocol":"https","path":["oauth2","revoke"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"d45c778b-dc51-4d98-b2e9-344fd8b343e3","name":"[200] Returns an empty response when the token was successfully revoked.","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{client_id}}","description":"The Client ID of the application requesting to revoke the\naccess token.","disabled":true},{"key":"client_secret","value":"{{client_secret}}","description":"The client secret of the application requesting to revoke\nan access token.","disabled":true},{"key":"token","value":"n22JPxrh18m4Y0wIZPIqYZK7VRrsMTWW","description":"The access token to revoke.","disabled":true}]},"url":"https://api.box.com/oauth2/revoke","description":"Revoke an active Access Token, effectively logging a user out\n\nhttps://developer.box.com/reference/post-oauth2-revoke"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"dff7c299-92e9-4b05-873d-4d58248ed380","name":"[400] An authentication error.","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{client_id}}","description":"The Client ID of the application requesting to revoke the\naccess token.","disabled":true},{"key":"client_secret","value":"{{client_secret}}","description":"The client secret of the application requesting to revoke\nan access token.","disabled":true},{"key":"token","value":"n22JPxrh18m4Y0wIZPIqYZK7VRrsMTWW","description":"The access token to revoke.","disabled":true}]},"url":"https://api.box.com/oauth2/revoke","description":"Revoke an active Access Token, effectively logging a user out\n\nhttps://developer.box.com/reference/post-oauth2-revoke"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_client\",\n \"error_description\": \"The client credentials are not valid\"\n}"}],"_postman_id":"51046863-3763-46e0-8ea1-02a163e7e8e6"}],"id":"4f561aa4-c2c7-4b5a-bff3-50d583fa1994","_postman_id":"4f561aa4-c2c7-4b5a-bff3-50d583fa1994","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Get the AI agent default config.
\nhttps://developer.box.com/reference/get-ai-agent-default
\n","urlObject":{"protocol":"https","path":["2.0","ai_agent_default"],"host":["api.box.com"],"query":[{"description":{"content":"The mode to filter the agent config to return.
\n","type":"text/plain"},"key":"mode","value":"ask"},{"disabled":true,"description":{"content":"The ISO language code to return the agent config for.\nIf the language is not supported the default agent config is returned.
\n","type":"text/plain"},"key":"language","value":"ja"},{"disabled":true,"description":{"content":"The model to return the default agent config for.
\n","type":"text/plain"},"key":"model","value":"azure__openai__gpt_4o_mini"}],"variable":[]}},"response":[{"id":"567a0e97-45f5-460f-a2d4-7054307bc1e1","name":"[200] A successful response including the default agent configuration.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/ai_agent_default?mode=ask","protocol":"https","host":["api.box.com"],"path":["2.0","ai_agent_default"],"query":[{"key":"mode","value":"ask","description":"The mode to filter the agent config to return."},{"key":"language","value":"ja","description":"The ISO language code to return the agent config for.\nIf the language is not supported the default agent config is returned.","disabled":true},{"key":"model","value":"azure__openai__gpt_4o_mini","description":"The model to return the default agent config for.","disabled":true}]},"description":"Get the AI agent default config.\n\nhttps://developer.box.com/reference/get-ai-agent-default"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"ai_agent_ask\",\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n }\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\"\n },\n \"spreadsheet\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n }\n },\n \"long_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n }\n },\n \"basic_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\"\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\"\n },\n \"basic_image_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\"\n }\n}"},{"id":"78868e04-4da6-4519-8190-f2f8d87b6175","name":"[500] An unexpected server error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/ai_agent_default?mode=ask","protocol":"https","host":["api.box.com"],"path":["2.0","ai_agent_default"],"query":[{"key":"mode","value":"ask","description":"The mode to filter the agent config to return."},{"key":"language","value":"ja","description":"The ISO language code to return the agent config for.\nIf the language is not supported the default agent config is returned.","disabled":true},{"key":"model","value":"azure__openai__gpt_4o_mini","description":"The model to return the default agent config for.","disabled":true}]},"description":"Get the AI agent default config.\n\nhttps://developer.box.com/reference/get-ai-agent-default"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"bb8774fb-6117-4a53-93d3-5a7f7dd7d9c3"},{"name":"Ask question","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"d7ad0c28-08b1-483a-ac0c-2077ac02658f","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.
\nhttps://developer.box.com/reference/post-ai-ask
\n","urlObject":{"protocol":"https","path":["2.0","ai","ask"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"73cf2aae-d484-4c1f-b263-2eda520bc6d7","name":"[200] A successful response including the answer from the LLM.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mode\": \"multiple_item_qa\",\n \"prompt\": \"What is the value provided by public APIs based on this document?\",\n \"items\": [\n {\n \"id\": \"123\",\n \"type\": \"file\",\n \"content\": \"This is file content.\"\n }\n ],\n \"dialogue_history\": [\n {\n \"prompt\": \"Make my email about public APIs sound more professional.\",\n \"answer\": \"Here is the first draft of your professional email about public APIs.\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ],\n \"include_citations\": true,\n \"ai_agent\": {\n \"type\": \"ai_agent_id\",\n \"id\": \"14031\"\n }\n}"},"url":"https://api.box.com/2.0/ai/ask","description":"Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.\n\nhttps://developer.box.com/reference/post-ai-ask"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"answer\": \"Public APIs are important because of key and important reasons.\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"completion_reason\": \"done\",\n \"ai_agent_info\": {\n \"models\": [\n {\n \"name\": \"azure__openai__text_embedding_ada_002\",\n \"provider\": \"azure\",\n \"supported_purpose\": \"embedding\"\n }\n ],\n \"processor\": \"basic_text\"\n },\n \"citations\": [\n {\n \"content\": \"Public APIs are key drivers of innovation and growth.\",\n \"id\": \"123\",\n \"type\": \"file\",\n \"name\": \"The importance of public APIs.pdf\"\n }\n ]\n}"},{"id":"9144b4c2-d03a-47d1-80ff-cfaae7f7fbc9","name":"[204] No content is available to answer the question. This is returned when the request item is a hub, but content in the hubs is not indexed. To ensure content in the hub is indexed, make sure Box AI for Hubs in the Admin Console was enabled before hub c","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mode\": \"multiple_item_qa\",\n \"prompt\": \"What is the value provided by public APIs based on this document?\",\n \"items\": [\n {\n \"id\": \"123\",\n \"type\": \"file\",\n \"content\": \"This is file content.\"\n }\n ],\n \"dialogue_history\": [\n {\n \"prompt\": \"Make my email about public APIs sound more professional.\",\n \"answer\": \"Here is the first draft of your professional email about public APIs.\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ],\n \"include_citations\": true,\n \"ai_agent\": {\n \"type\": \"ai_agent_id\",\n \"id\": \"14031\"\n }\n}"},"url":"https://api.box.com/2.0/ai/ask","description":"Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.\n\nhttps://developer.box.com/reference/post-ai-ask"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"0efd4ab6-4c65-4e1a-a313-fcab00f65992","name":"[500] An unexpected server error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mode\": \"multiple_item_qa\",\n \"prompt\": \"What is the value provided by public APIs based on this document?\",\n \"items\": [\n {\n \"id\": \"123\",\n \"type\": \"file\",\n \"content\": \"This is file content.\"\n }\n ],\n \"dialogue_history\": [\n {\n \"prompt\": \"Make my email about public APIs sound more professional.\",\n \"answer\": \"Here is the first draft of your professional email about public APIs.\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ],\n \"include_citations\": true,\n \"ai_agent\": {\n \"type\": \"ai_agent_id\",\n \"id\": \"14031\"\n }\n}"},"url":"https://api.box.com/2.0/ai/ask","description":"Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.\n\nhttps://developer.box.com/reference/post-ai-ask"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"d7ad0c28-08b1-483a-ac0c-2077ac02658f"},{"name":"Generate text","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"0eb1709c-4964-4ad6-99f2-70e36912a421","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Sends an AI request to supported Large Language Models (LLMs) and returns generated text based on the provided prompt.
\nhttps://developer.box.com/reference/post-ai-text-gen
\n","urlObject":{"protocol":"https","path":["2.0","ai","text_gen"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"36d1eb12-eaf7-48c1-a4eb-0ae5337dae32","name":"[200] A successful response including the answer from the LLM.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"prompt\": \"Write an email to a client about the importance of public APIs.\",\n \"items\": [\n {\n \"id\": \"123\",\n \"type\": \"file\",\n \"content\": \"This is file content that is relevant to the text gen request.\"\n }\n ],\n \"dialogue_history\": [\n {\n \"prompt\": \"Make my email about public APIs sound more professional.\",\n \"answer\": \"Here is the first draft of your professional email about public APIs.\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ],\n \"ai_agent\": {\n \"type\": \"ai_agent_id\",\n \"id\": \"14031\"\n }\n}"},"url":"https://api.box.com/2.0/ai/text_gen","description":"Sends an AI request to supported Large Language Models (LLMs) and returns generated text based on the provided prompt.\n\nhttps://developer.box.com/reference/post-ai-text-gen"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"answer\": \"Public APIs are important because of key and important reasons.\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"completion_reason\": \"done\",\n \"ai_agent_info\": {\n \"models\": [\n {\n \"name\": \"azure__openai__text_embedding_ada_002\",\n \"provider\": \"azure\",\n \"supported_purpose\": \"embedding\"\n }\n ],\n \"processor\": \"basic_text\"\n }\n}"},{"id":"b766db5d-8e0c-4ccc-9b2c-7c3d9d423930","name":"[500] An unexpected server error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"prompt\": \"Write an email to a client about the importance of public APIs.\",\n \"items\": [\n {\n \"id\": \"123\",\n \"type\": \"file\",\n \"content\": \"This is file content that is relevant to the text gen request.\"\n }\n ],\n \"dialogue_history\": [\n {\n \"prompt\": \"Make my email about public APIs sound more professional.\",\n \"answer\": \"Here is the first draft of your professional email about public APIs.\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ],\n \"ai_agent\": {\n \"type\": \"ai_agent_id\",\n \"id\": \"14031\"\n }\n}"},"url":"https://api.box.com/2.0/ai/text_gen","description":"Sends an AI request to supported Large Language Models (LLMs) and returns generated text based on the provided prompt.\n\nhttps://developer.box.com/reference/post-ai-text-gen"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"0eb1709c-4964-4ad6-99f2-70e36912a421"},{"name":"Extract metadata (freeform)","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"2220a834-e163-47d0-91d4-784b5a4b734f","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs.
\nhttps://developer.box.com/reference/post-ai-extract
\n","urlObject":{"protocol":"https","path":["2.0","ai","extract"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"a87c3c30-7290-4f51-b9bf-ec44f1113ed5","name":"[200] A response including the answer from the LLM.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"prompt\": \"\\\\\\\"fields\\\\\\\":[{\\\\\\\"type\\\\\\\":\\\\\\\"string\\\\\\\",\\\\\\\"key\\\\\\\":\\\\\\\"name\\\\\\\",\\\\\\\"displayName\\\\\\\":\\\\\\\"Name\\\\\\\",\\\\\\\"description\\\\\\\":\\\\\\\"The customer name\\\\\\\",\\\\\\\"prompt\\\\\\\":\\\\\\\"Name is always the first word in the document\\\\\\\"},{\\\\\\\"type\\\\\\\":\\\\\\\"date\\\\\\\",\\\\\\\"key\\\\\\\":\\\\\\\"last_contacted_at\\\\\\\",\\\\\\\"displayName\\\\\\\":\\\\\\\"Last Contacted At\\\\\\\",\\\\\\\"description\\\\\\\":\\\\\\\"When this customer was last contacted at\\\\\\\"}]\",\n \"items\": [\n {\n \"id\": \"123\",\n \"type\": \"file\",\n \"content\": \"This is file content.\"\n }\n ],\n \"ai_agent\": {\n \"type\": \"ai_agent_id\",\n \"id\": \"14031\"\n }\n}"},"url":"https://api.box.com/2.0/ai/extract","description":"Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs.\n\nhttps://developer.box.com/reference/post-ai-extract"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"answer\": \"Public APIs are important because of key and important reasons.\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"completion_reason\": \"done\",\n \"ai_agent_info\": {\n \"models\": [\n {\n \"name\": \"azure__openai__text_embedding_ada_002\",\n \"provider\": \"azure\",\n \"supported_purpose\": \"embedding\"\n }\n ],\n \"processor\": \"basic_text\"\n }\n}"},{"id":"fada793f-e2e9-459b-a3b8-3f364fb9ef7d","name":"[500] An unexpected server error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"prompt\": \"\\\\\\\"fields\\\\\\\":[{\\\\\\\"type\\\\\\\":\\\\\\\"string\\\\\\\",\\\\\\\"key\\\\\\\":\\\\\\\"name\\\\\\\",\\\\\\\"displayName\\\\\\\":\\\\\\\"Name\\\\\\\",\\\\\\\"description\\\\\\\":\\\\\\\"The customer name\\\\\\\",\\\\\\\"prompt\\\\\\\":\\\\\\\"Name is always the first word in the document\\\\\\\"},{\\\\\\\"type\\\\\\\":\\\\\\\"date\\\\\\\",\\\\\\\"key\\\\\\\":\\\\\\\"last_contacted_at\\\\\\\",\\\\\\\"displayName\\\\\\\":\\\\\\\"Last Contacted At\\\\\\\",\\\\\\\"description\\\\\\\":\\\\\\\"When this customer was last contacted at\\\\\\\"}]\",\n \"items\": [\n {\n \"id\": \"123\",\n \"type\": \"file\",\n \"content\": \"This is file content.\"\n }\n ],\n \"ai_agent\": {\n \"type\": \"ai_agent_id\",\n \"id\": \"14031\"\n }\n}"},"url":"https://api.box.com/2.0/ai/extract","description":"Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs.\n\nhttps://developer.box.com/reference/post-ai-extract"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"2220a834-e163-47d0-91d4-784b5a4b734f"},{"name":"Extract metadata (structured)","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"1a0bdc0c-9387-4eb8-8269-ee5a83a35f5d","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
\nhttps://developer.box.com/reference/post-ai-extract-structured
\n","urlObject":{"protocol":"https","path":["2.0","ai","extract_structured"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"1b41be8e-aa99-4179-95d5-3f9fb1e032b9","name":"[200] A successful response including the answer from the LLM.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"id\": \"123\",\n \"type\": \"file\",\n \"content\": \"This is file content.\"\n }\n ],\n \"metadata_template\": {\n \"template_key\": \"invoiceTemplate\",\n \"type\": \"metadata_template\",\n \"scope\": \"enterprise_12345\"\n },\n \"fields\": [\n {\n \"key\": \"name\",\n \"description\": \"The name of the person.\",\n \"displayName\": \"Name\",\n \"prompt\": \"Name is the first and last name from the email address\",\n \"type\": \"enum\",\n \"options\": [\n {\n \"key\": \"First Name\"\n },\n {\n \"key\": \"Last Name\"\n }\n ]\n }\n ],\n \"include_confidence_score\": true,\n \"include_reference\": true,\n \"ai_agent\": {\n \"type\": \"ai_agent_id\",\n \"id\": \"14031\"\n }\n}"},"url":"https://api.box.com/2.0/ai/extract_structured","description":"Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.\n\nhttps://developer.box.com/reference/post-ai-extract-structured"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"answer\": \"AI extract response.\\nThe content of this response may vary depending on\\nthe requested configuration.\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"completion_reason\": \"done\",\n \"confidence_score\": \"The confidence score levels and numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted.\",\n \"reference\": \"The reference for each extracted field as a JSON dictionary. This can be empty if no field could be extracted.\",\n \"ai_agent_info\": {\n \"models\": [\n {\n \"name\": \"azure__openai__text_embedding_ada_002\",\n \"provider\": \"azure\",\n \"supported_purpose\": \"embedding\"\n }\n ],\n \"processor\": \"basic_text\"\n }\n}"},{"id":"312e585a-a4af-4215-9037-5af29130a980","name":"[500] An unexpected server error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"id\": \"123\",\n \"type\": \"file\",\n \"content\": \"This is file content.\"\n }\n ],\n \"metadata_template\": {\n \"template_key\": \"invoiceTemplate\",\n \"type\": \"metadata_template\",\n \"scope\": \"enterprise_12345\"\n },\n \"fields\": [\n {\n \"key\": \"name\",\n \"description\": \"The name of the person.\",\n \"displayName\": \"Name\",\n \"prompt\": \"Name is the first and last name from the email address\",\n \"type\": \"enum\",\n \"options\": [\n {\n \"key\": \"First Name\"\n },\n {\n \"key\": \"Last Name\"\n }\n ]\n }\n ],\n \"include_confidence_score\": true,\n \"include_reference\": true,\n \"ai_agent\": {\n \"type\": \"ai_agent_id\",\n \"id\": \"14031\"\n }\n}"},"url":"https://api.box.com/2.0/ai/extract_structured","description":"Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.\n\nhttps://developer.box.com/reference/post-ai-extract-structured"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"1a0bdc0c-9387-4eb8-8269-ee5a83a35f5d"}],"id":"e9e802a9-f87f-46b6-98c5-3326f79ab3e7","_postman_id":"e9e802a9-f87f-46b6-98c5-3326f79ab3e7","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Lists AI agents based on the provided parameters.
\nhttps://developer.box.com/reference/get-ai-agents
\n","urlObject":{"protocol":"https","path":["2.0","ai_agents"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"The mode to filter the agent config to return. Possible values are: ask, text_gen, and extract.
The fields to return in the response.
\n","type":"text/plain"},"key":"fields","value":"ask,text_gen,extract"},{"disabled":true,"description":{"content":"The state of the agents to return. Possible values are: enabled, disabled and enabled_for_selected_users.
Whether to include the Box default agents in the response.
\n","type":"text/plain"},"key":"include_box_default","value":"true"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results.
\n","type":"text/plain"},"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"3bb7b585-824e-43c0-864e-06ec77db8dd2","name":"[200] A successful response including the agents list.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/ai_agents","protocol":"https","host":["api.box.com"],"path":["2.0","ai_agents"],"query":[{"key":"mode","value":"ask,text_gen,extract","description":"The mode to filter the agent config to return. Possible values are: `ask`, `text_gen`, and `extract`.","disabled":true},{"key":"fields","value":"ask,text_gen,extract","description":"The fields to return in the response.","disabled":true},{"key":"agent_state","value":"enabled","description":"The state of the agents to return. Possible values are: `enabled`, `disabled` and `enabled_for_selected_users`.","disabled":true},{"key":"include_box_default","value":"true","description":"Whether to include the Box default agents in the response.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Lists AI agents based on the provided parameters.\n\nhttps://developer.box.com/reference/get-ai-agents"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"1234567890\",\n \"type\": \"ai_agent\",\n \"origin\": \"CUSTOM\",\n \"name\": \"This is my Agent\",\n \"access_state\": \"enabled\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"created_at\": \"2022-01-01T00:00:00Z\",\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"modified_at\": \"2022-01-01T00:00:00Z\",\n \"icon_reference\": \"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg\",\n \"allowed_entities\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"ask\": {\n \"type\": \"ai_agent_ask\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"spreadsheet\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"long_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_image_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n }\n },\n \"text_gen\": {\n \"type\": \"ai_agent_text_gen\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"basic_gen\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"content_template\": \"---{content}---\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n }\n },\n \"extract\": {\n \"type\": \"ai_agent_extract\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n }\n }\n }\n ]\n}"},{"id":"f0b04a52-3089-46c2-9311-f8923f512c63","name":"[400] An unexpected client error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/ai_agents","protocol":"https","host":["api.box.com"],"path":["2.0","ai_agents"],"query":[{"key":"mode","value":"ask,text_gen,extract","description":"The mode to filter the agent config to return. Possible values are: `ask`, `text_gen`, and `extract`.","disabled":true},{"key":"fields","value":"ask,text_gen,extract","description":"The fields to return in the response.","disabled":true},{"key":"agent_state","value":"enabled","description":"The state of the agents to return. Possible values are: `enabled`, `disabled` and `enabled_for_selected_users`.","disabled":true},{"key":"include_box_default","value":"true","description":"Whether to include the Box default agents in the response.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Lists AI agents based on the provided parameters.\n\nhttps://developer.box.com/reference/get-ai-agents"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"f80a06cd-70ee-4c63-ba38-bbedbb978847","name":"[500] An unexpected server error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/ai_agents","protocol":"https","host":["api.box.com"],"path":["2.0","ai_agents"],"query":[{"key":"mode","value":"ask,text_gen,extract","description":"The mode to filter the agent config to return. Possible values are: `ask`, `text_gen`, and `extract`.","disabled":true},{"key":"fields","value":"ask,text_gen,extract","description":"The fields to return in the response.","disabled":true},{"key":"agent_state","value":"enabled","description":"The state of the agents to return. Possible values are: `enabled`, `disabled` and `enabled_for_selected_users`.","disabled":true},{"key":"include_box_default","value":"true","description":"Whether to include the Box default agents in the response.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Lists AI agents based on the provided parameters.\n\nhttps://developer.box.com/reference/get-ai-agents"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"10cd00ff-8654-47f9-8b85-91f41c6ed6ef"},{"name":"Get AI agent by agent ID","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"9ed5ebb2-949f-4095-8d9b-555133a0c37c","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Gets an AI Agent using the agent_id parameter.
\nhttps://developer.box.com/reference/get-ai-agents-id
\n","urlObject":{"protocol":"https","path":["2.0","ai_agents",":agent_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"The fields to return in the response.
\n","type":"text/plain"},"key":"fields","value":"ask,text_gen,extract"}],"variable":[{"id":"dd264490-6c4e-4b4a-b19d-9173fbefd323","description":{"content":"The agent id to get.
\n","type":"text/plain"},"type":"any","value":"1234","key":"agent_id"}]}},"response":[{"id":"d427f5e7-d890-4d96-9c79-9b4975322439","name":"[200] A successful response including the agent.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/ai_agents/:agent_id","protocol":"https","host":["api.box.com"],"path":["2.0","ai_agents",":agent_id"],"query":[{"key":"fields","value":"ask,text_gen,extract","description":"The fields to return in the response.","disabled":true}],"variable":[{"id":"dd264490-6c4e-4b4a-b19d-9173fbefd323","key":"agent_id","value":"1234","description":"The agent id to get."}]},"description":"Gets an AI Agent using the agent_id parameter.\n\nhttps://developer.box.com/reference/get-ai-agents-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1234567890\",\n \"type\": \"ai_agent\",\n \"origin\": \"CUSTOM\",\n \"name\": \"This is my Agent\",\n \"access_state\": \"enabled\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"created_at\": \"2022-01-01T00:00:00Z\",\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"modified_at\": \"2022-01-01T00:00:00Z\",\n \"icon_reference\": \"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg\",\n \"allowed_entities\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"ask\": {\n \"type\": \"ai_agent_ask\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"spreadsheet\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"long_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_image_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n }\n },\n \"text_gen\": {\n \"type\": \"ai_agent_text_gen\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"basic_gen\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"content_template\": \"---{content}---\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n }\n },\n \"extract\": {\n \"type\": \"ai_agent_extract\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n }\n }\n}"},{"id":"2707702c-5c4c-4e34-9112-626f095b36a0","name":"[400] An unexpected client error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/ai_agents/:agent_id","protocol":"https","host":["api.box.com"],"path":["2.0","ai_agents",":agent_id"],"query":[{"key":"fields","value":"ask,text_gen,extract","description":"The fields to return in the response.","disabled":true}],"variable":[{"id":"dd264490-6c4e-4b4a-b19d-9173fbefd323","key":"agent_id","value":"1234","description":"The agent id to get."}]},"description":"Gets an AI Agent using the agent_id parameter.\n\nhttps://developer.box.com/reference/get-ai-agents-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"20e58f96-4118-419b-92b5-41878cee0585","name":"[500] An unexpected server error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/ai_agents/:agent_id","protocol":"https","host":["api.box.com"],"path":["2.0","ai_agents",":agent_id"],"query":[{"key":"fields","value":"ask,text_gen,extract","description":"The fields to return in the response.","disabled":true}],"variable":[{"id":"dd264490-6c4e-4b4a-b19d-9173fbefd323","key":"agent_id","value":"1234","description":"The agent id to get."}]},"description":"Gets an AI Agent using the agent_id parameter.\n\nhttps://developer.box.com/reference/get-ai-agents-id"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"9ed5ebb2-949f-4095-8d9b-555133a0c37c"},{"name":"Create AI agent","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"642b94f6-b669-415f-8d0f-33b229e8a0e6","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates an AI agent. At least one of the following capabilities must be provided: ask, text_gen, extract.
\nhttps://developer.box.com/reference/post-ai-agents
\n","urlObject":{"protocol":"https","path":["2.0","ai_agents"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"063e2f2d-ce1a-416a-bd7c-9c0485b984ab","name":"[200] Definition of created AI agent.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"ai_agent\",\n \"name\": \"My AI Agent\",\n \"access_state\": \"enabled\",\n \"icon_reference\": \"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg\",\n \"allowed_entities\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"ask\": {\n \"type\": \"ai_agent_ask\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"spreadsheet\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n }\n },\n \"long_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n }\n },\n \"text_gen\": {\n \"type\": \"ai_agent_text_gen\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"basic_gen\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"content_template\": \"---{content}---\",\n \"is_custom_instructions_included\": false\n }\n },\n \"extract\": {\n \"type\": \"ai_agent_extract\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n }\n }\n}"},"url":"https://api.box.com/2.0/ai_agents","description":"Creates an AI agent. At least one of the following capabilities must be provided: ask, text_gen, extract.\n\nhttps://developer.box.com/reference/post-ai-agents"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1234567890\",\n \"type\": \"ai_agent\",\n \"origin\": \"CUSTOM\",\n \"name\": \"This is my Agent\",\n \"access_state\": \"enabled\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"created_at\": \"2022-01-01T00:00:00Z\",\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"modified_at\": \"2022-01-01T00:00:00Z\",\n \"icon_reference\": \"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg\",\n \"allowed_entities\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"ask\": {\n \"type\": \"ai_agent_ask\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"spreadsheet\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"long_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_image_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n }\n },\n \"text_gen\": {\n \"type\": \"ai_agent_text_gen\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"basic_gen\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"content_template\": \"---{content}---\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n }\n },\n \"extract\": {\n \"type\": \"ai_agent_extract\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n }\n }\n}"},{"id":"6db9caa2-329e-49d7-a022-f3ca1ad6c9cd","name":"[400] An unexpected client error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"ai_agent\",\n \"name\": \"My AI Agent\",\n \"access_state\": \"enabled\",\n \"icon_reference\": \"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg\",\n \"allowed_entities\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"ask\": {\n \"type\": \"ai_agent_ask\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"spreadsheet\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n }\n },\n \"long_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n }\n },\n \"text_gen\": {\n \"type\": \"ai_agent_text_gen\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"basic_gen\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"content_template\": \"---{content}---\",\n \"is_custom_instructions_included\": false\n }\n },\n \"extract\": {\n \"type\": \"ai_agent_extract\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n }\n }\n}"},"url":"https://api.box.com/2.0/ai_agents","description":"Creates an AI agent. At least one of the following capabilities must be provided: ask, text_gen, extract.\n\nhttps://developer.box.com/reference/post-ai-agents"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"3c3180e1-a732-490d-a140-6f5526d53f35","name":"[500] An unexpected server error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"ai_agent\",\n \"name\": \"My AI Agent\",\n \"access_state\": \"enabled\",\n \"icon_reference\": \"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg\",\n \"allowed_entities\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"ask\": {\n \"type\": \"ai_agent_ask\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"spreadsheet\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n }\n },\n \"long_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n }\n },\n \"text_gen\": {\n \"type\": \"ai_agent_text_gen\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"basic_gen\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"content_template\": \"---{content}---\",\n \"is_custom_instructions_included\": false\n }\n },\n \"extract\": {\n \"type\": \"ai_agent_extract\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n }\n }\n}"},"url":"https://api.box.com/2.0/ai_agents","description":"Creates an AI agent. At least one of the following capabilities must be provided: ask, text_gen, extract.\n\nhttps://developer.box.com/reference/post-ai-agents"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"642b94f6-b669-415f-8d0f-33b229e8a0e6"},{"name":"Update AI agent","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"811ec9cb-5f54-4fa7-b266-6912fb3c369e","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Updates an AI agent.
\nhttps://developer.box.com/reference/put-ai-agents-id
\n","urlObject":{"protocol":"https","path":["2.0","ai_agents",":agent_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"d07f10bd-680f-4774-b51e-25267e485f77","description":{"content":"The ID of the agent to update.
\n","type":"text/plain"},"type":"any","value":"1234","key":"agent_id"}]}},"response":[{"id":"1e79fe5c-d189-49c5-9b6f-d3a95a476e73","name":"[200] Definition of created AI agent.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"ai_agent\",\n \"name\": \"My AI Agent\",\n \"access_state\": \"enabled\",\n \"icon_reference\": \"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg\",\n \"allowed_entities\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"ask\": {\n \"type\": \"ai_agent_ask\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"spreadsheet\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n }\n },\n \"long_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n }\n },\n \"text_gen\": {\n \"type\": \"ai_agent_text_gen\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"basic_gen\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"content_template\": \"---{content}---\",\n \"is_custom_instructions_included\": false\n }\n },\n \"extract\": {\n \"type\": \"ai_agent_extract\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n }\n }\n}"},"url":{"raw":"https://api.box.com/2.0/ai_agents/:agent_id","protocol":"https","host":["api.box.com"],"path":["2.0","ai_agents",":agent_id"],"variable":[{"id":"d07f10bd-680f-4774-b51e-25267e485f77","key":"agent_id","value":"1234","description":"The ID of the agent to update."}]},"description":"Updates an AI agent.\n\nhttps://developer.box.com/reference/put-ai-agents-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1234567890\",\n \"type\": \"ai_agent\",\n \"origin\": \"CUSTOM\",\n \"name\": \"This is my Agent\",\n \"access_state\": \"enabled\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"created_at\": \"2022-01-01T00:00:00Z\",\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"modified_at\": \"2022-01-01T00:00:00Z\",\n \"icon_reference\": \"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg\",\n \"allowed_entities\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"ask\": {\n \"type\": \"ai_agent_ask\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"spreadsheet\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"long_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_image_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n }\n },\n \"text_gen\": {\n \"type\": \"ai_agent_text_gen\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"basic_gen\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"content_template\": \"---{content}---\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n }\n },\n \"extract\": {\n \"type\": \"ai_agent_extract\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false,\n \"warnings\": [\n \"MODEL_INACTIVE\"\n ]\n }\n }\n}"},{"id":"84c0c44f-e128-4941-b3ba-f7a61c9dcf21","name":"[400] An unexpected client error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"ai_agent\",\n \"name\": \"My AI Agent\",\n \"access_state\": \"enabled\",\n \"icon_reference\": \"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg\",\n \"allowed_entities\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"ask\": {\n \"type\": \"ai_agent_ask\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"spreadsheet\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n }\n },\n \"long_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n }\n },\n \"text_gen\": {\n \"type\": \"ai_agent_text_gen\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"basic_gen\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"content_template\": \"---{content}---\",\n \"is_custom_instructions_included\": false\n }\n },\n \"extract\": {\n \"type\": \"ai_agent_extract\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n }\n }\n}"},"url":{"raw":"https://api.box.com/2.0/ai_agents/:agent_id","protocol":"https","host":["api.box.com"],"path":["2.0","ai_agents",":agent_id"],"variable":[{"id":"d07f10bd-680f-4774-b51e-25267e485f77","key":"agent_id","value":"1234","description":"The ID of the agent to update."}]},"description":"Updates an AI agent.\n\nhttps://developer.box.com/reference/put-ai-agents-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"dd805b83-522e-4b22-b734-b923ffa7b8ae","name":"[500] An unexpected server error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"ai_agent\",\n \"name\": \"My AI Agent\",\n \"access_state\": \"enabled\",\n \"icon_reference\": \"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg\",\n \"allowed_entities\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"ask\": {\n \"type\": \"ai_agent_ask\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"spreadsheet\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n }\n },\n \"long_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image_multi\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n }\n },\n \"text_gen\": {\n \"type\": \"ai_agent_text_gen\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"suggested_questions\": [\n \"What is in this file?\",\n \"What are the main highlights of this document?\"\n ],\n \"basic_gen\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"content_template\": \"---{content}---\",\n \"is_custom_instructions_included\": false\n }\n },\n \"extract\": {\n \"type\": \"ai_agent_extract\",\n \"access_state\": \"enabled\",\n \"description\": \"This is ASK Agent\",\n \"custom_instructions\": \"This is a custom instruction\",\n \"long_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"embeddings\": {\n \"model\": \"azure__openai__text_embedding_ada_002\",\n \"strategy\": {\n \"id\": \"basic\",\n \"num_tokens_per_chunk\": 64\n }\n },\n \"is_custom_instructions_included\": false\n },\n \"basic_text\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n },\n \"basic_image\": {\n \"model\": \"azure__openai__gpt_4o_mini\",\n \"num_tokens_for_completion\": 8400,\n \"llm_endpoint_params\": {\n \"type\": \"openai_params\",\n \"temperature\": 0,\n \"top_p\": 1,\n \"frequency_penalty\": 1.5,\n \"presence_penalty\": 1.5,\n \"stop\": \"<|im_end|>\"\n },\n \"system_message\": \"You are a helpful travel assistant specialized in budget travel\",\n \"prompt_template\": \"It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.\",\n \"is_custom_instructions_included\": false\n }\n }\n}"},"url":{"raw":"https://api.box.com/2.0/ai_agents/:agent_id","protocol":"https","host":["api.box.com"],"path":["2.0","ai_agents",":agent_id"],"variable":[{"id":"d07f10bd-680f-4774-b51e-25267e485f77","key":"agent_id","value":"1234","description":"The ID of the agent to update."}]},"description":"Updates an AI agent.\n\nhttps://developer.box.com/reference/put-ai-agents-id"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"811ec9cb-5f54-4fa7-b266-6912fb3c369e"},{"name":"Delete AI agent","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"d14db250-1bdc-45e3-a817-ed9c60e3c022","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Deletes an AI agent using the provided parameters.
\nhttps://developer.box.com/reference/delete-ai-agents-id
\n","urlObject":{"protocol":"https","path":["2.0","ai_agents",":agent_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"cb4dc8dd-8d71-471e-a736-570ce8e9f854","description":{"content":"The ID of the agent to delete.
\n","type":"text/plain"},"type":"any","value":"1234","key":"agent_id"}]}},"response":[{"id":"08fc83a8-b5a0-401c-aab3-392875f23bfd","name":"[204] A successful response with no content.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/ai_agents/:agent_id","protocol":"https","host":["api.box.com"],"path":["2.0","ai_agents",":agent_id"],"variable":[{"id":"cb4dc8dd-8d71-471e-a736-570ce8e9f854","key":"agent_id","value":"1234","description":"The ID of the agent to delete."}]},"description":"Deletes an AI agent using the provided parameters.\n\nhttps://developer.box.com/reference/delete-ai-agents-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"ddbac887-b30a-4e23-9e90-002ff133cbeb","name":"[400] An unexpected client error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/ai_agents/:agent_id","protocol":"https","host":["api.box.com"],"path":["2.0","ai_agents",":agent_id"],"variable":[{"id":"cb4dc8dd-8d71-471e-a736-570ce8e9f854","key":"agent_id","value":"1234","description":"The ID of the agent to delete."}]},"description":"Deletes an AI agent using the provided parameters.\n\nhttps://developer.box.com/reference/delete-ai-agents-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"c9119a98-7957-490a-bdf0-77879e77019a","name":"[404] Returned if the AI agent is not found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/ai_agents/:agent_id","protocol":"https","host":["api.box.com"],"path":["2.0","ai_agents",":agent_id"],"variable":[{"id":"cb4dc8dd-8d71-471e-a736-570ce8e9f854","key":"agent_id","value":"1234","description":"The ID of the agent to delete."}]},"description":"Deletes an AI agent using the provided parameters.\n\nhttps://developer.box.com/reference/delete-ai-agents-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"530e4848-4950-40d2-93ad-dacb4cfd51f3","name":"[500] An unexpected server error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/ai_agents/:agent_id","protocol":"https","host":["api.box.com"],"path":["2.0","ai_agents",":agent_id"],"variable":[{"id":"cb4dc8dd-8d71-471e-a736-570ce8e9f854","key":"agent_id","value":"1234","description":"The ID of the agent to delete."}]},"description":"Deletes an AI agent using the provided parameters.\n\nhttps://developer.box.com/reference/delete-ai-agents-id"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"d14db250-1bdc-45e3-a817-ed9c60e3c022"}],"id":"99ae8919-8f95-473e-b50d-3dc68814effc","_postman_id":"99ae8919-8f95-473e-b50d-3dc68814effc","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"This is a beta feature, which means that its availability might be limited.
\nhttps://developer.box.com/reference/get-files-id-app-item-associations
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","app_item_associations"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
If given, only return app items for this application type.
\n","type":"text/plain"},"key":"application_type","value":"hubs"}],"variable":[{"id":"a0ec4bbf-b3a0-4d6f-8371-1ed15623e781","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
This is a beta feature, which means that its availability might be limited.
\nhttps://developer.box.com/reference/get-folders-id-app-item-associations
\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id","app_item_associations"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
If given, returns only app items for this application type.
\n","type":"text/plain"},"key":"application_type","value":"hubs"}],"variable":[{"id":"853ffc91-d957-4b66-8516-8bc1d5989361","description":{"content":"The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder of a Box account is\nalways represented by the ID 0.
Version header.
\n"}],"url":"https://api.box.com/2.0/archives","description":"Retrieves archives for an enterprise.
\nhttps://developer.box.com/reference/get-archives-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","archives"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\n","type":"text/plain"},"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"}],"variable":[]}},"response":[{"id":"4864121f-262f-4427-a8ad-1faafe75e0de","name":"[200] Returns a list of archives in the enterprise.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/archives","protocol":"https","host":["api.box.com"],"path":["2.0","archives"],"query":[{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true}]},"description":"Retrieves archives for an enterprise.\n\nhttps://developer.box.com/reference/get-archives-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"id\": \"12345\",\n \"type\": \"archive\",\n \"name\": \"Archive\",\n \"size\": 123456789,\n \"description\": \"This is an archive for important documents.\",\n \"owned_by\": {\n \"id\": \"12345\",\n \"type\": \"user\"\n }\n }\n ],\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\"\n}"},{"id":"24908eaa-4dab-480b-811a-8b376639f063","name":"[400] Returned when some of the parameters are missing or not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/archives","protocol":"https","host":["api.box.com"],"path":["2.0","archives"],"query":[{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true}]},"description":"Retrieves archives for an enterprise.\n\nhttps://developer.box.com/reference/get-archives-v2025.0"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"2d02aa73-cc69-49c5-953a-202f74e017fe","name":"[401] Returned when the access token provided in the `Authorization` header","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/archives","protocol":"https","host":["api.box.com"],"path":["2.0","archives"],"query":[{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true}]},"description":"Retrieves archives for an enterprise.\n\nhttps://developer.box.com/reference/get-archives-v2025.0"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"c2154018-2fc5-4828-81bf-760f3eadb5ce","name":"[403] Returned when the authenticated user does not have the right","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/archives","protocol":"https","host":["api.box.com"],"path":["2.0","archives"],"query":[{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true}]},"description":"Retrieves archives for an enterprise.\n\nhttps://developer.box.com/reference/get-archives-v2025.0"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"4fa53983-cffb-43be-afbb-3de1246d4195","name":"[500] Returned when an unexpected server error occurs.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/archives","protocol":"https","host":["api.box.com"],"path":["2.0","archives"],"query":[{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true}]},"description":"Retrieves archives for an enterprise.\n\nhttps://developer.box.com/reference/get-archives-v2025.0"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"f214c727-30ee-4ac6-b042-194b0927ab55"},{"name":"Create archive","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"0402ebcb-5524-42bb-9436-5ca278700a53","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Some Archive\",\n \"description\": \"This is an archive for important documents.\",\n \"storage_policy_id\": \"100001\"\n}"},"url":"https://api.box.com/2.0/archives","description":"Creates an archive.
\nhttps://developer.box.com/reference/post-archives-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","archives"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"ca65090d-f658-4908-8248-804df9a11d4b","name":"[201] Returns a new archive object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Some Archive\",\n \"description\": \"This is an archive for important documents.\",\n \"storage_policy_id\": \"100001\"\n}"},"url":"https://api.box.com/2.0/archives","description":"Creates an archive.\n\nhttps://developer.box.com/reference/post-archives-v2025.0"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"type\": \"archive\",\n \"name\": \"Archive\",\n \"size\": 123456789,\n \"description\": \"This is an archive for important documents.\",\n \"owned_by\": {\n \"id\": \"12345\",\n \"type\": \"user\"\n }\n}"},{"id":"920cc316-be10-4547-b98e-a36f9950c9eb","name":"[400] Returned when some of the parameters are missing or not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Some Archive\",\n \"description\": \"This is an archive for important documents.\",\n \"storage_policy_id\": \"100001\"\n}"},"url":"https://api.box.com/2.0/archives","description":"Creates an archive.\n\nhttps://developer.box.com/reference/post-archives-v2025.0"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"cd0a16a4-d887-412e-982b-f38f521a8a49","name":"[401] Returned when the access token provided in the `Authorization` header","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Some Archive\",\n \"description\": \"This is an archive for important documents.\",\n \"storage_policy_id\": \"100001\"\n}"},"url":"https://api.box.com/2.0/archives","description":"Creates an archive.\n\nhttps://developer.box.com/reference/post-archives-v2025.0"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"ed2b4790-ba7d-430c-8d70-e2fdecc9a71f","name":"[403] Returned when the authenticated user does not have the right","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Some Archive\",\n \"description\": \"This is an archive for important documents.\",\n \"storage_policy_id\": \"100001\"\n}"},"url":"https://api.box.com/2.0/archives","description":"Creates an archive.\n\nhttps://developer.box.com/reference/post-archives-v2025.0"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"022f30b2-8369-42c0-b768-1b98952d1b65","name":"[409] Returned when an archive with the given name already exists.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Some Archive\",\n \"description\": \"This is an archive for important documents.\",\n \"storage_policy_id\": \"100001\"\n}"},"url":"https://api.box.com/2.0/archives","description":"Creates an archive.\n\nhttps://developer.box.com/reference/post-archives-v2025.0"},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"a199de49-47ba-40b8-8c3e-82b4b53daeba","name":"[500] Returned when an unexpected server error occurs.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Some Archive\",\n \"description\": \"This is an archive for important documents.\",\n \"storage_policy_id\": \"100001\"\n}"},"url":"https://api.box.com/2.0/archives","description":"Creates an archive.\n\nhttps://developer.box.com/reference/post-archives-v2025.0"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"0402ebcb-5524-42bb-9436-5ca278700a53"},{"name":"Update archive","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"fd8057da-217d-43f1-a563-38e8d4277c2d","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Some Archive\",\n \"description\": \"This is an archive for important documents.\"\n}"},"url":"https://api.box.com/2.0/archives/:archive_id","description":"Updates an archive.
\nhttps://developer.box.com/reference/put-archives-id-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","archives",":archive_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"55ac8b82-5201-4665-a60e-fbf6cfb57310","description":{"content":"The ID of the archive.
\n","type":"text/plain"},"type":"any","value":"982312","key":"archive_id"}]}},"response":[{"id":"b81cc650-8214-45ac-84c5-4f9294ded90d","name":"[200] Returns the updated archive object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Some Archive\",\n \"description\": \"This is an archive for important documents.\"\n}"},"url":{"raw":"https://api.box.com/2.0/archives/:archive_id","protocol":"https","host":["api.box.com"],"path":["2.0","archives",":archive_id"],"variable":[{"id":"55ac8b82-5201-4665-a60e-fbf6cfb57310","key":"archive_id","value":"982312","description":"The ID of the archive."}]},"description":"Updates an archive.\n\nhttps://developer.box.com/reference/put-archives-id-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"type\": \"archive\",\n \"name\": \"Archive\",\n \"size\": 123456789,\n \"description\": \"This is an archive for important documents.\",\n \"owned_by\": {\n \"id\": \"12345\",\n \"type\": \"user\"\n }\n}"},{"id":"0c6d51dc-5ece-4749-a392-9bea00cb1acc","name":"[400] Returned when some of the parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Some Archive\",\n \"description\": \"This is an archive for important documents.\"\n}"},"url":{"raw":"https://api.box.com/2.0/archives/:archive_id","protocol":"https","host":["api.box.com"],"path":["2.0","archives",":archive_id"],"variable":[{"id":"55ac8b82-5201-4665-a60e-fbf6cfb57310","key":"archive_id","value":"982312","description":"The ID of the archive."}]},"description":"Updates an archive.\n\nhttps://developer.box.com/reference/put-archives-id-v2025.0"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"c56c0554-caca-4180-ae03-3e5dc2be472f","name":"[401] Returned when the access token provided in the `Authorization` header","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Some Archive\",\n \"description\": \"This is an archive for important documents.\"\n}"},"url":{"raw":"https://api.box.com/2.0/archives/:archive_id","protocol":"https","host":["api.box.com"],"path":["2.0","archives",":archive_id"],"variable":[{"id":"55ac8b82-5201-4665-a60e-fbf6cfb57310","key":"archive_id","value":"982312","description":"The ID of the archive."}]},"description":"Updates an archive.\n\nhttps://developer.box.com/reference/put-archives-id-v2025.0"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"a976a09e-7f89-4e76-80ba-11693f153b3e","name":"[403] Returned when the authenticated user does not have the right","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Some Archive\",\n \"description\": \"This is an archive for important documents.\"\n}"},"url":{"raw":"https://api.box.com/2.0/archives/:archive_id","protocol":"https","host":["api.box.com"],"path":["2.0","archives",":archive_id"],"variable":[{"id":"55ac8b82-5201-4665-a60e-fbf6cfb57310","key":"archive_id","value":"982312","description":"The ID of the archive."}]},"description":"Updates an archive.\n\nhttps://developer.box.com/reference/put-archives-id-v2025.0"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"25ed5c93-2d4a-4628-bebc-7fa5a9d55e10","name":"[404] Returned when the archive is not found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Some Archive\",\n \"description\": \"This is an archive for important documents.\"\n}"},"url":{"raw":"https://api.box.com/2.0/archives/:archive_id","protocol":"https","host":["api.box.com"],"path":["2.0","archives",":archive_id"],"variable":[{"id":"55ac8b82-5201-4665-a60e-fbf6cfb57310","key":"archive_id","value":"982312","description":"The ID of the archive."}]},"description":"Updates an archive.\n\nhttps://developer.box.com/reference/put-archives-id-v2025.0"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"d0a929df-df31-47e6-b8d1-a0e564282756","name":"[409] Returned when an archive with the given name already exists.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Some Archive\",\n \"description\": \"This is an archive for important documents.\"\n}"},"url":{"raw":"https://api.box.com/2.0/archives/:archive_id","protocol":"https","host":["api.box.com"],"path":["2.0","archives",":archive_id"],"variable":[{"id":"55ac8b82-5201-4665-a60e-fbf6cfb57310","key":"archive_id","value":"982312","description":"The ID of the archive."}]},"description":"Updates an archive.\n\nhttps://developer.box.com/reference/put-archives-id-v2025.0"},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"e8ad3de7-fc25-48bf-b117-9974705b430a","name":"[500] Returned when an unexpected server error occurs.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Some Archive\",\n \"description\": \"This is an archive for important documents.\"\n}"},"url":{"raw":"https://api.box.com/2.0/archives/:archive_id","protocol":"https","host":["api.box.com"],"path":["2.0","archives",":archive_id"],"variable":[{"id":"55ac8b82-5201-4665-a60e-fbf6cfb57310","key":"archive_id","value":"982312","description":"The ID of the archive."}]},"description":"Updates an archive.\n\nhttps://developer.box.com/reference/put-archives-id-v2025.0"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"fd8057da-217d-43f1-a563-38e8d4277c2d"},{"name":"Delete archive","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"38ea5bf7-34eb-4e23-b992-7fee701db12a","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/archives/:archive_id","description":"Permanently deletes an archive.
\nhttps://developer.box.com/reference/delete-archives-id-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","archives",":archive_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"51844989-14f0-4708-90ac-a0d47c1c3870","description":{"content":"The ID of the archive.
\n","type":"text/plain"},"type":"any","value":"982312","key":"archive_id"}]}},"response":[{"id":"6da9af86-82b6-4535-a5d3-2d2ce462520b","name":"[204] Returns an empty response when the archive has been deleted.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/archives/:archive_id","protocol":"https","host":["api.box.com"],"path":["2.0","archives",":archive_id"],"variable":[{"id":"51844989-14f0-4708-90ac-a0d47c1c3870","key":"archive_id","value":"982312","description":"The ID of the archive."}]},"description":"Permanently deletes an archive.\n\nhttps://developer.box.com/reference/delete-archives-id-v2025.0"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"7e60f230-753a-4870-985b-7b22bbaa15be","name":"[400] Returns an error if the archive is not empty.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/archives/:archive_id","protocol":"https","host":["api.box.com"],"path":["2.0","archives",":archive_id"],"variable":[{"id":"51844989-14f0-4708-90ac-a0d47c1c3870","key":"archive_id","value":"982312","description":"The ID of the archive."}]},"description":"Permanently deletes an archive.\n\nhttps://developer.box.com/reference/delete-archives-id-v2025.0"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"96590c12-42b9-4719-99f0-1495578d5c66","name":"[401] Returned when the access token provided in the `Authorization` header","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/archives/:archive_id","protocol":"https","host":["api.box.com"],"path":["2.0","archives",":archive_id"],"variable":[{"id":"51844989-14f0-4708-90ac-a0d47c1c3870","key":"archive_id","value":"982312","description":"The ID of the archive."}]},"description":"Permanently deletes an archive.\n\nhttps://developer.box.com/reference/delete-archives-id-v2025.0"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"d1648825-6274-49d8-bd8c-94d21eb1626c","name":"[403] Returns an error if the user does not have the right","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/archives/:archive_id","protocol":"https","host":["api.box.com"],"path":["2.0","archives",":archive_id"],"variable":[{"id":"51844989-14f0-4708-90ac-a0d47c1c3870","key":"archive_id","value":"982312","description":"The ID of the archive."}]},"description":"Permanently deletes an archive.\n\nhttps://developer.box.com/reference/delete-archives-id-v2025.0"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"e3ea017c-e41a-46de-b65f-d70ee8a3b703","name":"[404] Returns an error if the archive is not found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/archives/:archive_id","protocol":"https","host":["api.box.com"],"path":["2.0","archives",":archive_id"],"variable":[{"id":"51844989-14f0-4708-90ac-a0d47c1c3870","key":"archive_id","value":"982312","description":"The ID of the archive."}]},"description":"Permanently deletes an archive.\n\nhttps://developer.box.com/reference/delete-archives-id-v2025.0"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"f02d4ed7-aada-492d-9cb3-94ec61431635","name":"[500] An unexpected server error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/archives/:archive_id","protocol":"https","host":["api.box.com"],"path":["2.0","archives",":archive_id"],"variable":[{"id":"51844989-14f0-4708-90ac-a0d47c1c3870","key":"archive_id","value":"982312","description":"The ID of the archive."}]},"description":"Permanently deletes an archive.\n\nhttps://developer.box.com/reference/delete-archives-id-v2025.0"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"38ea5bf7-34eb-4e23-b992-7fee701db12a"}],"id":"2808791e-38e5-4d7b-b14e-9da10da8359e","_postman_id":"2808791e-38e5-4d7b-b14e-9da10da8359e","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/docgen_jobs/:job_id","description":"Get details of the Box Doc Gen job.
\nhttps://developer.box.com/reference/get-docgen-jobs-id-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","docgen_jobs",":job_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"6a0964d3-866d-4503-b97c-0cd1b91f73ac","description":{"content":"Box Doc Gen job ID.
\n","type":"text/plain"},"type":"any","value":"123","key":"job_id"}]}},"response":[{"id":"be75e7ae-a258-43c2-a045-4ab9f68d2669","name":"[200] Details of the Box Doc Gen job.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_jobs/:job_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_jobs",":job_id"],"variable":[{"id":"6a0964d3-866d-4503-b97c-0cd1b91f73ac","key":"job_id","value":"123","description":"Box Doc Gen job ID."}]},"description":"Get details of the Box Doc Gen job.\n\nhttps://developer.box.com/reference/get-docgen-jobs-id-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"type\": \"docgen_job\",\n \"batch\": {\n \"id\": \"12345\",\n \"type\": \"docgen_batch\"\n },\n \"template_file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n },\n \"template_file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\"\n },\n \"output_file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n },\n \"output_file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\"\n },\n \"status\": \"completed\",\n \"output_type\": \"docx\"\n}"},{"id":"dd205824-9d48-43db-bcb3-a0e227100a09","name":"[403] The client does not have access rights to the content or resource requested.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_jobs/:job_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_jobs",":job_id"],"variable":[{"id":"6a0964d3-866d-4503-b97c-0cd1b91f73ac","key":"job_id","value":"123","description":"Box Doc Gen job ID."}]},"description":"Get details of the Box Doc Gen job.\n\nhttps://developer.box.com/reference/get-docgen-jobs-id-v2025.0"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"5076fbc0-70d2-4fb5-ba90-bd632ef44db3","name":"[404] Returned if the job is not found or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_jobs/:job_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_jobs",":job_id"],"variable":[{"id":"6a0964d3-866d-4503-b97c-0cd1b91f73ac","key":"job_id","value":"123","description":"Box Doc Gen job ID."}]},"description":"Get details of the Box Doc Gen job.\n\nhttps://developer.box.com/reference/get-docgen-jobs-id-v2025.0"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"e6aa0de8-36f8-461a-89bc-c1c38a7fa701","name":"[429] The user has sent too many requests in a given amount of time.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_jobs/:job_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_jobs",":job_id"],"variable":[{"id":"6a0964d3-866d-4503-b97c-0cd1b91f73ac","key":"job_id","value":"123","description":"Box Doc Gen job ID."}]},"description":"Get details of the Box Doc Gen job.\n\nhttps://developer.box.com/reference/get-docgen-jobs-id-v2025.0"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"0618a3a6-3e17-411e-b9da-a7a9ed92b331"},{"name":"List all Box Doc Gen jobs","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"1df73e05-574e-4bae-aa5f-145afca6952d","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/docgen_jobs","description":"Lists all Box Doc Gen jobs for a user.
\nhttps://developer.box.com/reference/get-docgen-jobs-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","docgen_jobs"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"224461fd-9181-4a33-9390-58974adddd34","name":"[200] A list of Box Doc Gen jobs.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_jobs","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_jobs"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Lists all Box Doc Gen jobs for a user.\n\nhttps://developer.box.com/reference/get-docgen-jobs-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"12345\",\n \"type\": \"docgen_job\",\n \"batch\": {\n \"id\": \"12345\",\n \"type\": \"docgen_batch\"\n },\n \"template_file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n },\n \"template_file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\"\n },\n \"output_file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n },\n \"output_file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\"\n },\n \"status\": \"completed\",\n \"output_type\": \"docx\",\n \"created_at\": \"2022-05-11T10:56:11-07:00\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"enterprise\": {\n \"id\": \"1910967\",\n \"type\": \"enterprise\"\n },\n \"source\": \"api\"\n }\n ]\n}"},{"id":"4a6b2b31-2898-48b7-8dd6-5dcded2f48a6","name":"[400] Returned if the user has passed in a malformed marker or limit value.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_jobs","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_jobs"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Lists all Box Doc Gen jobs for a user.\n\nhttps://developer.box.com/reference/get-docgen-jobs-v2025.0"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"0e773611-1418-4850-ac4a-6a22ca504c30","name":"[403] The client does not have access rights to the content or resource requested.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_jobs","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_jobs"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Lists all Box Doc Gen jobs for a user.\n\nhttps://developer.box.com/reference/get-docgen-jobs-v2025.0"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"2f6be438-866b-4f71-b139-dae0b9b6104c","name":"[429] The user has sent too many requests in a given amount of time.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_jobs","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_jobs"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Lists all Box Doc Gen jobs for a user.\n\nhttps://developer.box.com/reference/get-docgen-jobs-v2025.0"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"1df73e05-574e-4bae-aa5f-145afca6952d"},{"name":"Get Box Doc Gen jobs by batch ID","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"35933689-3c6c-4078-9e23-94fea020cd47","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/docgen_batch_jobs/:batch_id","description":"Lists Box Doc Gen jobs in a batch.
\nhttps://developer.box.com/reference/get-docgen-batch-jobs-id-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","docgen_batch_jobs",":batch_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[{"id":"419d45a2-d7f0-452f-a9d2-82904aab9898","description":{"content":"Box Doc Gen batch ID.
\n","type":"text/plain"},"type":"any","value":"123","key":"batch_id"}]}},"response":[{"id":"69477f54-95d1-4561-95e8-0de0c651e028","name":"[200] Returns a list of Box Doc Gen jobs in a Box Doc Gen batch.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_batch_jobs/:batch_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_batch_jobs",":batch_id"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"419d45a2-d7f0-452f-a9d2-82904aab9898","key":"batch_id","value":"123","description":"Box Doc Gen batch ID."}]},"description":"Lists Box Doc Gen jobs in a batch.\n\nhttps://developer.box.com/reference/get-docgen-batch-jobs-id-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"12345\",\n \"type\": \"docgen_job\",\n \"batch\": {\n \"id\": \"12345\",\n \"type\": \"docgen_batch\"\n },\n \"template_file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n },\n \"template_file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\"\n },\n \"output_file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n },\n \"output_file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\"\n },\n \"status\": \"completed\",\n \"output_type\": \"docx\"\n }\n ]\n}"},{"id":"11d0fbf2-2c98-457a-b5ba-cde738faceb5","name":"[400] Returned if the user has passed in a malformed marker or limit value.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_batch_jobs/:batch_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_batch_jobs",":batch_id"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"419d45a2-d7f0-452f-a9d2-82904aab9898","key":"batch_id","value":"123","description":"Box Doc Gen batch ID."}]},"description":"Lists Box Doc Gen jobs in a batch.\n\nhttps://developer.box.com/reference/get-docgen-batch-jobs-id-v2025.0"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"760a518e-4f6e-4e98-ad3f-0d2800ef8216","name":"[403] The client does not have access rights to the content or resource requested.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_batch_jobs/:batch_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_batch_jobs",":batch_id"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"419d45a2-d7f0-452f-a9d2-82904aab9898","key":"batch_id","value":"123","description":"Box Doc Gen batch ID."}]},"description":"Lists Box Doc Gen jobs in a batch.\n\nhttps://developer.box.com/reference/get-docgen-batch-jobs-id-v2025.0"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"f2943dc2-dbbc-4601-aa97-6f087668e63b","name":"[404] Returned if the batch is not found or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_batch_jobs/:batch_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_batch_jobs",":batch_id"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"419d45a2-d7f0-452f-a9d2-82904aab9898","key":"batch_id","value":"123","description":"Box Doc Gen batch ID."}]},"description":"Lists Box Doc Gen jobs in a batch.\n\nhttps://developer.box.com/reference/get-docgen-batch-jobs-id-v2025.0"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"5d363d38-c445-40c4-b8a1-dff203ec5324","name":"[429] The user has sent too many requests in a given amount of time.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_batch_jobs/:batch_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_batch_jobs",":batch_id"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"419d45a2-d7f0-452f-a9d2-82904aab9898","key":"batch_id","value":"123","description":"Box Doc Gen batch ID."}]},"description":"Lists Box Doc Gen jobs in a batch.\n\nhttps://developer.box.com/reference/get-docgen-batch-jobs-id-v2025.0"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"35933689-3c6c-4078-9e23-94fea020cd47"},{"name":"Generate document using Box Doc Gen template","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"aeab91ee-dc4c-42a3-ba1b-13e9ad056d16","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n },\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\"\n },\n \"input_source\": \"api\",\n \"destination_folder\": {\n \"type\": \"folder\",\n \"id\": \"42037322\"\n },\n \"output_type\": \"docx\",\n \"document_generation_data\": [\n {\n \"generated_file_name\": \"New_Template\",\n \"user_input\": {\n \"name\": \"Aaron Levie\"\n }\n }\n ]\n}"},"url":"https://api.box.com/2.0/docgen_batches","description":"Generates a document using a Box Doc Gen template.
\nhttps://developer.box.com/reference/post-docgen-batches-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","docgen_batches"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"62c36e23-cdea-442f-beac-18c22a7a39e4","name":"[202] The created Batch ID.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n },\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\"\n },\n \"input_source\": \"api\",\n \"destination_folder\": {\n \"type\": \"folder\",\n \"id\": \"42037322\"\n },\n \"output_type\": \"docx\",\n \"document_generation_data\": [\n {\n \"generated_file_name\": \"New_Template\",\n \"user_input\": {\n \"name\": \"Aaron Levie\"\n }\n }\n ]\n}"},"url":"https://api.box.com/2.0/docgen_batches","description":"Generates a document using a Box Doc Gen template.\n\nhttps://developer.box.com/reference/post-docgen-batches-v2025.0"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"type\": \"docgen_batch\"\n}"},{"id":"4bbc1464-f2c2-4dbb-ada2-63fb5fe83471","name":"[403] The client does not have access rights to the content or resource requested.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n },\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\"\n },\n \"input_source\": \"api\",\n \"destination_folder\": {\n \"type\": \"folder\",\n \"id\": \"42037322\"\n },\n \"output_type\": \"docx\",\n \"document_generation_data\": [\n {\n \"generated_file_name\": \"New_Template\",\n \"user_input\": {\n \"name\": \"Aaron Levie\"\n }\n }\n ]\n}"},"url":"https://api.box.com/2.0/docgen_batches","description":"Generates a document using a Box Doc Gen template.\n\nhttps://developer.box.com/reference/post-docgen-batches-v2025.0"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"15ec6189-27e9-48c2-baef-a1bf1488837f","name":"[429] The user has sent too many requests in a given amount of time.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n },\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\"\n },\n \"input_source\": \"api\",\n \"destination_folder\": {\n \"type\": \"folder\",\n \"id\": \"42037322\"\n },\n \"output_type\": \"docx\",\n \"document_generation_data\": [\n {\n \"generated_file_name\": \"New_Template\",\n \"user_input\": {\n \"name\": \"Aaron Levie\"\n }\n }\n ]\n}"},"url":"https://api.box.com/2.0/docgen_batches","description":"Generates a document using a Box Doc Gen template.\n\nhttps://developer.box.com/reference/post-docgen-batches-v2025.0"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"aeab91ee-dc4c-42a3-ba1b-13e9ad056d16"}],"id":"f16bf105-d121-4c9a-b0c3-eea78fa45373","_postman_id":"f16bf105-d121-4c9a-b0c3-eea78fa45373","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/docgen_templates","description":"Lists Box Doc Gen templates on which the user is a collaborator.
\nhttps://developer.box.com/reference/get-docgen-templates-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","docgen_templates"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"ab8c2a2d-b0fc-4bc2-a60f-cc8edf5d4b33","name":"[200] Returns a collection of templates.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Lists Box Doc Gen templates on which the user is a collaborator.\n\nhttps://developer.box.com/reference/get-docgen-templates-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n },\n \"file_name\": \"Official contract\"\n }\n ]\n}"},{"id":"24e8ba6b-5d3d-4a7f-8130-cb3c7657c401","name":"[400] Returned if the user has passed in a malformed marker or limit value.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Lists Box Doc Gen templates on which the user is a collaborator.\n\nhttps://developer.box.com/reference/get-docgen-templates-v2025.0"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"f068c6ef-4a49-47f9-928b-ca2345e38bf7","name":"[401] Returned when the access token provided in the `Authorization` header","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Lists Box Doc Gen templates on which the user is a collaborator.\n\nhttps://developer.box.com/reference/get-docgen-templates-v2025.0"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"3046c8e7-4d73-4d3d-929e-c3ae76d9dc52"},{"name":"Get Box Doc Gen template by ID","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"9eb7b280-deeb-478a-af83-b07ce2495232","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/docgen_templates/:template_id","description":"Lists details of a specific Box Doc Gen template.
\nhttps://developer.box.com/reference/get-docgen-templates-id-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","docgen_templates",":template_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"49648d09-a3f4-44c6-938c-a88b2156f0e9","description":{"content":"The ID of a Box Doc Gen template.
\n","type":"text/plain"},"type":"any","value":"123","key":"template_id"}]}},"response":[{"id":"a56d3af7-41eb-46cf-bb1f-9586e6f3fd8c","name":"[200] Returns a template.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates",":template_id"],"variable":[{"id":"49648d09-a3f4-44c6-938c-a88b2156f0e9","key":"template_id","value":"123","description":"The ID of a Box Doc Gen template."}]},"description":"Lists details of a specific Box Doc Gen template.\n\nhttps://developer.box.com/reference/get-docgen-templates-id-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n },\n \"file_name\": \"Official contract\"\n}"},{"id":"9705ae27-4221-4019-86b0-cd429cc90b7d","name":"[401] Returned when the access token provided in the `Authorization` header","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates",":template_id"],"variable":[{"id":"49648d09-a3f4-44c6-938c-a88b2156f0e9","key":"template_id","value":"123","description":"The ID of a Box Doc Gen template."}]},"description":"Lists details of a specific Box Doc Gen template.\n\nhttps://developer.box.com/reference/get-docgen-templates-id-v2025.0"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"19fff858-b585-41a8-b96b-48d95a35e9a3","name":"[404] Returned if the template is not found or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates",":template_id"],"variable":[{"id":"49648d09-a3f4-44c6-938c-a88b2156f0e9","key":"template_id","value":"123","description":"The ID of a Box Doc Gen template."}]},"description":"Lists details of a specific Box Doc Gen template.\n\nhttps://developer.box.com/reference/get-docgen-templates-id-v2025.0"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"9eb7b280-deeb-478a-af83-b07ce2495232"},{"name":"List all Box Doc Gen template tags in template","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"cdea8055-ff39-4822-92cd-876c6696cd67","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/docgen_templates/:template_id/tags","description":"Lists all tags in a Box Doc Gen template.
\nhttps://developer.box.com/reference/get-docgen-templates-id-tags-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","docgen_templates",":template_id","tags"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Id of template version.
\n","type":"text/plain"},"key":"template_version_id","value":"123"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[{"id":"b7aa6fad-abd5-4ec3-9cf5-3d98d15b72db","description":{"content":"ID of template.
\n","type":"text/plain"},"type":"any","value":"123","key":"template_id"}]}},"response":[{"id":"c139150a-a72e-4766-9def-3f48e81a13a8","name":"[200] A list of document generation template tags.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates/:template_id/tags","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates",":template_id","tags"],"query":[{"key":"template_version_id","value":"123","description":"Id of template version.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"b7aa6fad-abd5-4ec3-9cf5-3d98d15b72db","key":"template_id","value":"123","description":"ID of template."}]},"description":"Lists all tags in a Box Doc Gen template.\n\nhttps://developer.box.com/reference/get-docgen-templates-id-tags-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"tag_content\": \"{{item.name}}\",\n \"tag_type\": \"text\",\n \"json_paths\": [\n \"products\",\n \"products.name\"\n ]\n }\n ]\n}"},{"id":"ca703ec6-d7ce-43f2-85ae-2577be0b2add","name":"[202] Processing tags for the file.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates/:template_id/tags","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates",":template_id","tags"],"query":[{"key":"template_version_id","value":"123","description":"Id of template version.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"b7aa6fad-abd5-4ec3-9cf5-3d98d15b72db","key":"template_id","value":"123","description":"ID of template."}]},"description":"Lists all tags in a Box Doc Gen template.\n\nhttps://developer.box.com/reference/get-docgen-templates-id-tags-v2025.0"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Processing tags for this file.\"\n}"},{"id":"f330bfd6-fc94-4019-ae65-552b9b3b97e2","name":"[400] Returned if the user has passed in a malformed marker or limit value.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates/:template_id/tags","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates",":template_id","tags"],"query":[{"key":"template_version_id","value":"123","description":"Id of template version.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"b7aa6fad-abd5-4ec3-9cf5-3d98d15b72db","key":"template_id","value":"123","description":"ID of template."}]},"description":"Lists all tags in a Box Doc Gen template.\n\nhttps://developer.box.com/reference/get-docgen-templates-id-tags-v2025.0"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"bde9a913-5083-4c5a-918e-79e72b545f6f","name":"[403] The client does not have access rights to the content or resource requested.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates/:template_id/tags","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates",":template_id","tags"],"query":[{"key":"template_version_id","value":"123","description":"Id of template version.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"b7aa6fad-abd5-4ec3-9cf5-3d98d15b72db","key":"template_id","value":"123","description":"ID of template."}]},"description":"Lists all tags in a Box Doc Gen template.\n\nhttps://developer.box.com/reference/get-docgen-templates-id-tags-v2025.0"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"4358e7e1-3ea9-4829-bae9-a490d885efbd","name":"[404] The requested resource could not be found but may be available in the future.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates/:template_id/tags","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates",":template_id","tags"],"query":[{"key":"template_version_id","value":"123","description":"Id of template version.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"b7aa6fad-abd5-4ec3-9cf5-3d98d15b72db","key":"template_id","value":"123","description":"ID of template."}]},"description":"Lists all tags in a Box Doc Gen template.\n\nhttps://developer.box.com/reference/get-docgen-templates-id-tags-v2025.0"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"d7c0ce79-85e1-4bf8-93e6-7e423c80d65a","name":"[429] The user has sent too many requests in a given amount of time.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates/:template_id/tags","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates",":template_id","tags"],"query":[{"key":"template_version_id","value":"123","description":"Id of template version.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"b7aa6fad-abd5-4ec3-9cf5-3d98d15b72db","key":"template_id","value":"123","description":"ID of template."}]},"description":"Lists all tags in a Box Doc Gen template.\n\nhttps://developer.box.com/reference/get-docgen-templates-id-tags-v2025.0"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"cdea8055-ff39-4822-92cd-876c6696cd67"},{"name":"Get list of all Box Doc Gen jobs for template","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"9d246ea7-41b4-42dc-9491-fc518d2cef83","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/docgen_template_jobs/:template_id","description":"Lists the users jobs which use this template.
\nhttps://developer.box.com/reference/get-docgen-template-jobs-id-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","docgen_template_jobs",":template_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[{"id":"368c4473-282e-4cfd-88cd-2899bf193798","description":{"content":"Id of template to fetch jobs for.
\n","type":"text/plain"},"type":"any","value":"123","key":"template_id"}]}},"response":[{"id":"fb11009c-8871-4cf2-a60e-f66b47f58884","name":"[200] A single Box Doc Gen template.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_template_jobs/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_template_jobs",":template_id"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"368c4473-282e-4cfd-88cd-2899bf193798","key":"template_id","value":"123","description":"Id of template to fetch jobs for."}]},"description":"Lists the users jobs which use this template.\n\nhttps://developer.box.com/reference/get-docgen-template-jobs-id-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"12345\",\n \"type\": \"docgen_job\",\n \"batch\": {\n \"id\": \"12345\",\n \"type\": \"docgen_batch\"\n },\n \"template_file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n },\n \"template_file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\"\n },\n \"output_file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n },\n \"output_file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\"\n },\n \"status\": \"completed\",\n \"output_type\": \"docx\"\n }\n ]\n}"},{"id":"51e62fff-de09-48c7-bc3f-a0550897ad07","name":"[400] Returned if the user has passed in a malformed marker or limit value.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_template_jobs/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_template_jobs",":template_id"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"368c4473-282e-4cfd-88cd-2899bf193798","key":"template_id","value":"123","description":"Id of template to fetch jobs for."}]},"description":"Lists the users jobs which use this template.\n\nhttps://developer.box.com/reference/get-docgen-template-jobs-id-v2025.0"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"e41fe7aa-8853-4b30-a265-6fe59ba867ac","name":"[403] The client does not have access rights to the content or resource requested.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_template_jobs/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_template_jobs",":template_id"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"368c4473-282e-4cfd-88cd-2899bf193798","key":"template_id","value":"123","description":"Id of template to fetch jobs for."}]},"description":"Lists the users jobs which use this template.\n\nhttps://developer.box.com/reference/get-docgen-template-jobs-id-v2025.0"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"9dc5e808-61bb-4f84-b7f8-aa9e0272a25d","name":"[404] Returned if the template is not found or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_template_jobs/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_template_jobs",":template_id"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"368c4473-282e-4cfd-88cd-2899bf193798","key":"template_id","value":"123","description":"Id of template to fetch jobs for."}]},"description":"Lists the users jobs which use this template.\n\nhttps://developer.box.com/reference/get-docgen-template-jobs-id-v2025.0"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"ee796d28-79dc-4012-b6a0-2a7851a3e8ad","name":"[429] The user has sent too many requests in a given amount of time.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_template_jobs/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_template_jobs",":template_id"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"368c4473-282e-4cfd-88cd-2899bf193798","key":"template_id","value":"123","description":"Id of template to fetch jobs for."}]},"description":"Lists the users jobs which use this template.\n\nhttps://developer.box.com/reference/get-docgen-template-jobs-id-v2025.0"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"9d246ea7-41b4-42dc-9491-fc518d2cef83"},{"name":"Create Box Doc Gen template","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"8a824d17-685a-4580-92d6-c9016754892d","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n }\n}"},"url":"https://api.box.com/2.0/docgen_templates","description":"Marks a file as a Box Doc Gen template.
\nhttps://developer.box.com/reference/post-docgen-templates-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","docgen_templates"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"be49c54c-157b-4fa6-a8bb-8a1139ebb4a7","name":"[201] The file which has now been marked as a Box Doc Gen template.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n }\n}"},"url":"https://api.box.com/2.0/docgen_templates","description":"Marks a file as a Box Doc Gen template.\n\nhttps://developer.box.com/reference/post-docgen-templates-v2025.0"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n }\n}"},{"id":"6cd74e05-d22b-4f6c-a280-170de843c598","name":"[400] The server cannot or will not process the request due to an apparent client error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n }\n}"},"url":"https://api.box.com/2.0/docgen_templates","description":"Marks a file as a Box Doc Gen template.\n\nhttps://developer.box.com/reference/post-docgen-templates-v2025.0"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"b046887d-39f3-424a-b518-c4eca045432d","name":"[403] The client does not have access rights to the content or resource requested.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n }\n}"},"url":"https://api.box.com/2.0/docgen_templates","description":"Marks a file as a Box Doc Gen template.\n\nhttps://developer.box.com/reference/post-docgen-templates-v2025.0"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"8dc8de5c-a6d6-45e2-a5b2-3f97296d12f5","name":"[429] The user has sent too many requests in a given amount of time.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"file\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n }\n}"},"url":"https://api.box.com/2.0/docgen_templates","description":"Marks a file as a Box Doc Gen template.\n\nhttps://developer.box.com/reference/post-docgen-templates-v2025.0"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"8a824d17-685a-4580-92d6-c9016754892d"},{"name":"Delete Box Doc Gen template","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"2639699d-58d1-4bac-904a-47d9ed67ef5f","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/docgen_templates/:template_id","description":"Unmarks file as Box Doc Gen template.
\nhttps://developer.box.com/reference/delete-docgen-templates-id-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","docgen_templates",":template_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"7927ef92-3009-44d9-b0af-9eb247e5c511","description":{"content":"ID of the file which will no longer be marked as a Box Doc Gen template.
\n","type":"text/plain"},"type":"any","value":"123","key":"template_id"}]}},"response":[{"id":"c1e9e8d4-e1db-4ce5-b8e2-eec889ea8dae","name":"[204] Returns an empty response when a file is no longer marked as a Box Doc Gen template.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates",":template_id"],"variable":[{"id":"7927ef92-3009-44d9-b0af-9eb247e5c511","key":"template_id","value":"123","description":"ID of the file which will no longer be marked as a Box Doc Gen template."}]},"description":"Unmarks file as Box Doc Gen template.\n\nhttps://developer.box.com/reference/delete-docgen-templates-id-v2025.0"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"9cf18d97-a88c-418e-a84c-40a41db52199","name":"[400] The server cannot or will not process the request due to an apparent client error.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates",":template_id"],"variable":[{"id":"7927ef92-3009-44d9-b0af-9eb247e5c511","key":"template_id","value":"123","description":"ID of the file which will no longer be marked as a Box Doc Gen template."}]},"description":"Unmarks file as Box Doc Gen template.\n\nhttps://developer.box.com/reference/delete-docgen-templates-id-v2025.0"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"d7853e2a-81bc-4c47-847c-9bcc698e254b","name":"[403] The client does not have access rights to the content or resource requested.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates",":template_id"],"variable":[{"id":"7927ef92-3009-44d9-b0af-9eb247e5c511","key":"template_id","value":"123","description":"ID of the file which will no longer be marked as a Box Doc Gen template."}]},"description":"Unmarks file as Box Doc Gen template.\n\nhttps://developer.box.com/reference/delete-docgen-templates-id-v2025.0"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"5018b88e-29da-4a1a-8565-facddaebbee6","name":"[404] Returned if the template is not found or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates",":template_id"],"variable":[{"id":"7927ef92-3009-44d9-b0af-9eb247e5c511","key":"template_id","value":"123","description":"ID of the file which will no longer be marked as a Box Doc Gen template."}]},"description":"Unmarks file as Box Doc Gen template.\n\nhttps://developer.box.com/reference/delete-docgen-templates-id-v2025.0"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"d42e5ab0-51c4-495b-888f-ed31f88f1d92","name":"[429] The user has sent too many requests in a given amount of time.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/docgen_templates/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","docgen_templates",":template_id"],"variable":[{"id":"7927ef92-3009-44d9-b0af-9eb247e5c511","key":"template_id","value":"123","description":"ID of the file which will no longer be marked as a Box Doc Gen template."}]},"description":"Unmarks file as Box Doc Gen template.\n\nhttps://developer.box.com/reference/delete-docgen-templates-id-v2025.0"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"2639699d-58d1-4bac-904a-47d9ed67ef5f"}],"id":"13852ca7-fc86-49b7-b330-47f6c6a5d589","_postman_id":"13852ca7-fc86-49b7-b330-47f6c6a5d589","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/hub_collaborations?hub_id=12345","description":"Retrieves all collaborations for a Box Hub.
\nhttps://developer.box.com/reference/get-hub-collaborations-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","hub_collaborations"],"host":["api.box.com"],"query":[{"description":{"content":"The unique identifier that represent a hub.
\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/hubs/123\nthe hub_id is 123.
Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"eef1d12f-b8dd-4348-8094-2f0ebdec8cf3","name":"[200] Retrieves the collaborations associated with the specified Box Hub.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_collaborations?hub_id=12345","protocol":"https","host":["api.box.com"],"path":["2.0","hub_collaborations"],"query":[{"key":"hub_id","value":"12345","description":"The unique identifier that represent a hub.\n\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/hubs/123`\nthe `hub_id` is `123`."},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves all collaborations for a Box Hub.\n\nhttps://developer.box.com/reference/get-hub-collaborations-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"id\": \"12345678\",\n \"type\": \"hub_collaboration\",\n \"hub\": {\n \"id\": \"12345\",\n \"type\": \"hubs\"\n },\n \"accessible_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"role\": \"editor\",\n \"status\": \"accepted\",\n \"acceptance_requirements_status\": {\n \"terms_of_service_requirement\": {\n \"is_accepted\": true,\n \"terms_of_service\": {\n \"id\": \"11446498\",\n \"type\": \"terms_of_service\"\n }\n },\n \"strong_password_requirement\": {\n \"enterprise_has_strong_password_required_for_external_users\": true,\n \"user_has_strong_password\": true\n },\n \"two_factor_authentication_requirement\": {\n \"enterprise_has_two_factor_auth_enabled\": true,\n \"user_has_two_factor_authentication_enabled\": true\n }\n }\n }\n ],\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\"\n}"},{"id":"62d3f813-4c60-49ab-ad8b-4365f7ef814b","name":"[401] Returned when the access token provided in the `Authorization` header","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_collaborations?hub_id=12345","protocol":"https","host":["api.box.com"],"path":["2.0","hub_collaborations"],"query":[{"key":"hub_id","value":"12345","description":"The unique identifier that represent a hub.\n\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/hubs/123`\nthe `hub_id` is `123`."},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves all collaborations for a Box Hub.\n\nhttps://developer.box.com/reference/get-hub-collaborations-v2025.0"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"038d6b87-73d7-4c91-ba36-23155c44a658","name":"[404] Returned if the Box Hub is not found, or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_collaborations?hub_id=12345","protocol":"https","host":["api.box.com"],"path":["2.0","hub_collaborations"],"query":[{"key":"hub_id","value":"12345","description":"The unique identifier that represent a hub.\n\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/hubs/123`\nthe `hub_id` is `123`."},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves all collaborations for a Box Hub.\n\nhttps://developer.box.com/reference/get-hub-collaborations-v2025.0"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"33a070c4-f28f-4bad-a19f-d510f1a306ba"},{"name":"Get Box Hub collaboration by collaboration ID","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"09369730-90d9-45d0-a845-661a733fdd44","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/hub_collaborations/:hub_collaboration_id","description":"Retrieves details for a Box Hub collaboration by collaboration ID.
\nhttps://developer.box.com/reference/get-hub-collaborations-id-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","hub_collaborations",":hub_collaboration_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"1e8b031a-2097-4152-9430-0a6fa5a5d219","description":{"content":"The ID of the hub collaboration.
\n","type":"text/plain"},"type":"any","value":"1234","key":"hub_collaboration_id"}]}},"response":[{"id":"acb1936d-dc52-493e-8ec4-f5289c70f565","name":"[200] Returns a Box Hub collaboration object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_collaborations/:hub_collaboration_id","protocol":"https","host":["api.box.com"],"path":["2.0","hub_collaborations",":hub_collaboration_id"],"variable":[{"id":"1e8b031a-2097-4152-9430-0a6fa5a5d219","key":"hub_collaboration_id","value":"1234","description":"The ID of the hub collaboration."}]},"description":"Retrieves details for a Box Hub collaboration by collaboration ID.\n\nhttps://developer.box.com/reference/get-hub-collaborations-id-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345678\",\n \"type\": \"hub_collaboration\",\n \"hub\": {\n \"id\": \"12345\",\n \"type\": \"hubs\"\n },\n \"accessible_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"role\": \"editor\",\n \"status\": \"accepted\",\n \"acceptance_requirements_status\": {\n \"terms_of_service_requirement\": {\n \"is_accepted\": true,\n \"terms_of_service\": {\n \"id\": \"11446498\",\n \"type\": \"terms_of_service\"\n }\n },\n \"strong_password_requirement\": {\n \"enterprise_has_strong_password_required_for_external_users\": true,\n \"user_has_strong_password\": true\n },\n \"two_factor_authentication_requirement\": {\n \"enterprise_has_two_factor_auth_enabled\": true,\n \"user_has_two_factor_authentication_enabled\": true\n }\n }\n}"},{"id":"d38d5e5d-9868-4b87-a437-aa9fe03517d2","name":"[401] Returned when the access token provided in the `Authorization` header","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_collaborations/:hub_collaboration_id","protocol":"https","host":["api.box.com"],"path":["2.0","hub_collaborations",":hub_collaboration_id"],"variable":[{"id":"1e8b031a-2097-4152-9430-0a6fa5a5d219","key":"hub_collaboration_id","value":"1234","description":"The ID of the hub collaboration."}]},"description":"Retrieves details for a Box Hub collaboration by collaboration ID.\n\nhttps://developer.box.com/reference/get-hub-collaborations-id-v2025.0"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"c6c47318-43a9-4e18-8731-0789a3701ee2","name":"[404] Returned if the Box Hub is not found, or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_collaborations/:hub_collaboration_id","protocol":"https","host":["api.box.com"],"path":["2.0","hub_collaborations",":hub_collaboration_id"],"variable":[{"id":"1e8b031a-2097-4152-9430-0a6fa5a5d219","key":"hub_collaboration_id","value":"1234","description":"The ID of the hub collaboration."}]},"description":"Retrieves details for a Box Hub collaboration by collaboration ID.\n\nhttps://developer.box.com/reference/get-hub-collaborations-id-v2025.0"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"09369730-90d9-45d0-a845-661a733fdd44"},{"name":"Create Box Hub collaboration","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"919ed456-8869-4396-b1d5-18d54c52d849","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"hub\": {\n \"type\": \"hubs\",\n \"id\": \"42037322\"\n },\n \"accessible_by\": {\n \"type\": \"user\",\n \"id\": \"23522323\",\n \"login\": \"john@example.com\"\n },\n \"role\": \"editor\"\n}"},"url":"https://api.box.com/2.0/hub_collaborations","description":"Adds a collaboration for a single user or a single group to a Box Hub.
\nhttps://developer.box.com/reference/post-hub-collaborations-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","hub_collaborations"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"07d3c476-3b76-4ac7-9fdd-82e57586e84a","name":"[201] Returns a new Box Hub collaboration object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"hub\": {\n \"type\": \"hubs\",\n \"id\": \"42037322\"\n },\n \"accessible_by\": {\n \"type\": \"user\",\n \"id\": \"23522323\",\n \"login\": \"john@example.com\"\n },\n \"role\": \"editor\"\n}"},"url":"https://api.box.com/2.0/hub_collaborations","description":"Adds a collaboration for a single user or a single group to a Box Hub.\n\nhttps://developer.box.com/reference/post-hub-collaborations-v2025.0"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345678\",\n \"type\": \"hub_collaboration\",\n \"hub\": {\n \"id\": \"12345\",\n \"type\": \"hubs\"\n },\n \"accessible_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"role\": \"editor\",\n \"status\": \"accepted\",\n \"acceptance_requirements_status\": {\n \"terms_of_service_requirement\": {\n \"is_accepted\": true,\n \"terms_of_service\": {\n \"id\": \"11446498\",\n \"type\": \"terms_of_service\"\n }\n },\n \"strong_password_requirement\": {\n \"enterprise_has_strong_password_required_for_external_users\": true,\n \"user_has_strong_password\": true\n },\n \"two_factor_authentication_requirement\": {\n \"enterprise_has_two_factor_auth_enabled\": true,\n \"user_has_two_factor_authentication_enabled\": true\n }\n }\n}"},{"id":"15d5e1e7-7ba1-4954-99ee-e0957dea56cd","name":"[403] Returns an error when the user does not have the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"hub\": {\n \"type\": \"hubs\",\n \"id\": \"42037322\"\n },\n \"accessible_by\": {\n \"type\": \"user\",\n \"id\": \"23522323\",\n \"login\": \"john@example.com\"\n },\n \"role\": \"editor\"\n}"},"url":"https://api.box.com/2.0/hub_collaborations","description":"Adds a collaboration for a single user or a single group to a Box Hub.\n\nhttps://developer.box.com/reference/post-hub-collaborations-v2025.0"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"919ed456-8869-4396-b1d5-18d54c52d849"},{"name":"Update Box Hub collaboration","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"a30eab0a-b949-4eed-b715-45414bcbed50","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"role\": \"editor\"\n}"},"url":"https://api.box.com/2.0/hub_collaborations/:hub_collaboration_id","description":"Updates a Box Hub collaboration.
\nhttps://developer.box.com/reference/put-hub-collaborations-id-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","hub_collaborations",":hub_collaboration_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"41f39591-b617-420a-a46b-27479e590164","description":{"content":"The ID of the hub collaboration.
\n","type":"text/plain"},"type":"any","value":"1234","key":"hub_collaboration_id"}]}},"response":[{"id":"a9d1fbcb-47df-452e-beba-0f528af16cbf","name":"[200] Returns an updated Box Hub collaboration object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"role\": \"editor\"\n}"},"url":{"raw":"https://api.box.com/2.0/hub_collaborations/:hub_collaboration_id","protocol":"https","host":["api.box.com"],"path":["2.0","hub_collaborations",":hub_collaboration_id"],"variable":[{"id":"41f39591-b617-420a-a46b-27479e590164","key":"hub_collaboration_id","value":"1234","description":"The ID of the hub collaboration."}]},"description":"Updates a Box Hub collaboration.\n\nhttps://developer.box.com/reference/put-hub-collaborations-id-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345678\",\n \"type\": \"hub_collaboration\",\n \"hub\": {\n \"id\": \"12345\",\n \"type\": \"hubs\"\n },\n \"accessible_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"role\": \"editor\",\n \"status\": \"accepted\",\n \"acceptance_requirements_status\": {\n \"terms_of_service_requirement\": {\n \"is_accepted\": true,\n \"terms_of_service\": {\n \"id\": \"11446498\",\n \"type\": \"terms_of_service\"\n }\n },\n \"strong_password_requirement\": {\n \"enterprise_has_strong_password_required_for_external_users\": true,\n \"user_has_strong_password\": true\n },\n \"two_factor_authentication_requirement\": {\n \"enterprise_has_two_factor_auth_enabled\": true,\n \"user_has_two_factor_authentication_enabled\": true\n }\n }\n}"},{"id":"aac5b0a3-8d0b-4d65-b9a1-4f7789503c4d","name":"[403] Returns an error if the authenticated user does not have the right","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"role\": \"editor\"\n}"},"url":{"raw":"https://api.box.com/2.0/hub_collaborations/:hub_collaboration_id","protocol":"https","host":["api.box.com"],"path":["2.0","hub_collaborations",":hub_collaboration_id"],"variable":[{"id":"41f39591-b617-420a-a46b-27479e590164","key":"hub_collaboration_id","value":"1234","description":"The ID of the hub collaboration."}]},"description":"Updates a Box Hub collaboration.\n\nhttps://developer.box.com/reference/put-hub-collaborations-id-v2025.0"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"a30eab0a-b949-4eed-b715-45414bcbed50"},{"name":"Remove Box Hub collaboration","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"b03a030f-b451-4553-89f6-daa21897ef2a","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/hub_collaborations/:hub_collaboration_id","description":"Deletes a single Box Hub collaboration.
\nhttps://developer.box.com/reference/delete-hub-collaborations-id-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","hub_collaborations",":hub_collaboration_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"19a71499-4dd9-4471-9439-f147c6af96ad","description":{"content":"The ID of the hub collaboration.
\n","type":"text/plain"},"type":"any","value":"1234","key":"hub_collaboration_id"}]}},"response":[{"id":"67a45839-3c84-4978-bf09-31a30ad78af5","name":"[204] A blank response is returned if the Box Hub collaboration was","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_collaborations/:hub_collaboration_id","protocol":"https","host":["api.box.com"],"path":["2.0","hub_collaborations",":hub_collaboration_id"],"variable":[{"id":"19a71499-4dd9-4471-9439-f147c6af96ad","key":"hub_collaboration_id","value":"1234","description":"The ID of the hub collaboration."}]},"description":"Deletes a single Box Hub collaboration.\n\nhttps://developer.box.com/reference/delete-hub-collaborations-id-v2025.0"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"b267d489-f7d6-49f0-a64d-7aa76456268b","name":"[404] Returns an error if the Box Hub collaboration could not be found,","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_collaborations/:hub_collaboration_id","protocol":"https","host":["api.box.com"],"path":["2.0","hub_collaborations",":hub_collaboration_id"],"variable":[{"id":"19a71499-4dd9-4471-9439-f147c6af96ad","key":"hub_collaboration_id","value":"1234","description":"The ID of the hub collaboration."}]},"description":"Deletes a single Box Hub collaboration.\n\nhttps://developer.box.com/reference/delete-hub-collaborations-id-v2025.0"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"b03a030f-b451-4553-89f6-daa21897ef2a"}],"id":"bfbdbe50-2565-4174-b0a6-4d14b19de419","_postman_id":"bfbdbe50-2565-4174-b0a6-4d14b19de419","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/hub_document_pages?hub_id=12345","description":"Retrieves a list of Hub Document Pages for the specified hub.
\nhttps://developer.box.com/reference/get-hub-document-pages-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","hub_document_pages"],"host":["api.box.com"],"query":[{"description":{"content":"The unique identifier that represent a hub.
\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/hubs/123\nthe hub_id is 123.
Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\n","type":"text/plain"},"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"5d32efd0-f1f3-430d-8b71-c7899e98a34e","name":"[200] Returns a Hub Document Pages response whose `entries` array contains root-level pages and sub pages. Includes pagination when more results are available.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_document_pages?hub_id=12345","protocol":"https","host":["api.box.com"],"path":["2.0","hub_document_pages"],"query":[{"key":"hub_id","value":"12345","description":"The unique identifier that represent a hub.\n\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/hubs/123`\nthe `hub_id` is `123`."},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves a list of Hub Document Pages for the specified hub.\n\nhttps://developer.box.com/reference/get-hub-document-pages-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"id\": \"d97f7c26-0d9b-42a1-a00d-6e6db9619e0f\",\n \"type\": \"page\",\n \"parent_id\": \"d97f7c26-0d9b-42a1-a00d-6e6db9619e0f\",\n \"title_fragment\": \"This is the home page title\"\n }\n ],\n \"type\": \"document_pages\",\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\"\n}"},{"id":"5b0f2c6a-3397-4b9c-a7b9-6c0ff0d9e76e","name":"[401] Returned when the access token provided in the Authorization header","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_document_pages?hub_id=12345","protocol":"https","host":["api.box.com"],"path":["2.0","hub_document_pages"],"query":[{"key":"hub_id","value":"12345","description":"The unique identifier that represent a hub.\n\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/hubs/123`\nthe `hub_id` is `123`."},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves a list of Hub Document Pages for the specified hub.\n\nhttps://developer.box.com/reference/get-hub-document-pages-v2025.0"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"12bedf48-2242-4bae-b84c-862959440a15","name":"[404] Returned if the Box Hub is not found, or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_document_pages?hub_id=12345","protocol":"https","host":["api.box.com"],"path":["2.0","hub_document_pages"],"query":[{"key":"hub_id","value":"12345","description":"The unique identifier that represent a hub.\n\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/hubs/123`\nthe `hub_id` is `123`."},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves a list of Hub Document Pages for the specified hub.\n\nhttps://developer.box.com/reference/get-hub-document-pages-v2025.0"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"7341d380-86ec-47ad-a9b4-4632cdaa4adc"},{"name":"List Hub Document blocks for page","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"c095cb4e-9faf-4eea-a484-29f157af55f6","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/hub_document_blocks?hub_id=12345&page_id=d97f7c26-0d9b-42a1-a00d-6e6db9619e0f","description":"Retrieves a sorted list of all Hub Document Blocks on a specified page in the hub document, excluding items.
\nhttps://developer.box.com/reference/get-hub-document-blocks-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","hub_document_blocks"],"host":["api.box.com"],"query":[{"description":{"content":"The unique identifier that represent a hub.
\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/hubs/123\nthe hub_id is 123.
The unique identifier of a page within the Box Hub.
\n","type":"text/plain"},"key":"page_id","value":"d97f7c26-0d9b-42a1-a00d-6e6db9619e0f"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\n","type":"text/plain"},"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"a72a3a17-ecb8-47b3-903c-75502fc87fce","name":"[200] Returns a Hub Document Blocks response whose `entries` array contains all content blocks of the specified page, except for items.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_document_blocks?hub_id=12345&page_id=d97f7c26-0d9b-42a1-a00d-6e6db9619e0f","protocol":"https","host":["api.box.com"],"path":["2.0","hub_document_blocks"],"query":[{"key":"hub_id","value":"12345","description":"The unique identifier that represent a hub.\n\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/hubs/123`\nthe `hub_id` is `123`."},{"key":"page_id","value":"d97f7c26-0d9b-42a1-a00d-6e6db9619e0f","description":"The unique identifier of a page within the Box Hub."},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves a sorted list of all Hub Document Blocks on a specified page in the hub document, excluding items.\n\nhttps://developer.box.com/reference/get-hub-document-blocks-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": {\n \"id\": \"c9588f08-22d7-4d17-8ca9-f1e61c98c0bd\",\n \"parent_id\": \"d97f7c26-0d9b-42a1-a00d-6e6db9619e0f\",\n \"type\": \"paragraph\",\n \"fragment\": \"This is the paragraph\"\n },\n \"type\": \"document_blocks\",\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\"\n}"},{"id":"8a12f91d-a8c5-49aa-a1d6-ee68a34b1b3c","name":"[401] Returned when the access token provided in the Authorization header","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_document_blocks?hub_id=12345&page_id=d97f7c26-0d9b-42a1-a00d-6e6db9619e0f","protocol":"https","host":["api.box.com"],"path":["2.0","hub_document_blocks"],"query":[{"key":"hub_id","value":"12345","description":"The unique identifier that represent a hub.\n\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/hubs/123`\nthe `hub_id` is `123`."},{"key":"page_id","value":"d97f7c26-0d9b-42a1-a00d-6e6db9619e0f","description":"The unique identifier of a page within the Box Hub."},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves a sorted list of all Hub Document Blocks on a specified page in the hub document, excluding items.\n\nhttps://developer.box.com/reference/get-hub-document-blocks-v2025.0"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"80b45761-5fdb-4aad-a432-ebce168f331c","name":"[404] Returned if the hub or page is not found, or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_document_blocks?hub_id=12345&page_id=d97f7c26-0d9b-42a1-a00d-6e6db9619e0f","protocol":"https","host":["api.box.com"],"path":["2.0","hub_document_blocks"],"query":[{"key":"hub_id","value":"12345","description":"The unique identifier that represent a hub.\n\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/hubs/123`\nthe `hub_id` is `123`."},{"key":"page_id","value":"d97f7c26-0d9b-42a1-a00d-6e6db9619e0f","description":"The unique identifier of a page within the Box Hub."},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves a sorted list of all Hub Document Blocks on a specified page in the hub document, excluding items.\n\nhttps://developer.box.com/reference/get-hub-document-blocks-v2025.0"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"c095cb4e-9faf-4eea-a484-29f157af55f6"}],"id":"a777bc0e-52d3-41a0-a2fe-8e13cdd00903","_postman_id":"a777bc0e-52d3-41a0-a2fe-8e13cdd00903","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/hub_items?hub_id=12345","description":"Retrieves all items associated with a Box Hub.
\nhttps://developer.box.com/reference/get-hub-items-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","hub_items"],"host":["api.box.com"],"query":[{"description":{"content":"The unique identifier that represent a hub.
\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/hubs/123\nthe hub_id is 123.
The unique identifier of an item list block within the Box Hub.
\nWhen provided, the response will only include items that belong\nto the specified item list, allowing you to filter results to\nitems on a specific page or section.
\n","type":"text/plain"},"key":"parent_id","value":"721d97d7-ac8a-4e5e-adb6-ef11af4e6d9e"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"677ed010-14f9-44e3-b15a-2432f7e48aff","name":"[200] Retrieves the items associated with the specified Box Hub.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_items?hub_id=12345","protocol":"https","host":["api.box.com"],"path":["2.0","hub_items"],"query":[{"key":"hub_id","value":"12345","description":"The unique identifier that represent a hub.\n\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/hubs/123`\nthe `hub_id` is `123`."},{"key":"parent_id","value":"721d97d7-ac8a-4e5e-adb6-ef11af4e6d9e","description":"The unique identifier of an item list block within the Box Hub.\n\nWhen provided, the response will only include items that belong\nto the specified item list, allowing you to filter results to\nitems on a specific page or section.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves all items associated with a Box Hub.\n\nhttps://developer.box.com/reference/get-hub-items-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"id\": \"12345678\",\n \"type\": \"file\",\n \"name\": \"My File\"\n }\n ],\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\"\n}"},{"id":"611f0d81-2ad8-48c7-b1ce-c82d0464210d","name":"[401] Returned when the access token provided in the `Authorization` header","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_items?hub_id=12345","protocol":"https","host":["api.box.com"],"path":["2.0","hub_items"],"query":[{"key":"hub_id","value":"12345","description":"The unique identifier that represent a hub.\n\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/hubs/123`\nthe `hub_id` is `123`."},{"key":"parent_id","value":"721d97d7-ac8a-4e5e-adb6-ef11af4e6d9e","description":"The unique identifier of an item list block within the Box Hub.\n\nWhen provided, the response will only include items that belong\nto the specified item list, allowing you to filter results to\nitems on a specific page or section.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves all items associated with a Box Hub.\n\nhttps://developer.box.com/reference/get-hub-items-v2025.0"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"d9e71f71-635a-4b5c-88f0-4e4d3f19e01c","name":"[404] Returned if the Box Hub is not found, or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hub_items?hub_id=12345","protocol":"https","host":["api.box.com"],"path":["2.0","hub_items"],"query":[{"key":"hub_id","value":"12345","description":"The unique identifier that represent a hub.\n\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/hubs/123`\nthe `hub_id` is `123`."},{"key":"parent_id","value":"721d97d7-ac8a-4e5e-adb6-ef11af4e6d9e","description":"The unique identifier of an item list block within the Box Hub.\n\nWhen provided, the response will only include items that belong\nto the specified item list, allowing you to filter results to\nitems on a specific page or section.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves all items associated with a Box Hub.\n\nhttps://developer.box.com/reference/get-hub-items-v2025.0"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"5399749a-da1f-4f91-a122-978af4869e64"},{"name":"Manage Box Hub items","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"814fb99c-a050-43f1-933e-2d0f2cf1cf0c","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"operations\": [\n {\n \"action\": \"add\",\n \"item\": {\n \"type\": \"file\",\n \"id\": \"42037322\"\n },\n \"parent_id\": \"c9588f08-22d7-4d17-8ca9-f1e61c98c0bd\"\n }\n ]\n}"},"url":"https://api.box.com/2.0/hubs/:hub_id/manage_items","description":"Adds and/or removes Box Hub items from a Box Hub.
\nhttps://developer.box.com/reference/post-hubs-id-manage-items-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","hubs",":hub_id","manage_items"],"host":["api.box.com"],"query":[],"variable":[{"id":"7af332f0-56d2-4a59-87e4-4b0cf4960060","description":{"content":"The unique identifier that represent a hub.
\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/hubs/123\nthe hub_id is 123.
Version header.
\n"}],"url":"https://api.box.com/2.0/hubs","description":"Retrieves all Box Hubs for requesting user.
\nhttps://developer.box.com/reference/get-hubs-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","hubs"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"The query string to search for Box Hubs.
\n","type":"text/plain"},"key":"query","value":"Box"},{"disabled":true,"description":{"content":"The scope of the Box Hubs to retrieve. Possible values include editable,\nview_only, and all. Default is all.
The field to sort results by. \nPossible values include name, updated_at,\nlast_accessed_at, view_count, and relevance.\nDefault is relevance.
The direction to sort results in. This can be either in alphabetical ascending\n(ASC) or descending (DESC) order.
Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\n","type":"text/plain"},"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"5da58399-df30-417a-94fc-05ec3fc45d44","name":"[200] Returns all Box Hubs for the given user or enterprise.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/hubs","protocol":"https","host":["api.box.com"],"path":["2.0","hubs"],"query":[{"key":"query","value":"Box","description":"The query string to search for Box Hubs.","disabled":true},{"key":"scope","value":"all","description":"The scope of the Box Hubs to retrieve. Possible values include `editable`,\n`view_only`, and `all`. Default is `all`.","disabled":true},{"key":"sort","value":"name","description":"The field to sort results by. \nPossible values include `name`, `updated_at`,\n`last_accessed_at`, `view_count`, and `relevance`.\nDefault is `relevance`.","disabled":true},{"key":"direction","value":"ASC","description":"The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves all Box Hubs for requesting user.\n\nhttps://developer.box.com/reference/get-hubs-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"id\": \"12345\",\n \"type\": \"hubs\",\n \"title\": \"Contracts\",\n \"description\": \"All the contracts for the company.\",\n \"created_at\": \"2012-12-12T10:53:43Z\",\n \"updated_at\": \"2012-12-12T10:53:43Z\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"updated_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"view_count\": 506,\n \"is_ai_enabled\": true,\n \"is_collaboration_restricted_to_enterprise\": true,\n \"can_non_owners_invite\": true,\n \"can_shared_link_be_created\": true,\n \"can_public_shared_link_be_created\": true\n }\n ],\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\"\n}"}],"_postman_id":"7ec2ae98-13ad-427e-83a6-45e36f93e315"},{"name":"List all Box Hubs for requesting enterprise","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"37d63984-2466-4b4a-9849-99204015556a","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/enterprise_hubs","description":"Retrieves all Box Hubs for a given enterprise.
\nhttps://developer.box.com/reference/get-enterprise-hubs-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","enterprise_hubs"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"The query string to search for Box Hubs.
\n","type":"text/plain"},"key":"query","value":"Box"},{"disabled":true,"description":{"content":"The field to sort results by.\nPossible values include name, updated_at,\nlast_accessed_at, view_count, and relevance.\nDefault is relevance.
The direction to sort results in. This can be either in alphabetical ascending\n(ASC) or descending (DESC) order.
Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\n","type":"text/plain"},"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"10313867-aa7e-4364-8d18-dcc1faa59677","name":"[200] Returns all Box Hubs for the given user or enterprise.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/enterprise_hubs","protocol":"https","host":["api.box.com"],"path":["2.0","enterprise_hubs"],"query":[{"key":"query","value":"Box","description":"The query string to search for Box Hubs.","disabled":true},{"key":"sort","value":"name","description":"The field to sort results by.\nPossible values include `name`, `updated_at`,\n`last_accessed_at`, `view_count`, and `relevance`.\nDefault is `relevance`.","disabled":true},{"key":"direction","value":"ASC","description":"The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves all Box Hubs for a given enterprise.\n\nhttps://developer.box.com/reference/get-enterprise-hubs-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"id\": \"12345\",\n \"type\": \"hubs\",\n \"title\": \"Contracts\",\n \"description\": \"All the contracts for the company.\",\n \"created_at\": \"2012-12-12T10:53:43Z\",\n \"updated_at\": \"2012-12-12T10:53:43Z\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"updated_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"view_count\": 506,\n \"is_ai_enabled\": true,\n \"is_collaboration_restricted_to_enterprise\": true,\n \"can_non_owners_invite\": true,\n \"can_shared_link_be_created\": true,\n \"can_public_shared_link_be_created\": true\n }\n ],\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\"\n}"}],"_postman_id":"37d63984-2466-4b4a-9849-99204015556a"},{"name":"Get Box Hub information by ID","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"4619dca4-de69-4001-bf7f-47a4a223be85","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/hubs/:hub_id","description":"Retrieves details for a Box Hub by its ID.
\nhttps://developer.box.com/reference/get-hubs-id-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","hubs",":hub_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"c8b07916-ccf8-442e-a497-b659ab254bd3","description":{"content":"The unique identifier that represent a hub.
\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/hubs/123\nthe hub_id is 123.
Version header.
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Hub Title\",\n \"description\": \"This is a description of the Box Hub.\"\n}"},"url":"https://api.box.com/2.0/hubs","description":"Creates a new Box Hub.
\nhttps://developer.box.com/reference/post-hubs-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","hubs"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"2defb35d-7c95-4fb3-811a-1c45314e4e37","name":"[201] Returns a new Hub object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Hub Title\",\n \"description\": \"This is a description of the Box Hub.\"\n}"},"url":"https://api.box.com/2.0/hubs","description":"Creates a new Box Hub.\n\nhttps://developer.box.com/reference/post-hubs-v2025.0"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"type\": \"hubs\",\n \"title\": \"Contracts\",\n \"description\": \"All the contracts for the company.\",\n \"created_at\": \"2012-12-12T10:53:43Z\",\n \"updated_at\": \"2012-12-12T10:53:43Z\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"updated_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"view_count\": 506,\n \"is_ai_enabled\": true,\n \"is_collaboration_restricted_to_enterprise\": true,\n \"can_non_owners_invite\": true,\n \"can_shared_link_be_created\": true,\n \"can_public_shared_link_be_created\": true\n}"},{"id":"ab8a535a-d736-4884-902a-1ad66828989d","name":"[400] Returned if any of the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Hub Title\",\n \"description\": \"This is a description of the Box Hub.\"\n}"},"url":"https://api.box.com/2.0/hubs","description":"Creates a new Box Hub.\n\nhttps://developer.box.com/reference/post-hubs-v2025.0"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"b8c28375-5596-46db-923d-3159c0925052","name":"[403] Returns an error when the user does not have the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Hub Title\",\n \"description\": \"This is a description of the Box Hub.\"\n}"},"url":"https://api.box.com/2.0/hubs","description":"Creates a new Box Hub.\n\nhttps://developer.box.com/reference/post-hubs-v2025.0"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"8920401a-fb43-4f68-9d3d-cfbe0684d4d8"},{"name":"Copy Box Hub","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"695b5345-31e0-4998-b708-ba312d6cfa26","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Hub Title\",\n \"description\": \"This is a description of the Box Hub.\"\n}"},"url":"https://api.box.com/2.0/hubs/:hub_id/copy","description":"Creates a copy of a Box Hub.
\nhttps://developer.box.com/reference/post-hubs-id-copy-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","hubs",":hub_id","copy"],"host":["api.box.com"],"query":[],"variable":[{"id":"bd69550a-4998-4c07-a10c-98946cd6ae95","description":{"content":"The unique identifier that represent a hub.
\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/hubs/123\nthe hub_id is 123.
Version header.
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Hub Title\",\n \"description\": \"This is a description of the Box Hub.\",\n \"is_ai_enabled\": true,\n \"is_collaboration_restricted_to_enterprise\": true,\n \"can_non_owners_invite\": true,\n \"can_shared_link_be_created\": true,\n \"can_public_shared_link_be_created\": true\n}"},"url":"https://api.box.com/2.0/hubs/:hub_id","description":"Updates a Box Hub. Can be used to change title, description, or Box Hub settings.
\nhttps://developer.box.com/reference/put-hubs-id-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","hubs",":hub_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"4df56181-9345-47ab-bc66-4d351ca4ac08","description":{"content":"The unique identifier that represent a hub.
\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/hubs/123\nthe hub_id is 123.
Version header.
\n"}],"url":"https://api.box.com/2.0/hubs/:hub_id","description":"Deletes a single Box Hub.
\nhttps://developer.box.com/reference/delete-hubs-id-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","hubs",":hub_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"c63c71c2-7447-49be-9e38-8e469490468e","description":{"content":"The unique identifier that represent a hub.
\nThe ID for any hub can be determined\nby visiting this hub in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/hubs/123\nthe hub_id is 123.
Gets a sign request by ID.
\nhttps://developer.box.com/reference/get-sign-requests-id
\n","urlObject":{"protocol":"https","path":["2.0","sign_requests",":sign_request_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"fdbf5b22-3c31-4e47-83a5-c4435d61f953","description":{"content":"The ID of the signature request.
\n","type":"text/plain"},"type":"any","value":"33243242","key":"sign_request_id"}]}},"response":[{"id":"dbc54026-d174-4618-a311-4d123e37799b","name":"[200] Returns a signature request.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/sign_requests/:sign_request_id","protocol":"https","host":["api.box.com"],"path":["2.0","sign_requests",":sign_request_id"],"variable":[{"id":"fdbf5b22-3c31-4e47-83a5-c4435d61f953","key":"sign_request_id","value":"33243242","description":"The ID of the signature request."}]},"description":"Gets a sign request by ID.\n\nhttps://developer.box.com/reference/get-sign-requests-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"is_document_preparation_needed\": true,\n \"redirect_url\": \"https://www.example.com\",\n \"declined_redirect_url\": \"https://declined-redirect.com\",\n \"are_text_signatures_enabled\": true,\n \"email_subject\": \"Sign Request from Acme\",\n \"email_message\": \"Hello! Please sign the document below\",\n \"are_reminders_enabled\": true,\n \"name\": \"name\",\n \"prefill_tags\": [\n {\n \"document_tag_id\": \"1234\",\n \"text_value\": \"text\",\n \"checkbox_value\": true,\n \"date_value\": \"2021-04-26\"\n }\n ],\n \"days_valid\": 2,\n \"external_id\": \"123\",\n \"template_id\": \"123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb\",\n \"external_system_name\": \"Box\",\n \"type\": \"sign-request\",\n \"source_files\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\"\n }\n ],\n \"signers\": [\n {\n \"email\": \"example@gmail.com\",\n \"role\": \"signer\",\n \"is_in_person\": true,\n \"order\": 2,\n \"embed_url_external_user_id\": \"1234\",\n \"redirect_url\": \"https://example.com\",\n \"declined_redirect_url\": \"https://declined-example.com\",\n \"login_required\": true,\n \"verification_phone_number\": \"6314578901\",\n \"password\": \"SecretPassword123\",\n \"signer_group_id\": \"cd4ff89-8fc1-42cf-8b29-1890dedd26d7\",\n \"suppress_notifications\": false,\n \"language\": \"en\",\n \"has_viewed_document\": true,\n \"signer_decision\": {\n \"type\": \"signed\",\n \"finalized_at\": \"2021-04-26T08:12:13.982Z\",\n \"additional_info\": \"Requesting changes before signing.\"\n },\n \"inputs\": [\n {\n \"document_tag_id\": \"1234\",\n \"text_value\": \"text\",\n \"checkbox_value\": true,\n \"date_value\": \"2021-04-26\",\n \"type\": \"text\",\n \"content_type\": \"signature\",\n \"page_index\": 4,\n \"read_only\": true,\n \"validation\": {\n \"validation_type\": \"email\"\n }\n }\n ],\n \"embed_url\": \"https://example.com\",\n \"iframeable_embed_url\": \"https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4\",\n \"attachments\": [\n {\n \"id\": \"12345\",\n \"name\": \"proof_of_identity.pdf\"\n }\n ]\n }\n ],\n \"signature_color\": \"blue\",\n \"id\": \"12345\",\n \"prepare_url\": \"https://prepareurl.com\",\n \"signing_log\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n }\n },\n \"status\": \"converting\",\n \"sign_files\": {\n \"files\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n }\n }\n ],\n \"is_ready_for_download\": true\n },\n \"auto_expire_at\": \"2021-04-26T08:12:13.982Z\",\n \"parent_folder\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"collaborator_level\": \"owner\",\n \"short_id\": \"SR-12345\",\n \"created_at\": \"2025-02-01T12:00:00Z\",\n \"finished_at\": \"2025-02-02T12:00:00Z\",\n \"sender_email\": \"sender@box.com\",\n \"sender_id\": 12345\n}"},{"id":"2b65a03c-7979-4cdb-b214-3d061ccc0a76","name":"[404] Returns an error when the signature request cannot be found, the user does","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/sign_requests/:sign_request_id","protocol":"https","host":["api.box.com"],"path":["2.0","sign_requests",":sign_request_id"],"variable":[{"id":"fdbf5b22-3c31-4e47-83a5-c4435d61f953","key":"sign_request_id","value":"33243242","description":"The ID of the signature request."}]},"description":"Gets a sign request by ID.\n\nhttps://developer.box.com/reference/get-sign-requests-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"bc34e63e-63c7-465a-9545-6d759b548b4c"},{"name":"List Box Sign requests","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"3e056d8e-2b5d-4a6d-8549-14c8d0d43cf8","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Gets signature requests created by a user. If the sign_files and/or
\nhttps://developer.box.com/reference/get-sign-requests
\n","urlObject":{"protocol":"https","path":["2.0","sign_requests"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"A list of sender emails to filter the signature requests by sender.\nIf provided, shared_requests must be set to true.
If set to true, only includes requests that user is not an owner,\nbut user is a collaborator. Collaborator access is determined by the\nuser access level of the sign files of the request.\nDefault is false. Must be set to true if senders are provided.
Cancels a sign request.
\nhttps://developer.box.com/reference/post-sign-requests-id-cancel
\n","urlObject":{"protocol":"https","path":["2.0","sign_requests",":sign_request_id","cancel"],"host":["api.box.com"],"query":[],"variable":[{"id":"c09c921d-82a9-48d0-8f43-ddb744404503","description":{"content":"The ID of the signature request.
\n","type":"text/plain"},"type":"any","value":"33243242","key":"sign_request_id"}]}},"response":[{"id":"12c4a594-d8d9-4c91-b177-f7a7f64ef107","name":"[200] Returns a Sign Request object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Project cancelled\"\n}"},"url":{"raw":"https://api.box.com/2.0/sign_requests/:sign_request_id/cancel","protocol":"https","host":["api.box.com"],"path":["2.0","sign_requests",":sign_request_id","cancel"],"variable":[{"id":"c09c921d-82a9-48d0-8f43-ddb744404503","key":"sign_request_id","value":"33243242","description":"The ID of the signature request."}]},"description":"Cancels a sign request.\n\nhttps://developer.box.com/reference/post-sign-requests-id-cancel"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"is_document_preparation_needed\": true,\n \"redirect_url\": \"https://www.example.com\",\n \"declined_redirect_url\": \"https://declined-redirect.com\",\n \"are_text_signatures_enabled\": true,\n \"email_subject\": \"Sign Request from Acme\",\n \"email_message\": \"Hello! Please sign the document below\",\n \"are_reminders_enabled\": true,\n \"name\": \"name\",\n \"prefill_tags\": [\n {\n \"document_tag_id\": \"1234\",\n \"text_value\": \"text\",\n \"checkbox_value\": true,\n \"date_value\": \"2021-04-26\"\n }\n ],\n \"days_valid\": 2,\n \"external_id\": \"123\",\n \"template_id\": \"123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb\",\n \"external_system_name\": \"Box\",\n \"type\": \"sign-request\",\n \"source_files\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\"\n }\n ],\n \"signers\": [\n {\n \"email\": \"example@gmail.com\",\n \"role\": \"signer\",\n \"is_in_person\": true,\n \"order\": 2,\n \"embed_url_external_user_id\": \"1234\",\n \"redirect_url\": \"https://example.com\",\n \"declined_redirect_url\": \"https://declined-example.com\",\n \"login_required\": true,\n \"verification_phone_number\": \"6314578901\",\n \"password\": \"SecretPassword123\",\n \"signer_group_id\": \"cd4ff89-8fc1-42cf-8b29-1890dedd26d7\",\n \"suppress_notifications\": false,\n \"language\": \"en\",\n \"has_viewed_document\": true,\n \"signer_decision\": {\n \"type\": \"signed\",\n \"finalized_at\": \"2021-04-26T08:12:13.982Z\",\n \"additional_info\": \"Requesting changes before signing.\"\n },\n \"inputs\": [\n {\n \"document_tag_id\": \"1234\",\n \"text_value\": \"text\",\n \"checkbox_value\": true,\n \"date_value\": \"2021-04-26\",\n \"type\": \"text\",\n \"content_type\": \"signature\",\n \"page_index\": 4,\n \"read_only\": true,\n \"validation\": {\n \"validation_type\": \"email\"\n }\n }\n ],\n \"embed_url\": \"https://example.com\",\n \"iframeable_embed_url\": \"https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4\",\n \"attachments\": [\n {\n \"id\": \"12345\",\n \"name\": \"proof_of_identity.pdf\"\n }\n ]\n }\n ],\n \"signature_color\": \"blue\",\n \"id\": \"12345\",\n \"prepare_url\": \"https://prepareurl.com\",\n \"signing_log\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n }\n },\n \"status\": \"converting\",\n \"sign_files\": {\n \"files\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n }\n }\n ],\n \"is_ready_for_download\": true\n },\n \"auto_expire_at\": \"2021-04-26T08:12:13.982Z\",\n \"parent_folder\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"collaborator_level\": \"owner\",\n \"short_id\": \"SR-12345\",\n \"created_at\": \"2025-02-01T12:00:00Z\",\n \"finished_at\": \"2025-02-02T12:00:00Z\",\n \"sender_email\": \"sender@box.com\",\n \"sender_id\": 12345\n}"},{"id":"2a55ec81-54b4-4ce5-a599-ed555faaa14b","name":"[404] Returns an error when the sign request cannot be found or the user does","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Project cancelled\"\n}"},"url":{"raw":"https://api.box.com/2.0/sign_requests/:sign_request_id/cancel","protocol":"https","host":["api.box.com"],"path":["2.0","sign_requests",":sign_request_id","cancel"],"variable":[{"id":"c09c921d-82a9-48d0-8f43-ddb744404503","key":"sign_request_id","value":"33243242","description":"The ID of the signature request."}]},"description":"Cancels a sign request.\n\nhttps://developer.box.com/reference/post-sign-requests-id-cancel"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"e0a1119d-9b26-4919-839e-1d3e004595a5"},{"name":"Resend Box Sign request","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"8b3bd2a0-3636-4839-9f79-c5066193b9d9","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Resends a signature request email to all outstanding signers.
\nhttps://developer.box.com/reference/post-sign-requests-id-resend
\n","urlObject":{"protocol":"https","path":["2.0","sign_requests",":sign_request_id","resend"],"host":["api.box.com"],"query":[],"variable":[{"id":"e203d5e6-6326-4df6-8761-4d42a56df6f9","description":{"content":"The ID of the signature request.
\n","type":"text/plain"},"type":"any","value":"33243242","key":"sign_request_id"}]}},"response":[{"id":"7888688a-1c1f-43b8-9a0a-9d589c61db58","name":"[202] Returns an empty response when the API call was successful.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[],"url":{"raw":"https://api.box.com/2.0/sign_requests/:sign_request_id/resend","protocol":"https","host":["api.box.com"],"path":["2.0","sign_requests",":sign_request_id","resend"],"variable":[{"id":"e203d5e6-6326-4df6-8761-4d42a56df6f9","key":"sign_request_id","value":"33243242","description":"The ID of the signature request."}]},"description":"Resends a signature request email to all outstanding signers.\n\nhttps://developer.box.com/reference/post-sign-requests-id-resend"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"7da06051-a5b9-40e7-9bc9-ef46edfcea38","name":"[404] Returns an error when the signature request cannot be found or the user does","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[],"url":{"raw":"https://api.box.com/2.0/sign_requests/:sign_request_id/resend","protocol":"https","host":["api.box.com"],"path":["2.0","sign_requests",":sign_request_id","resend"],"variable":[{"id":"e203d5e6-6326-4df6-8761-4d42a56df6f9","key":"sign_request_id","value":"33243242","description":"The ID of the signature request."}]},"description":"Resends a signature request email to all outstanding signers.\n\nhttps://developer.box.com/reference/post-sign-requests-id-resend"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"8b3bd2a0-3636-4839-9f79-c5066193b9d9"},{"name":"Create Box Sign request","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"d8fdd376-8588-469f-ad92-4dae8a929ee8","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates a signature request. This involves preparing a document for signing and
\nhttps://developer.box.com/reference/post-sign-requests
\n","urlObject":{"protocol":"https","path":["2.0","sign_requests"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"90345477-8b7d-4d05-876f-7b260fe26f16","name":"[201] Returns a Box Sign request object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"is_document_preparation_needed\": true,\n \"redirect_url\": \"https://www.example.com\",\n \"declined_redirect_url\": \"https://declined-redirect.com\",\n \"are_text_signatures_enabled\": true,\n \"email_subject\": \"Sign Request from Acme\",\n \"email_message\": \"Hello! Please sign the document below\",\n \"are_reminders_enabled\": true,\n \"name\": \"name\",\n \"prefill_tags\": [\n {\n \"document_tag_id\": \"1234\",\n \"text_value\": \"text\",\n \"checkbox_value\": true,\n \"date_value\": \"2021-04-26\"\n }\n ],\n \"days_valid\": 2,\n \"external_id\": \"123\",\n \"template_id\": \"123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb\",\n \"external_system_name\": \"Box\",\n \"source_files\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\"\n }\n ],\n \"signature_color\": \"blue\",\n \"signers\": [\n {\n \"email\": \"example@gmail.com\",\n \"role\": \"signer\",\n \"is_in_person\": true,\n \"order\": 2,\n \"embed_url_external_user_id\": \"1234\",\n \"redirect_url\": \"https://example.com\",\n \"declined_redirect_url\": \"https://declined-example.com\",\n \"login_required\": true,\n \"verification_phone_number\": \"6314578901\",\n \"password\": \"SecretPassword123\",\n \"signer_group_id\": \"cd4ff89-8fc1-42cf-8b29-1890dedd26d7\",\n \"suppress_notifications\": false,\n \"language\": \"en\"\n }\n ],\n \"parent_folder\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n }\n}"},"url":"https://api.box.com/2.0/sign_requests","description":"Creates a signature request. This involves preparing a document for signing and\n\nhttps://developer.box.com/reference/post-sign-requests"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"is_document_preparation_needed\": true,\n \"redirect_url\": \"https://www.example.com\",\n \"declined_redirect_url\": \"https://declined-redirect.com\",\n \"are_text_signatures_enabled\": true,\n \"email_subject\": \"Sign Request from Acme\",\n \"email_message\": \"Hello! Please sign the document below\",\n \"are_reminders_enabled\": true,\n \"name\": \"name\",\n \"prefill_tags\": [\n {\n \"document_tag_id\": \"1234\",\n \"text_value\": \"text\",\n \"checkbox_value\": true,\n \"date_value\": \"2021-04-26\"\n }\n ],\n \"days_valid\": 2,\n \"external_id\": \"123\",\n \"template_id\": \"123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb\",\n \"external_system_name\": \"Box\",\n \"type\": \"sign-request\",\n \"source_files\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\"\n }\n ],\n \"signers\": [\n {\n \"email\": \"example@gmail.com\",\n \"role\": \"signer\",\n \"is_in_person\": true,\n \"order\": 2,\n \"embed_url_external_user_id\": \"1234\",\n \"redirect_url\": \"https://example.com\",\n \"declined_redirect_url\": \"https://declined-example.com\",\n \"login_required\": true,\n \"verification_phone_number\": \"6314578901\",\n \"password\": \"SecretPassword123\",\n \"signer_group_id\": \"cd4ff89-8fc1-42cf-8b29-1890dedd26d7\",\n \"suppress_notifications\": false,\n \"language\": \"en\",\n \"has_viewed_document\": true,\n \"signer_decision\": {\n \"type\": \"signed\",\n \"finalized_at\": \"2021-04-26T08:12:13.982Z\",\n \"additional_info\": \"Requesting changes before signing.\"\n },\n \"inputs\": [\n {\n \"document_tag_id\": \"1234\",\n \"text_value\": \"text\",\n \"checkbox_value\": true,\n \"date_value\": \"2021-04-26\",\n \"type\": \"text\",\n \"content_type\": \"signature\",\n \"page_index\": 4,\n \"read_only\": true,\n \"validation\": {\n \"validation_type\": \"email\"\n }\n }\n ],\n \"embed_url\": \"https://example.com\",\n \"iframeable_embed_url\": \"https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4\",\n \"attachments\": [\n {\n \"id\": \"12345\",\n \"name\": \"proof_of_identity.pdf\"\n }\n ]\n }\n ],\n \"signature_color\": \"blue\",\n \"id\": \"12345\",\n \"prepare_url\": \"https://prepareurl.com\",\n \"signing_log\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n }\n },\n \"status\": \"converting\",\n \"sign_files\": {\n \"files\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n }\n }\n ],\n \"is_ready_for_download\": true\n },\n \"auto_expire_at\": \"2021-04-26T08:12:13.982Z\",\n \"parent_folder\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"collaborator_level\": \"owner\",\n \"short_id\": \"SR-12345\",\n \"created_at\": \"2025-02-01T12:00:00Z\",\n \"finished_at\": \"2025-02-02T12:00:00Z\",\n \"sender_email\": \"sender@box.com\",\n \"sender_id\": 12345\n}"}],"_postman_id":"d8fdd376-8588-469f-ad92-4dae8a929ee8"}],"id":"997d3da4-a9de-4f41-9b42-1619bda42b3f","_postman_id":"997d3da4-a9de-4f41-9b42-1619bda42b3f","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Gets Box Sign templates created by a user.
\nhttps://developer.box.com/reference/get-sign-templates
\n","urlObject":{"protocol":"https","path":["2.0","sign_templates"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"82525a26-8383-4f47-a913-3daad2adbb82","name":"[200] Returns a collection of templates.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/sign_templates","protocol":"https","host":["api.box.com"],"path":["2.0","sign_templates"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Gets Box Sign templates created by a user.\n\nhttps://developer.box.com/reference/get-sign-templates"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"type\": \"sign-template\",\n \"id\": \"4206996024-14944f75-c34b-478a-95a1-264b1ff80d35\",\n \"name\": \"Official contract\",\n \"email_subject\": \"Sign Request from Acme\",\n \"email_message\": \"Hello! Please sign the document below\",\n \"days_valid\": 2,\n \"parent_folder\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"source_files\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n }\n }\n ],\n \"are_fields_locked\": false,\n \"are_options_locked\": true,\n \"are_recipients_locked\": false,\n \"are_email_settings_locked\": true,\n \"are_files_locked\": true,\n \"signers\": [\n {\n \"inputs\": [\n {\n \"document_tag_id\": \"1234\",\n \"text_value\": \"text\",\n \"checkbox_value\": true,\n \"date_value\": \"2021-04-26\",\n \"type\": \"text\",\n \"content_type\": \"text\",\n \"is_required\": true,\n \"page_index\": 4,\n \"document_id\": \"123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7\",\n \"dropdown_choices\": [\n \"Yes\",\n \"No\",\n \"Maybe\"\n ],\n \"group_id\": \"da317330-225a-4c72-89ad-0d6dcaaf4df6\",\n \"coordinates\": {\n \"x\": 0.672258592471358,\n \"y\": 0.18654283173599448\n },\n \"dimensions\": {\n \"width\": 0.2618657937806874,\n \"height\": 0.05311728090109673\n },\n \"label\": \"Legal name\",\n \"read_only\": true,\n \"validation\": {\n \"validation_type\": \"email\"\n }\n }\n ],\n \"email\": \"example@mail.com\",\n \"role\": \"signer\",\n \"is_in_person\": true,\n \"order\": 2,\n \"signer_group_id\": \"cd4ff89-8fc1-42cf-8b29-1890dedd26d7\",\n \"label\": \"Jane Doe\",\n \"public_id\": \"RJZYYVPR\",\n \"is_password_required\": true,\n \"is_phone_number_required\": true,\n \"login_required\": true\n }\n ],\n \"additional_info\": {\n \"non_editable\": [\n \"email_subject\",\n \"name\"\n ],\n \"required\": {\n \"signers\": [\n [\n \"email\"\n ],\n [\n \"email\"\n ]\n ]\n }\n },\n \"ready_sign_link\": {\n \"url\": \"\\\"https://app.box.com/sign/\\nready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178\\\"\",\n \"name\": \"Official contract\",\n \"instructions\": \"Hello! Please sign the document below\",\n \"folder_id\": \"12345\",\n \"is_notification_disabled\": true,\n \"is_active\": false\n },\n \"custom_branding\": {\n \"company_name\": \"Corporation inc.\",\n \"logo_uri\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA\\nAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A\\n8AAQUBAScY42YAAAAASUVORK5CYII=\",\n \"branding_color\": \"9E5E6F\",\n \"email_footer_text\": \"Contact email email@mail.com\"\n }\n }\n ]\n}"},{"id":"3f856a52-a50d-40e7-a10f-b5dff1c925d3","name":"[401] Returned when the access token provided in the `Authorization` header","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/sign_templates","protocol":"https","host":["api.box.com"],"path":["2.0","sign_templates"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Gets Box Sign templates created by a user.\n\nhttps://developer.box.com/reference/get-sign-templates"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"de09d68f-1de6-4d79-99b2-ec262100bcc8"},{"name":"Get Box Sign template by ID","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"2d218ff4-2b04-4320-a8d2-be830d13afb9","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Fetches details of a specific Box Sign template.
\nhttps://developer.box.com/reference/get-sign-templates-id
\n","urlObject":{"protocol":"https","path":["2.0","sign_templates",":template_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"aeb60c11-5316-464c-96e3-51736b013716","description":{"content":"The ID of a Box Sign template.
\n","type":"text/plain"},"type":"any","value":"123075213-7d117509-8f05-42e4-a5ef-5190a319d41d","key":"template_id"}]}},"response":[{"id":"f6c5dc7d-fab9-485b-ab8b-859369747750","name":"[200] Returns details of a template.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/sign_templates/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","sign_templates",":template_id"],"variable":[{"id":"aeb60c11-5316-464c-96e3-51736b013716","key":"template_id","value":"123075213-7d117509-8f05-42e4-a5ef-5190a319d41d","description":"The ID of a Box Sign template."}]},"description":"Fetches details of a specific Box Sign template.\n\nhttps://developer.box.com/reference/get-sign-templates-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"sign-template\",\n \"id\": \"4206996024-14944f75-c34b-478a-95a1-264b1ff80d35\",\n \"name\": \"Official contract\",\n \"email_subject\": \"Sign Request from Acme\",\n \"email_message\": \"Hello! Please sign the document below\",\n \"days_valid\": 2,\n \"parent_folder\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"source_files\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n }\n }\n ],\n \"are_fields_locked\": false,\n \"are_options_locked\": true,\n \"are_recipients_locked\": false,\n \"are_email_settings_locked\": true,\n \"are_files_locked\": true,\n \"signers\": [\n {\n \"inputs\": [\n {\n \"document_tag_id\": \"1234\",\n \"text_value\": \"text\",\n \"checkbox_value\": true,\n \"date_value\": \"2021-04-26\",\n \"type\": \"text\",\n \"content_type\": \"text\",\n \"is_required\": true,\n \"page_index\": 4,\n \"document_id\": \"123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7\",\n \"dropdown_choices\": [\n \"Yes\",\n \"No\",\n \"Maybe\"\n ],\n \"group_id\": \"da317330-225a-4c72-89ad-0d6dcaaf4df6\",\n \"coordinates\": {\n \"x\": 0.672258592471358,\n \"y\": 0.18654283173599448\n },\n \"dimensions\": {\n \"width\": 0.2618657937806874,\n \"height\": 0.05311728090109673\n },\n \"label\": \"Legal name\",\n \"read_only\": true,\n \"validation\": {\n \"validation_type\": \"email\"\n }\n }\n ],\n \"email\": \"example@mail.com\",\n \"role\": \"signer\",\n \"is_in_person\": true,\n \"order\": 2,\n \"signer_group_id\": \"cd4ff89-8fc1-42cf-8b29-1890dedd26d7\",\n \"label\": \"Jane Doe\",\n \"public_id\": \"RJZYYVPR\",\n \"is_password_required\": true,\n \"is_phone_number_required\": true,\n \"login_required\": true\n }\n ],\n \"additional_info\": {\n \"non_editable\": [\n \"email_subject\",\n \"name\"\n ],\n \"required\": {\n \"signers\": [\n [\n \"email\"\n ],\n [\n \"email\"\n ]\n ]\n }\n },\n \"ready_sign_link\": {\n \"url\": \"\\\"https://app.box.com/sign/\\nready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178\\\"\",\n \"name\": \"Official contract\",\n \"instructions\": \"Hello! Please sign the document below\",\n \"folder_id\": \"12345\",\n \"is_notification_disabled\": true,\n \"is_active\": false\n },\n \"custom_branding\": {\n \"company_name\": \"Corporation inc.\",\n \"logo_uri\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA\\nAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A\\n8AAQUBAScY42YAAAAASUVORK5CYII=\",\n \"branding_color\": \"9E5E6F\",\n \"email_footer_text\": \"Contact email email@mail.com\"\n }\n}"},{"id":"db1c4325-2ffd-41a8-ad26-26ed1cba12fa","name":"[401] Returned when the access token provided in the `Authorization` header","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/sign_templates/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","sign_templates",":template_id"],"variable":[{"id":"aeb60c11-5316-464c-96e3-51736b013716","key":"template_id","value":"123075213-7d117509-8f05-42e4-a5ef-5190a319d41d","description":"The ID of a Box Sign template."}]},"description":"Fetches details of a specific Box Sign template.\n\nhttps://developer.box.com/reference/get-sign-templates-id"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"7214f655-483c-41aa-ad1d-f2c9b37b8ea9","name":"[404] Returned if the template is not found or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/sign_templates/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","sign_templates",":template_id"],"variable":[{"id":"aeb60c11-5316-464c-96e3-51736b013716","key":"template_id","value":"123075213-7d117509-8f05-42e4-a5ef-5190a319d41d","description":"The ID of a Box Sign template."}]},"description":"Fetches details of a specific Box Sign template.\n\nhttps://developer.box.com/reference/get-sign-templates-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"2d218ff4-2b04-4320-a8d2-be830d13afb9"}],"id":"feb8fe43-c250-4c6a-b18b-ed261103b1a6","_postman_id":"feb8fe43-c250-4c6a-b18b-ed261103b1a6","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves the classification metadata template and lists all the
\n\n","urlObject":{"protocol":"https","path":["2.0","metadata_templates","enterprise","securityClassification-6VMVochwUWo","schema"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"535afb93-cb94-40ce-8f9b-ea8f6832192e","name":"[200] Returns the `securityClassification` metadata template, which contains","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":"https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema","description":"Retrieves the classification metadata template and lists all the\n\nhttps://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"type\": \"metadata_template\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"securityClassification-6VMVochwUWo\",\n \"displayName\": \"Classification\",\n \"hidden\": false,\n \"copyInstanceOnItemCopy\": true,\n \"fields\": [\n {\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\",\n \"type\": \"enum\",\n \"key\": \"Box__Security__Classification__Key\",\n \"displayName\": \"Classification\",\n \"hidden\": false,\n \"options\": [\n {\n \"id\": \"46aea176-3483-4431-856c-6b5b13d1cc50\",\n \"key\": \"Sensitive\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"Sensitive information\",\n \"colorID\": 4\n }\n }\n }\n ]\n }\n ]\n}"},{"id":"2ae2494b-4102-4c14-8712-3df63f1b35f1","name":"[400] Returned if any of the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":"https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema","description":"Retrieves the classification metadata template and lists all the\n\nhttps://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"9656bea9-5dab-4c4f-99cc-e921b8497566","name":"[404] Returned when a template name is not correct. Please make sure","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":"https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema","description":"Retrieves the classification metadata template and lists all the\n\nhttps://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"8b2b88cc-a791-401b-9c74-d3a3fe037fb5"},{"name":"Add initial classifications","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"a82db49f-ada6-438f-afc0-d44a416c8463","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"When an enterprise does not yet have any classifications, this API call
\nhttps://developer.box.com/reference/post-metadata-templates-schema#classifications
\n","urlObject":{"protocol":"https","path":["2.0","metadata_templates","schema"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"66e422ea-9c42-4dc3-8c55-c885fc329d92","name":"[200] Returns a new `securityClassification` metadata template, which","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scope\": \"enterprise\",\n \"templateKey\": \"securityClassification-6VMVochwUWo\",\n \"displayName\": \"Classification\",\n \"hidden\": false,\n \"copyInstanceOnItemCopy\": false,\n \"fields\": [\n {\n \"type\": \"enum\",\n \"key\": \"Box__Security__Classification__Key\",\n \"displayName\": \"Classification\",\n \"hidden\": false,\n \"options\": [\n {\n \"key\": \"Sensitive\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"Sensitive information\",\n \"colorID\": 4\n }\n }\n }\n ]\n }\n ]\n}"},"url":"https://api.box.com/2.0/metadata_templates/schema","description":"When an enterprise does not yet have any classifications, this API call\n\nhttps://developer.box.com/reference/post-metadata-templates-schema#classifications"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"type\": \"metadata_template\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"securityClassification-6VMVochwUWo\",\n \"displayName\": \"Classification\",\n \"hidden\": false,\n \"copyInstanceOnItemCopy\": true,\n \"fields\": [\n {\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\",\n \"type\": \"enum\",\n \"key\": \"Box__Security__Classification__Key\",\n \"displayName\": \"Classification\",\n \"hidden\": false,\n \"options\": [\n {\n \"id\": \"46aea176-3483-4431-856c-6b5b13d1cc50\",\n \"key\": \"Sensitive\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"Sensitive information\",\n \"colorID\": 4\n }\n }\n }\n ]\n }\n ]\n}"},{"id":"4b3e2043-2e6f-4425-8a6d-84e663b889b3","name":"[400] Returned if any of the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scope\": \"enterprise\",\n \"templateKey\": \"securityClassification-6VMVochwUWo\",\n \"displayName\": \"Classification\",\n \"hidden\": false,\n \"copyInstanceOnItemCopy\": false,\n \"fields\": [\n {\n \"type\": \"enum\",\n \"key\": \"Box__Security__Classification__Key\",\n \"displayName\": \"Classification\",\n \"hidden\": false,\n \"options\": [\n {\n \"key\": \"Sensitive\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"Sensitive information\",\n \"colorID\": 4\n }\n }\n }\n ]\n }\n ]\n}"},"url":"https://api.box.com/2.0/metadata_templates/schema","description":"When an enterprise does not yet have any classifications, this API call\n\nhttps://developer.box.com/reference/post-metadata-templates-schema#classifications"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"0cdb5b8c-af7c-4cda-a801-763655ee527d","name":"[404] Returned when a template name is not correct. Please make sure","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scope\": \"enterprise\",\n \"templateKey\": \"securityClassification-6VMVochwUWo\",\n \"displayName\": \"Classification\",\n \"hidden\": false,\n \"copyInstanceOnItemCopy\": false,\n \"fields\": [\n {\n \"type\": \"enum\",\n \"key\": \"Box__Security__Classification__Key\",\n \"displayName\": \"Classification\",\n \"hidden\": false,\n \"options\": [\n {\n \"key\": \"Sensitive\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"Sensitive information\",\n \"colorID\": 4\n }\n }\n }\n ]\n }\n ]\n}"},"url":"https://api.box.com/2.0/metadata_templates/schema","description":"When an enterprise does not yet have any classifications, this API call\n\nhttps://developer.box.com/reference/post-metadata-templates-schema#classifications"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"a82db49f-ada6-438f-afc0-d44a416c8463"},{"name":"Add classification","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"b3d7082a-1636-4156-b132-6a100a5c2e06","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Adds one or more new classifications to the list of classifications
\n\n","urlObject":{"protocol":"https","path":["2.0","metadata_templates","enterprise","securityClassification-6VMVochwUWo","schema"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"31531980-785f-4bf6-915e-575ba0b2188e","name":"[200] Returns the updated `securityClassification` metadata template, which","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema","description":"Adds one or more new classifications to the list of classifications\n\nhttps://developer.box.com/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema#add"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"type\": \"metadata_template\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"securityClassification-6VMVochwUWo\",\n \"displayName\": \"Classification\",\n \"hidden\": false,\n \"copyInstanceOnItemCopy\": true,\n \"fields\": [\n {\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\",\n \"type\": \"enum\",\n \"key\": \"Box__Security__Classification__Key\",\n \"displayName\": \"Classification\",\n \"hidden\": false,\n \"options\": [\n {\n \"id\": \"46aea176-3483-4431-856c-6b5b13d1cc50\",\n \"key\": \"Sensitive\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"Sensitive information\",\n \"colorID\": 4\n }\n }\n }\n ]\n }\n ]\n}"},{"id":"006d7352-b18f-474c-ba34-0e6a052b235e","name":"[400] Returned if any of the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema","description":"Adds one or more new classifications to the list of classifications\n\nhttps://developer.box.com/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema#add"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"971171de-e1b9-46fb-952c-cf1f7fe04a4f","name":"[404] Returned when a template name is not correct. Please make sure","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema","description":"Adds one or more new classifications to the list of classifications\n\nhttps://developer.box.com/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema#add"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"b3d7082a-1636-4156-b132-6a100a5c2e06"},{"name":"Update classification","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"9ea49fe9-b11a-46a1-b27e-46b93a9f4ff2","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Updates the labels and descriptions of one or more classifications
\n\n","urlObject":{"protocol":"https","path":["2.0","metadata_templates","enterprise","securityClassification-6VMVochwUWo","schema"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"cf634add-cef8-416a-8e74-c8f1ad1652da","name":"[200] Returns the updated `securityClassification` metadata template, which","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":""},"url":"https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema","description":"Updates the labels and descriptions of one or more classifications\n\nhttps://developer.box.com/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema#update"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"type\": \"metadata_template\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"securityClassification-6VMVochwUWo\",\n \"displayName\": \"Classification\",\n \"hidden\": false,\n \"copyInstanceOnItemCopy\": true,\n \"fields\": [\n {\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\",\n \"type\": \"enum\",\n \"key\": \"Box__Security__Classification__Key\",\n \"displayName\": \"Classification\",\n \"hidden\": false,\n \"options\": [\n {\n \"id\": \"46aea176-3483-4431-856c-6b5b13d1cc50\",\n \"key\": \"Sensitive\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"Sensitive information\",\n \"colorID\": 4\n }\n }\n }\n ]\n }\n ]\n}"},{"id":"8b2bb273-a35f-4823-8149-21386934b87d","name":"[400] Returned if any of the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":""},"url":"https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema","description":"Updates the labels and descriptions of one or more classifications\n\nhttps://developer.box.com/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema#update"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"0a944b39-c883-4a41-a768-da00e9bb235a","name":"[404] Returned when a template name is not correct. Please make sure","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":""},"url":"https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema","description":"Updates the labels and descriptions of one or more classifications\n\nhttps://developer.box.com/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema#update"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"9ea49fe9-b11a-46a1-b27e-46b93a9f4ff2"}],"id":"256d6415-acda-428b-90e4-b7dbd7815736","_postman_id":"256d6415-acda-428b-90e4-b7dbd7815736","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves the classification metadata instance that
\n\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","metadata","enterprise","securityClassification-6VMVochwUWo"],"host":["api.box.com"],"query":[],"variable":[{"id":"f60c83f9-ae14-4706-b8b8-60e589cdf049","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
Adds a classification to a file by specifying the label of the
\n\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","metadata","enterprise","securityClassification-6VMVochwUWo"],"host":["api.box.com"],"query":[],"variable":[{"id":"024247e8-c729-45aa-abe7-55b8f7264a65","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
Updates a classification on a file.
\n\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","metadata","enterprise","securityClassification-6VMVochwUWo"],"host":["api.box.com"],"query":[],"variable":[{"id":"a4e7cef5-4735-4b74-94f1-f1e664dbbeda","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
Removes any classifications from a file.
\n\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","metadata","enterprise","securityClassification-6VMVochwUWo"],"host":["api.box.com"],"query":[],"variable":[{"id":"346facc1-ef9f-45de-94b7-919193c98610","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
Retrieves the classification metadata instance that
\n\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id","metadata","enterprise","securityClassification-6VMVochwUWo"],"host":["api.box.com"],"query":[],"variable":[{"id":"f554673d-136e-481e-b27a-784258ff9477","description":{"content":"The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder of a Box account is\nalways represented by the ID 0.
Adds a classification to a folder by specifying the label of the
\n\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id","metadata","enterprise","securityClassification-6VMVochwUWo"],"host":["api.box.com"],"query":[],"variable":[{"id":"88bac2ad-dac4-44ac-9b7e-772644010f2e","description":{"content":"The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder of a Box account is\nalways represented by the ID 0.
Updates a classification on a folder.
\n\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id","metadata","enterprise","securityClassification-6VMVochwUWo"],"host":["api.box.com"],"query":[],"variable":[{"id":"8f864bbd-c6e6-4e82-a10e-66060fa11bb3","description":{"content":"The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder of a Box account is\nalways represented by the ID 0.
Removes any classifications from a folder.
\n\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id","metadata","enterprise","securityClassification-6VMVochwUWo"],"host":["api.box.com"],"query":[],"variable":[{"id":"ec1bb5d1-1226-4953-8ecb-734c89c9a23b","description":{"content":"The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder of a Box account is\nalways represented by the ID 0.
Retrieves a single collaboration.
\nhttps://developer.box.com/reference/get-collaborations-id
\n","urlObject":{"protocol":"https","path":["2.0","collaborations",":collaboration_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"09239a04-f999-4bcd-af27-d07492aa74b2","description":{"content":"The ID of the collaboration.
\n","type":"text/plain"},"type":"any","value":"1234","key":"collaboration_id"}]}},"response":[{"id":"3a9779a5-db38-4629-b200-016618273ffa","name":"[200] Returns a collaboration object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/collaborations/:collaboration_id","protocol":"https","host":["api.box.com"],"path":["2.0","collaborations",":collaboration_id"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}],"variable":[{"id":"09239a04-f999-4bcd-af27-d07492aa74b2","key":"collaboration_id","value":"1234","description":"The ID of the collaboration."}]},"description":"Retrieves a single collaboration.\n\nhttps://developer.box.com/reference/get-collaborations-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345678\",\n \"type\": \"collaboration\",\n \"item\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n },\n \"description\": \"Contract for Q1 renewal\",\n \"size\": 629644,\n \"path_collection\": {\n \"total_count\": 1,\n \"entries\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n }\n ]\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"trashed_at\": \"2012-12-12T10:53:43-08:00\",\n \"purged_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_created_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"owned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"shared_link\": {\n \"url\": \"https://www.box.com/s/vspke7y05sb214wjokpk\",\n \"download_url\": \"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg\",\n \"vanity_url\": \"https://acme.app.box.com/v/my_url/\",\n \"vanity_name\": \"my_url\",\n \"access\": \"open\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_download\",\n \"unshared_at\": \"2018-04-13T13:53:23-07:00\",\n \"is_password_enabled\": true,\n \"permissions\": {\n \"can_download\": true,\n \"can_preview\": true,\n \"can_edit\": false\n },\n \"download_count\": 3,\n \"preview_count\": 3\n },\n \"parent\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"item_status\": \"active\"\n },\n \"app_item\": {\n \"id\": \"12345678\",\n \"type\": \"app_item\",\n \"application_type\": \"hubs\"\n },\n \"accessible_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\",\n \"is_active\": true\n },\n \"invite_email\": \"john@example.com\",\n \"role\": \"editor\",\n \"expires_at\": \"2012-12-26T10:53:43-08:00\",\n \"is_access_only\": true,\n \"status\": \"accepted\",\n \"acknowledged_at\": \"2012-12-12T10:55:20-08:00\",\n \"created_by\": [\n {\n \"id\": 33224412\n },\n {\n \"type\": \"user\"\n },\n {\n \"login\": \"dylan@example.com\"\n },\n {\n \"name\": \"Dylan Smith\"\n }\n ],\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"acceptance_requirements_status\": {\n \"terms_of_service_requirement\": {\n \"is_accepted\": true,\n \"terms_of_service\": {\n \"id\": \"11446498\",\n \"type\": \"terms_of_service\"\n }\n },\n \"strong_password_requirement\": {\n \"enterprise_has_strong_password_required_for_external_users\": true,\n \"user_has_strong_password\": true\n },\n \"two_factor_authentication_requirement\": {\n \"enterprise_has_two_factor_auth_enabled\": true,\n \"user_has_two_factor_authentication_enabled\": true\n }\n }\n}"}],"_postman_id":"91f0a288-474b-4917-946c-43c68c4f2181"},{"name":"Create collaboration","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"9af5e7fe-1807-4597-88a5-e3c0dc55a185","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Adds a collaboration for a single user or a single group to a file
\nhttps://developer.box.com/reference/post-collaborations
\n","urlObject":{"protocol":"https","path":["2.0","collaborations"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"},{"disabled":true,"description":{"content":"Determines if users should receive email notification\nfor the action performed.
\n","type":"text/plain"},"key":"notify","value":"true"}],"variable":[]}},"response":[{"id":"084dd5dd-95f6-457a-a754-8f9ceaafaa7a","name":"[201] Returns a new collaboration object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item\": {\n \"type\": \"file\",\n \"id\": \"11446498\"\n },\n \"accessible_by\": {\n \"type\": \"user\",\n \"id\": \"23522323\",\n \"login\": \"john@example.com\"\n },\n \"role\": \"editor\",\n \"is_access_only\": true,\n \"can_view_path\": true,\n \"expires_at\": \"2019-08-29T23:59:00-07:00\"\n}"},"url":{"raw":"https://api.box.com/2.0/collaborations","protocol":"https","host":["api.box.com"],"path":["2.0","collaborations"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true},{"key":"notify","value":"true","description":"Determines if users should receive email notification\nfor the action performed.","disabled":true}]},"description":"Adds a collaboration for a single user or a single group to a file\n\nhttps://developer.box.com/reference/post-collaborations"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345678\",\n \"type\": \"collaboration\",\n \"item\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n },\n \"description\": \"Contract for Q1 renewal\",\n \"size\": 629644,\n \"path_collection\": {\n \"total_count\": 1,\n \"entries\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n }\n ]\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"trashed_at\": \"2012-12-12T10:53:43-08:00\",\n \"purged_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_created_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"owned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"shared_link\": {\n \"url\": \"https://www.box.com/s/vspke7y05sb214wjokpk\",\n \"download_url\": \"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg\",\n \"vanity_url\": \"https://acme.app.box.com/v/my_url/\",\n \"vanity_name\": \"my_url\",\n \"access\": \"open\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_download\",\n \"unshared_at\": \"2018-04-13T13:53:23-07:00\",\n \"is_password_enabled\": true,\n \"permissions\": {\n \"can_download\": true,\n \"can_preview\": true,\n \"can_edit\": false\n },\n \"download_count\": 3,\n \"preview_count\": 3\n },\n \"parent\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"item_status\": \"active\"\n },\n \"app_item\": {\n \"id\": \"12345678\",\n \"type\": \"app_item\",\n \"application_type\": \"hubs\"\n },\n \"accessible_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\",\n \"is_active\": true\n },\n \"invite_email\": \"john@example.com\",\n \"role\": \"editor\",\n \"expires_at\": \"2012-12-26T10:53:43-08:00\",\n \"is_access_only\": true,\n \"status\": \"accepted\",\n \"acknowledged_at\": \"2012-12-12T10:55:20-08:00\",\n \"created_by\": [\n {\n \"id\": 33224412\n },\n {\n \"type\": \"user\"\n },\n {\n \"login\": \"dylan@example.com\"\n },\n {\n \"name\": \"Dylan Smith\"\n }\n ],\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"acceptance_requirements_status\": {\n \"terms_of_service_requirement\": {\n \"is_accepted\": true,\n \"terms_of_service\": {\n \"id\": \"11446498\",\n \"type\": \"terms_of_service\"\n }\n },\n \"strong_password_requirement\": {\n \"enterprise_has_strong_password_required_for_external_users\": true,\n \"user_has_strong_password\": true\n },\n \"two_factor_authentication_requirement\": {\n \"enterprise_has_two_factor_auth_enabled\": true,\n \"user_has_two_factor_authentication_enabled\": true\n }\n }\n}"},{"id":"76cb73f7-51c7-48fc-a9b7-79d00af33430","name":"[403] Returns an error when the user does not have the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item\": {\n \"type\": \"file\",\n \"id\": \"11446498\"\n },\n \"accessible_by\": {\n \"type\": \"user\",\n \"id\": \"23522323\",\n \"login\": \"john@example.com\"\n },\n \"role\": \"editor\",\n \"is_access_only\": true,\n \"can_view_path\": true,\n \"expires_at\": \"2019-08-29T23:59:00-07:00\"\n}"},"url":{"raw":"https://api.box.com/2.0/collaborations","protocol":"https","host":["api.box.com"],"path":["2.0","collaborations"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true},{"key":"notify","value":"true","description":"Determines if users should receive email notification\nfor the action performed.","disabled":true}]},"description":"Adds a collaboration for a single user or a single group to a file\n\nhttps://developer.box.com/reference/post-collaborations"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"9af5e7fe-1807-4597-88a5-e3c0dc55a185"},{"name":"Update collaboration","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"8109d025-6fbc-4404-bc61-0ac74bb9eef8","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Updates a collaboration.
\nhttps://developer.box.com/reference/put-collaborations-id
\n","urlObject":{"protocol":"https","path":["2.0","collaborations",":collaboration_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"8a02472e-8b17-43a8-82d3-2ddb529c245f","description":{"content":"The ID of the collaboration.
\n","type":"text/plain"},"type":"any","value":"1234","key":"collaboration_id"}]}},"response":[{"id":"2b3a3f56-fdc8-41d9-8548-801c00ada1ce","name":"[200] Returns an updated collaboration object unless the owner has changed.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"role\": \"editor\",\n \"status\": \"accepted\",\n \"expires_at\": \"2019-08-29T23:59:00-07:00\",\n \"can_view_path\": true\n}"},"url":{"raw":"https://api.box.com/2.0/collaborations/:collaboration_id","protocol":"https","host":["api.box.com"],"path":["2.0","collaborations",":collaboration_id"],"variable":[{"id":"8a02472e-8b17-43a8-82d3-2ddb529c245f","key":"collaboration_id","value":"1234","description":"The ID of the collaboration."}]},"description":"Updates a collaboration.\n\nhttps://developer.box.com/reference/put-collaborations-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345678\",\n \"type\": \"collaboration\",\n \"item\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n },\n \"description\": \"Contract for Q1 renewal\",\n \"size\": 629644,\n \"path_collection\": {\n \"total_count\": 1,\n \"entries\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n }\n ]\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"trashed_at\": \"2012-12-12T10:53:43-08:00\",\n \"purged_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_created_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"owned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"shared_link\": {\n \"url\": \"https://www.box.com/s/vspke7y05sb214wjokpk\",\n \"download_url\": \"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg\",\n \"vanity_url\": \"https://acme.app.box.com/v/my_url/\",\n \"vanity_name\": \"my_url\",\n \"access\": \"open\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_download\",\n \"unshared_at\": \"2018-04-13T13:53:23-07:00\",\n \"is_password_enabled\": true,\n \"permissions\": {\n \"can_download\": true,\n \"can_preview\": true,\n \"can_edit\": false\n },\n \"download_count\": 3,\n \"preview_count\": 3\n },\n \"parent\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"item_status\": \"active\"\n },\n \"app_item\": {\n \"id\": \"12345678\",\n \"type\": \"app_item\",\n \"application_type\": \"hubs\"\n },\n \"accessible_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\",\n \"is_active\": true\n },\n \"invite_email\": \"john@example.com\",\n \"role\": \"editor\",\n \"expires_at\": \"2012-12-26T10:53:43-08:00\",\n \"is_access_only\": true,\n \"status\": \"accepted\",\n \"acknowledged_at\": \"2012-12-12T10:55:20-08:00\",\n \"created_by\": [\n {\n \"id\": 33224412\n },\n {\n \"type\": \"user\"\n },\n {\n \"login\": \"dylan@example.com\"\n },\n {\n \"name\": \"Dylan Smith\"\n }\n ],\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"acceptance_requirements_status\": {\n \"terms_of_service_requirement\": {\n \"is_accepted\": true,\n \"terms_of_service\": {\n \"id\": \"11446498\",\n \"type\": \"terms_of_service\"\n }\n },\n \"strong_password_requirement\": {\n \"enterprise_has_strong_password_required_for_external_users\": true,\n \"user_has_strong_password\": true\n },\n \"two_factor_authentication_requirement\": {\n \"enterprise_has_two_factor_auth_enabled\": true,\n \"user_has_two_factor_authentication_enabled\": true\n }\n }\n}"},{"id":"194b21c2-4b27-40e1-85ca-f9026be6c118","name":"[204] If the role is changed to `owner`, the collaboration is deleted","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"role\": \"editor\",\n \"status\": \"accepted\",\n \"expires_at\": \"2019-08-29T23:59:00-07:00\",\n \"can_view_path\": true\n}"},"url":{"raw":"https://api.box.com/2.0/collaborations/:collaboration_id","protocol":"https","host":["api.box.com"],"path":["2.0","collaborations",":collaboration_id"],"variable":[{"id":"8a02472e-8b17-43a8-82d3-2ddb529c245f","key":"collaboration_id","value":"1234","description":"The ID of the collaboration."}]},"description":"Updates a collaboration.\n\nhttps://developer.box.com/reference/put-collaborations-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"089c6940-51b1-461c-9226-3bc093fe0cb6","name":"[403] Returns an error if the authenticated user does not have the right","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"role\": \"editor\",\n \"status\": \"accepted\",\n \"expires_at\": \"2019-08-29T23:59:00-07:00\",\n \"can_view_path\": true\n}"},"url":{"raw":"https://api.box.com/2.0/collaborations/:collaboration_id","protocol":"https","host":["api.box.com"],"path":["2.0","collaborations",":collaboration_id"],"variable":[{"id":"8a02472e-8b17-43a8-82d3-2ddb529c245f","key":"collaboration_id","value":"1234","description":"The ID of the collaboration."}]},"description":"Updates a collaboration.\n\nhttps://developer.box.com/reference/put-collaborations-id"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"8109d025-6fbc-4404-bc61-0ac74bb9eef8"},{"name":"Remove collaboration","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"7c802ae3-82e4-4cfb-856c-fb8ac47e5e34","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Deletes a single collaboration.
\nhttps://developer.box.com/reference/delete-collaborations-id
\n","urlObject":{"protocol":"https","path":["2.0","collaborations",":collaboration_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"4611760c-740c-491c-a27e-2cd88f98cd66","description":{"content":"The ID of the collaboration.
\n","type":"text/plain"},"type":"any","value":"1234","key":"collaboration_id"}]}},"response":[{"id":"742fcc9b-167e-461f-a333-424ad10ac820","name":"[204] A blank response is returned if the collaboration was","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/collaborations/:collaboration_id","protocol":"https","host":["api.box.com"],"path":["2.0","collaborations",":collaboration_id"],"variable":[{"id":"4611760c-740c-491c-a27e-2cd88f98cd66","key":"collaboration_id","value":"1234","description":"The ID of the collaboration."}]},"description":"Deletes a single collaboration.\n\nhttps://developer.box.com/reference/delete-collaborations-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7c802ae3-82e4-4cfb-856c-fb8ac47e5e34"}],"id":"bbcbdc20-bf2a-428c-a533-7a6e59618079","_postman_id":"bbcbdc20-bf2a-428c-a533-7a6e59618079","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves a list of pending and active collaborations for a
\nhttps://developer.box.com/reference/get-files-id-collaborations
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","collaborations"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
Retrieves a list of pending and active collaborations for a
\nhttps://developer.box.com/reference/get-folders-id-collaborations
\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id","collaborations"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
Retrieves all pending collaboration invites for this user.
\nhttps://developer.box.com/reference/get-collaborations
\n","urlObject":{"protocol":"https","path":["2.0","collaborations"],"host":["api.box.com"],"query":[{"description":{"content":"The status of the collaborations to retrieve.
\n","type":"text/plain"},"key":"status","value":"pending"},{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"},{"disabled":true,"description":{"content":"The offset of the item at which to begin the response.
\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.
\n","type":"text/plain"},"key":"offset","value":"1000"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"8b83d8b2-ce4b-46d4-9777-cf399eafc587","name":"[200] Returns a collection of pending collaboration objects.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/collaborations?status=pending","protocol":"https","host":["api.box.com"],"path":["2.0","collaborations"],"query":[{"key":"status","value":"pending","description":"The status of the collaborations to retrieve."},{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true},{"key":"offset","value":"1000","description":"The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves all pending collaboration invites for this user.\n\nhttps://developer.box.com/reference/get-collaborations"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 5000,\n \"limit\": 1000,\n \"offset\": 2000,\n \"entries\": [\n {\n \"id\": \"12345678\",\n \"type\": \"collaboration\",\n \"item\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n },\n \"description\": \"Contract for Q1 renewal\",\n \"size\": 629644,\n \"path_collection\": {\n \"total_count\": 1,\n \"entries\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n }\n ]\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"trashed_at\": \"2012-12-12T10:53:43-08:00\",\n \"purged_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_created_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"owned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"shared_link\": {\n \"url\": \"https://www.box.com/s/vspke7y05sb214wjokpk\",\n \"download_url\": \"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg\",\n \"vanity_url\": \"https://acme.app.box.com/v/my_url/\",\n \"vanity_name\": \"my_url\",\n \"access\": \"open\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_download\",\n \"unshared_at\": \"2018-04-13T13:53:23-07:00\",\n \"is_password_enabled\": true,\n \"permissions\": {\n \"can_download\": true,\n \"can_preview\": true,\n \"can_edit\": false\n },\n \"download_count\": 3,\n \"preview_count\": 3\n },\n \"parent\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"item_status\": \"active\"\n },\n \"app_item\": {\n \"id\": \"12345678\",\n \"type\": \"app_item\",\n \"application_type\": \"hubs\"\n },\n \"accessible_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\",\n \"is_active\": true\n },\n \"invite_email\": \"john@example.com\",\n \"role\": \"editor\",\n \"expires_at\": \"2012-12-26T10:53:43-08:00\",\n \"is_access_only\": true,\n \"status\": \"accepted\",\n \"acknowledged_at\": \"2012-12-12T10:55:20-08:00\",\n \"created_by\": [\n {\n \"id\": 33224412\n },\n {\n \"type\": \"user\"\n },\n {\n \"login\": \"dylan@example.com\"\n },\n {\n \"name\": \"Dylan Smith\"\n }\n ],\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"acceptance_requirements_status\": {\n \"terms_of_service_requirement\": {\n \"is_accepted\": true,\n \"terms_of_service\": {\n \"id\": \"11446498\",\n \"type\": \"terms_of_service\"\n }\n },\n \"strong_password_requirement\": {\n \"enterprise_has_strong_password_required_for_external_users\": true,\n \"user_has_strong_password\": true\n },\n \"two_factor_authentication_requirement\": {\n \"enterprise_has_two_factor_auth_enabled\": true,\n \"user_has_two_factor_authentication_enabled\": true\n }\n }\n }\n ]\n}"}],"_postman_id":"0f0da3aa-9879-48c5-b235-6f66dca263e5"},{"name":"List group collaborations","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"9e5eb5a8-1e94-451a-9b34-da45d35408c1","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves all the collaborations for a group. The user
\nhttps://developer.box.com/reference/get-groups-id-collaborations
\n","urlObject":{"protocol":"https","path":["2.0","groups",":group_id","collaborations"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"The offset of the item at which to begin the response.
\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.
\n","type":"text/plain"},"key":"offset","value":"1000"}],"variable":[{"id":"bdd56e0c-0454-4d53-a292-d0608d0d1d50","description":{"content":"The ID of the group.
\n","type":"text/plain"},"type":"any","value":"57645","key":"group_id"}]}},"response":[{"id":"a7bb2531-698c-42a2-8371-695c1124a960","name":"[200] Returns a collection of collaboration objects. If there are no","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/groups/:group_id/collaborations","protocol":"https","host":["api.box.com"],"path":["2.0","groups",":group_id","collaborations"],"query":[{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"offset","value":"1000","description":"The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.","disabled":true}],"variable":[{"id":"bdd56e0c-0454-4d53-a292-d0608d0d1d50","key":"group_id","value":"57645","description":"The ID of the group."}]},"description":"Retrieves all the collaborations for a group. The user\n\nhttps://developer.box.com/reference/get-groups-id-collaborations"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 5000,\n \"limit\": 1000,\n \"offset\": 2000,\n \"entries\": [\n {\n \"id\": \"12345678\",\n \"type\": \"collaboration\",\n \"item\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n },\n \"description\": \"Contract for Q1 renewal\",\n \"size\": 629644,\n \"path_collection\": {\n \"total_count\": 1,\n \"entries\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n }\n ]\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"trashed_at\": \"2012-12-12T10:53:43-08:00\",\n \"purged_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_created_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"owned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"shared_link\": {\n \"url\": \"https://www.box.com/s/vspke7y05sb214wjokpk\",\n \"download_url\": \"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg\",\n \"vanity_url\": \"https://acme.app.box.com/v/my_url/\",\n \"vanity_name\": \"my_url\",\n \"access\": \"open\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_download\",\n \"unshared_at\": \"2018-04-13T13:53:23-07:00\",\n \"is_password_enabled\": true,\n \"permissions\": {\n \"can_download\": true,\n \"can_preview\": true,\n \"can_edit\": false\n },\n \"download_count\": 3,\n \"preview_count\": 3\n },\n \"parent\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"item_status\": \"active\"\n },\n \"app_item\": {\n \"id\": \"12345678\",\n \"type\": \"app_item\",\n \"application_type\": \"hubs\"\n },\n \"accessible_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\",\n \"is_active\": true\n },\n \"invite_email\": \"john@example.com\",\n \"role\": \"editor\",\n \"expires_at\": \"2012-12-26T10:53:43-08:00\",\n \"is_access_only\": true,\n \"status\": \"accepted\",\n \"acknowledged_at\": \"2012-12-12T10:55:20-08:00\",\n \"created_by\": [\n {\n \"id\": 33224412\n },\n {\n \"type\": \"user\"\n },\n {\n \"login\": \"dylan@example.com\"\n },\n {\n \"name\": \"Dylan Smith\"\n }\n ],\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"acceptance_requirements_status\": {\n \"terms_of_service_requirement\": {\n \"is_accepted\": true,\n \"terms_of_service\": {\n \"id\": \"11446498\",\n \"type\": \"terms_of_service\"\n }\n },\n \"strong_password_requirement\": {\n \"enterprise_has_strong_password_required_for_external_users\": true,\n \"user_has_strong_password\": true\n },\n \"two_factor_authentication_requirement\": {\n \"enterprise_has_two_factor_auth_enabled\": true,\n \"user_has_two_factor_authentication_enabled\": true\n }\n }\n }\n ]\n}"}],"_postman_id":"9e5eb5a8-1e94-451a-9b34-da45d35408c1"}],"id":"c032105a-a736-4f6c-83ad-95576698c432","_postman_id":"c032105a-a736-4f6c-83ad-95576698c432","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves all collections for a given user.
\nhttps://developer.box.com/reference/get-collections
\n","urlObject":{"protocol":"https","path":["2.0","collections"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"},{"disabled":true,"description":{"content":"The offset of the item at which to begin the response.
\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.
\n","type":"text/plain"},"key":"offset","value":"1000"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"d30a1172-f8ff-415f-99b3-d5c66d8cd219","name":"[200] Returns all collections for the given user.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/collections","protocol":"https","host":["api.box.com"],"path":["2.0","collections"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true},{"key":"offset","value":"1000","description":"The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves all collections for a given user.\n\nhttps://developer.box.com/reference/get-collections"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 5000,\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"ASC\"\n }\n ],\n \"entries\": [\n {\n \"id\": \"11446498\",\n \"type\": \"collection\",\n \"name\": \"Favorites\",\n \"collection_type\": \"favorites\"\n }\n ]\n}"}],"_postman_id":"6fd3b713-1a06-4ce7-860e-2d43709678a3"},{"name":"List collection items","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"2c073a39-b1b2-40a6-b0d0-e9596aaa2588","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves the files and/or folders contained within
\nhttps://developer.box.com/reference/get-collections-id-items
\n","urlObject":{"protocol":"https","path":["2.0","collections",":collection_id","items"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"},{"disabled":true,"description":{"content":"The offset of the item at which to begin the response.
\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.
\n","type":"text/plain"},"key":"offset","value":"1000"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[{"id":"f5fa0e88-cf17-4f28-81ee-d5e359d16b06","description":{"content":"The ID of the collection.
\n","type":"text/plain"},"type":"any","value":"926489","key":"collection_id"}]}},"response":[{"id":"14814d91-79ca-4b19-aabf-7ceeaad698b3","name":"[200] Returns an array of items in the collection.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/collections/:collection_id/items","protocol":"https","host":["api.box.com"],"path":["2.0","collections",":collection_id","items"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true},{"key":"offset","value":"1000","description":"The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"f5fa0e88-cf17-4f28-81ee-d5e359d16b06","key":"collection_id","value":"926489","description":"The ID of the collection."}]},"description":"Retrieves the files and/or folders contained within\n\nhttps://developer.box.com/reference/get-collections-id-items"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 5000,\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"ASC\"\n }\n ],\n \"entries\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n },\n \"description\": \"Contract for Q1 renewal\",\n \"size\": 629644,\n \"path_collection\": {\n \"total_count\": 1,\n \"entries\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n }\n ]\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"trashed_at\": \"2012-12-12T10:53:43-08:00\",\n \"purged_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_created_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"owned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"shared_link\": {\n \"url\": \"https://www.box.com/s/vspke7y05sb214wjokpk\",\n \"download_url\": \"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg\",\n \"vanity_url\": \"https://acme.app.box.com/v/my_url/\",\n \"vanity_name\": \"my_url\",\n \"access\": \"open\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_download\",\n \"unshared_at\": \"2018-04-13T13:53:23-07:00\",\n \"is_password_enabled\": true,\n \"permissions\": {\n \"can_download\": true,\n \"can_preview\": true,\n \"can_edit\": false\n },\n \"download_count\": 3,\n \"preview_count\": 3\n },\n \"parent\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"item_status\": \"active\",\n \"version_number\": \"1\",\n \"comment_count\": 10,\n \"permissions\": {\n \"can_delete\": true,\n \"can_download\": true,\n \"can_invite_collaborator\": true,\n \"can_rename\": true,\n \"can_set_share_access\": true,\n \"can_share\": true,\n \"can_annotate\": true,\n \"can_comment\": true,\n \"can_preview\": true,\n \"can_upload\": true,\n \"can_view_annotations_all\": true,\n \"can_view_annotations_self\": true,\n \"can_apply_watermark\": true\n },\n \"tags\": [\n \"approved\"\n ],\n \"lock\": {\n \"id\": \"11446498\",\n \"type\": \"lock\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"expired_at\": \"2012-12-12T10:53:43-08:00\",\n \"is_download_prevented\": true,\n \"app_type\": \"office_wopiplus\"\n },\n \"extension\": \"pdf\",\n \"is_package\": true,\n \"expiring_embed_link\": {\n \"access_token\": \"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ\",\n \"expires_in\": 3600,\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_download\",\n \"object\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n }\n }\n ],\n \"url\": \"https://cloud.app.box.com/preview/expiring_embed/...\"\n },\n \"watermark_info\": {\n \"is_watermarked\": true,\n \"is_watermark_inherited\": false,\n \"is_watermarked_by_access_policy\": false\n },\n \"is_accessible_via_shared_link\": true,\n \"allowed_invitee_roles\": [\n \"editor\"\n ],\n \"is_externally_owned\": true,\n \"has_collaborations\": true,\n \"metadata\": {\n \"enterprise_27335\": {\n \"marketingCollateral\": {\n \"$canEdit\": true,\n \"$id\": \"01234500-12f1-1234-aa12-b1d234cb567e\",\n \"$parent\": \"folder_59449484661\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"marketingCollateral\",\n \"$type\": \"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0\",\n \"$typeVersion\": 2,\n \"$version\": 1\n }\n }\n },\n \"expires_at\": \"2012-12-12T10:53:43-08:00\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567\"\n },\n \"info\": {\n \"url\": \"https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048\"\n },\n \"properties\": {\n \"dimensions\": \"2048x2048\",\n \"paged\": \"true\",\n \"thumb\": \"true\"\n },\n \"representation\": \"png\",\n \"status\": {\n \"state\": \"success\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"Top Secret\",\n \"definition\": \"Content that should not be shared outside the company.\",\n \"color\": \"#FF0000\"\n },\n \"uploader_display_name\": \"Ellis Wiggins\",\n \"disposition_at\": \"2012-12-12T10:53:43-08:00\",\n \"shared_link_permission_options\": [\n \"can_preview\"\n ],\n \"is_associated_with_app_item\": true\n }\n}"}],"_postman_id":"2c073a39-b1b2-40a6-b0d0-e9596aaa2588"},{"name":"Get collection by ID","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"3f3d868c-6cc1-4adb-946d-d534a570ced0","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves a collection by its ID.
\nhttps://developer.box.com/reference/get-collections-id
\n","urlObject":{"protocol":"https","path":["2.0","collections",":collection_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"f9958b3c-90b9-4491-bd7e-5cf83c56d116","description":{"content":"The ID of the collection.
\n","type":"text/plain"},"type":"any","value":"926489","key":"collection_id"}]}},"response":[{"id":"8b7d5d02-3cd8-4625-8563-ead0653c6f0a","name":"[200] Returns an array of items in the collection.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/collections/:collection_id","protocol":"https","host":["api.box.com"],"path":["2.0","collections",":collection_id"],"variable":[{"id":"f9958b3c-90b9-4491-bd7e-5cf83c56d116","key":"collection_id","value":"926489","description":"The ID of the collection."}]},"description":"Retrieves a collection by its ID.\n\nhttps://developer.box.com/reference/get-collections-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"collection\",\n \"name\": \"Favorites\",\n \"collection_type\": \"favorites\"\n}"}],"_postman_id":"3f3d868c-6cc1-4adb-946d-d534a570ced0"}],"id":"f80731af-b5f7-47de-b092-8cc166005e95","_postman_id":"f80731af-b5f7-47de-b092-8cc166005e95","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves a list of comments for a file.
\nhttps://developer.box.com/reference/get-files-id-comments
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","comments"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"The offset of the item at which to begin the response.
\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.
\n","type":"text/plain"},"key":"offset","value":"1000"}],"variable":[{"id":"8a314b0d-c905-4267-a4f2-a7d6f6bb347e","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
Retrieves the message and metadata for a specific comment, as well
\nhttps://developer.box.com/reference/get-comments-id
\n","urlObject":{"protocol":"https","path":["2.0","comments",":comment_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"02d56ba0-d2d1-40e2-86b2-ac8c6c0b4062","description":{"content":"The ID of the comment.
\n","type":"text/plain"},"type":"any","value":"12345","key":"comment_id"}]}},"response":[{"id":"5fcffcce-7a9f-445a-b93b-7b5f9b83ca37","name":"[200] Returns a full comment object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/comments/:comment_id","protocol":"https","host":["api.box.com"],"path":["2.0","comments",":comment_id"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}],"variable":[{"id":"02d56ba0-d2d1-40e2-86b2-ac8c6c0b4062","key":"comment_id","value":"12345","description":"The ID of the comment."}]},"description":"Retrieves the message and metadata for a specific comment, as well\n\nhttps://developer.box.com/reference/get-comments-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"comment\",\n \"is_reply_comment\": true,\n \"message\": \"@Aaron Levie these tigers are cool!\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"item\": {\n \"id\": \"11446498\",\n \"type\": \"file\"\n },\n \"tagged_message\": \"@[1234567:Aaron Levie] these tigers are cool!\"\n}"}],"_postman_id":"5264d197-d025-4fa4-8957-3f92deb92b14"},{"name":"Create comment","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"7a2a351e-fca4-4683-b69d-8496d6da80bd","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Adds a comment by the user to a specific file, or
\nhttps://developer.box.com/reference/post-comments
\n","urlObject":{"protocol":"https","path":["2.0","comments"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[]}},"response":[{"id":"631eec68-647d-48ee-ba94-d41499d54689","name":"[201] Returns the newly created comment object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message\": \"Review completed!\",\n \"tagged_message\": \"@[1234:John] Review completed!\",\n \"item\": {\n \"id\": \"11446498\",\n \"type\": \"file\"\n }\n}"},"url":{"raw":"https://api.box.com/2.0/comments","protocol":"https","host":["api.box.com"],"path":["2.0","comments"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}]},"description":"Adds a comment by the user to a specific file, or\n\nhttps://developer.box.com/reference/post-comments"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"comment\",\n \"is_reply_comment\": true,\n \"message\": \"@Aaron Levie these tigers are cool!\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"item\": {\n \"id\": \"11446498\",\n \"type\": \"file\"\n },\n \"tagged_message\": \"@[1234567:Aaron Levie] these tigers are cool!\"\n}"}],"_postman_id":"7a2a351e-fca4-4683-b69d-8496d6da80bd"},{"name":"Update comment","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"b983a98e-2233-4ed1-bbee-7fb85f8d0582","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Update the message of a comment.
\nhttps://developer.box.com/reference/put-comments-id
\n","urlObject":{"protocol":"https","path":["2.0","comments",":comment_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"4c7f814b-43ff-4a13-acd1-1cd5590c141b","description":{"content":"The ID of the comment.
\n","type":"text/plain"},"type":"any","value":"12345","key":"comment_id"}]}},"response":[{"id":"f2b18bb7-7c61-43ef-a6fd-9a6a0d536a85","name":"[200] Returns the updated comment object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message\": \"Review completed!\"\n}"},"url":{"raw":"https://api.box.com/2.0/comments/:comment_id","protocol":"https","host":["api.box.com"],"path":["2.0","comments",":comment_id"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}],"variable":[{"id":"4c7f814b-43ff-4a13-acd1-1cd5590c141b","key":"comment_id","value":"12345","description":"The ID of the comment."}]},"description":"Update the message of a comment.\n\nhttps://developer.box.com/reference/put-comments-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"comment\",\n \"is_reply_comment\": true,\n \"message\": \"@Aaron Levie these tigers are cool!\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"item\": {\n \"id\": \"11446498\",\n \"type\": \"file\"\n },\n \"tagged_message\": \"@[1234567:Aaron Levie] these tigers are cool!\"\n}"}],"_postman_id":"b983a98e-2233-4ed1-bbee-7fb85f8d0582"},{"name":"Remove comment","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"07f025b9-fbab-495a-9954-3d4692247323","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Permanently deletes a comment.
\nhttps://developer.box.com/reference/delete-comments-id
\n","urlObject":{"protocol":"https","path":["2.0","comments",":comment_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"c5db651d-40ba-455f-bae8-71fc6f8e5a1b","description":{"content":"The ID of the comment.
\n","type":"text/plain"},"type":"any","value":"12345","key":"comment_id"}]}},"response":[{"id":"d117d102-5796-45a8-a69c-d9c751134049","name":"[204] Returns an empty response when the comment has been deleted.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/comments/:comment_id","protocol":"https","host":["api.box.com"],"path":["2.0","comments",":comment_id"],"variable":[{"id":"c5db651d-40ba-455f-bae8-71fc6f8e5a1b","key":"comment_id","value":"12345","description":"The ID of the comment."}]},"description":"Permanently deletes a comment.\n\nhttps://developer.box.com/reference/delete-comments-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"07f025b9-fbab-495a-9954-3d4692247323"}],"id":"40d6aad8-74c9-48d9-9db0-9b9a843c5f2a","_postman_id":"40d6aad8-74c9-48d9-9db0-9b9a843c5f2a","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves information about an individual device pin.
\nhttps://developer.box.com/reference/get-device-pinners-id
\n","urlObject":{"protocol":"https","path":["2.0","device_pinners",":device_pinner_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"07a38d4d-d0a6-42c3-8006-5ac349a2ebe9","description":{"content":"The ID of the device pin.
\n","type":"text/plain"},"type":"any","value":"2324234","key":"device_pinner_id"}]}},"response":[{"id":"dff86a75-bfde-4f1c-b12c-e4580aa17e72","name":"[200] Returns information about a single device pin.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/device_pinners/:device_pinner_id","protocol":"https","host":["api.box.com"],"path":["2.0","device_pinners",":device_pinner_id"],"variable":[{"id":"07a38d4d-d0a6-42c3-8006-5ac349a2ebe9","key":"device_pinner_id","value":"2324234","description":"The ID of the device pin."}]},"description":"Retrieves information about an individual device pin.\n\nhttps://developer.box.com/reference/get-device-pinners-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"device_pinner\",\n \"owned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"product_name\": \"iPad\"\n}"}],"_postman_id":"4a48d000-9876-49e7-8f3b-60b96c5fa5b2"},{"name":"List enterprise device pins","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"12642a5b-06ce-4124-abe1-e2b8f587008b","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves all the device pins within an enterprise.
\nhttps://developer.box.com/reference/get-enterprises-id-device-pinners
\n","urlObject":{"protocol":"https","path":["2.0","enterprises",":enterprise_id","device_pinners"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"The direction to sort results in. This can be either in alphabetical ascending\n(ASC) or descending (DESC) order.
The ID of the enterprise.
\n","type":"text/plain"},"type":"any","value":"3442311","key":"enterprise_id"}]}},"response":[{"id":"ed2f86d9-3898-48ce-8625-04d6b9d030f6","name":"[200] Returns a list of device pins for a given enterprise.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/enterprises/:enterprise_id/device_pinners","protocol":"https","host":["api.box.com"],"path":["2.0","enterprises",":enterprise_id","device_pinners"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"direction","value":"ASC","description":"The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.","disabled":true}],"variable":[{"id":"da749fa0-dda4-42e2-b627-b22c826fe2ab","key":"enterprise_id","value":"3442311","description":"The ID of the enterprise."}]},"description":"Retrieves all the device pins within an enterprise.\n\nhttps://developer.box.com/reference/get-enterprises-id-device-pinners"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"id\": \"11446498\",\n \"type\": \"device_pinner\",\n \"owned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"product_name\": \"iPad\"\n }\n ],\n \"limit\": 200,\n \"next_marker\": 3000,\n \"order\": [\n {\n \"by\": \"id\",\n \"direction\": \"asc\"\n }\n ]\n}"}],"_postman_id":"12642a5b-06ce-4124-abe1-e2b8f587008b"},{"name":"Remove device pin","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"ad1cb39f-6aa0-47b3-9c57-20e62ea8b764","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Deletes an individual device pin.
\nhttps://developer.box.com/reference/delete-device-pinners-id
\n","urlObject":{"protocol":"https","path":["2.0","device_pinners",":device_pinner_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"f301a181-5e21-49d7-b753-67617924f78b","description":{"content":"The ID of the device pin.
\n","type":"text/plain"},"type":"any","value":"2324234","key":"device_pinner_id"}]}},"response":[{"id":"681960b2-1504-4376-9264-21aafa2d6fc4","name":"[204] Returns an empty response when the pin has been deleted.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/device_pinners/:device_pinner_id","protocol":"https","host":["api.box.com"],"path":["2.0","device_pinners",":device_pinner_id"],"variable":[{"id":"f301a181-5e21-49d7-b753-67617924f78b","key":"device_pinner_id","value":"2324234","description":"The ID of the device pin."}]},"description":"Deletes an individual device pin.\n\nhttps://developer.box.com/reference/delete-device-pinners-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ad1cb39f-6aa0-47b3-9c57-20e62ea8b764"}],"id":"1f744aa0-ec28-42e6-9fdb-25fc73a1a798","_postman_id":"1f744aa0-ec28-42e6-9fdb-25fc73a1a798","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Returns a list of users who have been exempt from the collaboration
\nhttps://developer.box.com/reference/get-collaboration-whitelist-exempt-targets
\n","urlObject":{"protocol":"https","path":["2.0","collaboration_whitelist_exempt_targets"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"3925214b-c333-4d5e-a947-c0ff1a9d9b20","name":"[200] Returns a collection of user exemptions.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/collaboration_whitelist_exempt_targets","protocol":"https","host":["api.box.com"],"path":["2.0","collaboration_whitelist_exempt_targets"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Returns a list of users who have been exempt from the collaboration\n\nhttps://developer.box.com/reference/get-collaboration-whitelist-exempt-targets"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"11446498\",\n \"type\": \"collaboration_whitelist_exempt_target\",\n \"enterprise\": {\n \"id\": \"11446498\",\n \"type\": \"enterprise\",\n \"name\": \"Acme Inc.\"\n },\n \"user\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ]\n}"}],"_postman_id":"1b289781-259a-4ea8-a016-bc8211bad972"},{"name":"Get user exempt from collaboration domain restrictions","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"40daa0f8-554c-4f84-b667-188a7d7fd6f2","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Returns a users who has been exempt from the collaboration
\nhttps://developer.box.com/reference/get-collaboration-whitelist-exempt-targets-id
\n","urlObject":{"protocol":"https","path":["2.0","collaboration_whitelist_exempt_targets",":collaboration_whitelist_exempt_target_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"cb2385d8-9b95-4422-8fc4-626aec8d6463","description":{"content":"The ID of the exemption to the list.
\n","type":"text/plain"},"type":"any","value":"984923","key":"collaboration_whitelist_exempt_target_id"}]}},"response":[{"id":"5af829f2-2676-41db-8141-8436e44a463d","name":"[200] Returns the user's exempted from the list of collaboration domains.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id","protocol":"https","host":["api.box.com"],"path":["2.0","collaboration_whitelist_exempt_targets",":collaboration_whitelist_exempt_target_id"],"variable":[{"id":"cb2385d8-9b95-4422-8fc4-626aec8d6463","key":"collaboration_whitelist_exempt_target_id","value":"984923","description":"The ID of the exemption to the list."}]},"description":"Returns a users who has been exempt from the collaboration\n\nhttps://developer.box.com/reference/get-collaboration-whitelist-exempt-targets-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"collaboration_whitelist_exempt_target\",\n \"enterprise\": {\n \"id\": \"11446498\",\n \"type\": \"enterprise\",\n \"name\": \"Acme Inc.\"\n },\n \"user\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n}"}],"_postman_id":"40daa0f8-554c-4f84-b667-188a7d7fd6f2"},{"name":"Create user exemption from collaboration domain restrictions","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"382bd420-a2dc-4296-bc94-2edba8d959ec","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Exempts a user from the restrictions set out by the allowed list of domains
\nhttps://developer.box.com/reference/post-collaboration-whitelist-exempt-targets
\n","urlObject":{"protocol":"https","path":["2.0","collaboration_whitelist_exempt_targets"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"ae3c8cf4-2e17-4e53-b1a5-c7cbd8b4c08f","name":"[200] Returns a new exemption entry.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"id\": \"23522323\"\n }\n}"},"url":"https://api.box.com/2.0/collaboration_whitelist_exempt_targets","description":"Exempts a user from the restrictions set out by the allowed list of domains\n\nhttps://developer.box.com/reference/post-collaboration-whitelist-exempt-targets"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"collaboration_whitelist_exempt_target\",\n \"enterprise\": {\n \"id\": \"11446498\",\n \"type\": \"enterprise\",\n \"name\": \"Acme Inc.\"\n },\n \"user\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n}"}],"_postman_id":"382bd420-a2dc-4296-bc94-2edba8d959ec"},{"name":"Remove user from list of users exempt from domain restrictions","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"ccc24c2b-bc21-4338-9661-a44e1142276f","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Removes a user's exemption from the restrictions set out by the allowed list
\nhttps://developer.box.com/reference/delete-collaboration-whitelist-exempt-targets-id
\n","urlObject":{"protocol":"https","path":["2.0","collaboration_whitelist_exempt_targets",":collaboration_whitelist_exempt_target_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"74419fa5-00f5-44ec-b5ea-b809b61c9332","description":{"content":"The ID of the exemption to the list.
\n","type":"text/plain"},"type":"any","value":"984923","key":"collaboration_whitelist_exempt_target_id"}]}},"response":[{"id":"bb4f9589-6062-4ea9-a3e6-d72c7738ece5","name":"[204] A blank response is returned if the exemption was","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id","protocol":"https","host":["api.box.com"],"path":["2.0","collaboration_whitelist_exempt_targets",":collaboration_whitelist_exempt_target_id"],"variable":[{"id":"74419fa5-00f5-44ec-b5ea-b809b61c9332","key":"collaboration_whitelist_exempt_target_id","value":"984923","description":"The ID of the exemption to the list."}]},"description":"Removes a user's exemption from the restrictions set out by the allowed list\n\nhttps://developer.box.com/reference/delete-collaboration-whitelist-exempt-targets-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ccc24c2b-bc21-4338-9661-a44e1142276f"}],"id":"cd0ee92b-20cc-4ff7-86ed-6d7ac816c77c","_postman_id":"cd0ee92b-20cc-4ff7-86ed-6d7ac816c77c","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Returns the list domains that have been deemed safe to create collaborations
\nhttps://developer.box.com/reference/get-collaboration-whitelist-entries
\n","urlObject":{"protocol":"https","path":["2.0","collaboration_whitelist_entries"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"f503e25c-ed76-437d-9345-174e802a779e","name":"[200] Returns a collection of domains that are allowed for collaboration.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/collaboration_whitelist_entries","protocol":"https","host":["api.box.com"],"path":["2.0","collaboration_whitelist_entries"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Returns the list domains that have been deemed safe to create collaborations\n\nhttps://developer.box.com/reference/get-collaboration-whitelist-entries"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"11446498\",\n \"type\": \"collaboration_whitelist_entry\",\n \"domain\": \"example.com\",\n \"direction\": \"both\",\n \"enterprise\": {\n \"id\": \"11446498\",\n \"type\": \"enterprise\",\n \"name\": \"Acme Inc.\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ]\n}"}],"_postman_id":"6927a083-cc8d-4297-9b13-3e3dc571edac"},{"name":"Get allowed collaboration domain","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"4e2ba501-02f2-455f-a176-7332bc459095","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Returns a domain that has been deemed safe to create collaborations
\nhttps://developer.box.com/reference/get-collaboration-whitelist-entries-id
\n","urlObject":{"protocol":"https","path":["2.0","collaboration_whitelist_entries",":collaboration_whitelist_entry_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"e6182c4b-95fd-425f-85e9-884913b9f7ae","description":{"content":"The ID of the entry in the list.
\n","type":"text/plain"},"type":"any","value":"213123","key":"collaboration_whitelist_entry_id"}]}},"response":[{"id":"2e79b884-6588-4150-aa1c-d72d77e55234","name":"[200] Returns an entry on the list of allowed domains.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/collaboration_whitelist_entries/:collaboration_whitelist_entry_id","protocol":"https","host":["api.box.com"],"path":["2.0","collaboration_whitelist_entries",":collaboration_whitelist_entry_id"],"variable":[{"id":"e6182c4b-95fd-425f-85e9-884913b9f7ae","key":"collaboration_whitelist_entry_id","value":"213123","description":"The ID of the entry in the list."}]},"description":"Returns a domain that has been deemed safe to create collaborations\n\nhttps://developer.box.com/reference/get-collaboration-whitelist-entries-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"collaboration_whitelist_entry\",\n \"domain\": \"example.com\",\n \"direction\": \"both\",\n \"enterprise\": {\n \"id\": \"11446498\",\n \"type\": \"enterprise\",\n \"name\": \"Acme Inc.\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\"\n}"}],"_postman_id":"4e2ba501-02f2-455f-a176-7332bc459095"},{"name":"Add domain to list of allowed collaboration domains","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"761e00a6-c2ff-49fb-a85d-e4b2ebf4e7b3","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates a new entry in the list of allowed domains to allow
\nhttps://developer.box.com/reference/post-collaboration-whitelist-entries
\n","urlObject":{"protocol":"https","path":["2.0","collaboration_whitelist_entries"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"1836121f-76e8-42b7-ae60-6d7edb811a57","name":"[200] Returns a new entry on the list of allowed domains.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"domain\": \"example.com\",\n \"direction\": \"inbound\"\n}"},"url":"https://api.box.com/2.0/collaboration_whitelist_entries","description":"Creates a new entry in the list of allowed domains to allow\n\nhttps://developer.box.com/reference/post-collaboration-whitelist-entries"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"collaboration_whitelist_entry\",\n \"domain\": \"example.com\",\n \"direction\": \"both\",\n \"enterprise\": {\n \"id\": \"11446498\",\n \"type\": \"enterprise\",\n \"name\": \"Acme Inc.\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\"\n}"}],"_postman_id":"761e00a6-c2ff-49fb-a85d-e4b2ebf4e7b3"},{"name":"Remove domain from list of allowed collaboration domains","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"4cb231f6-4d27-4fea-829e-b902bd1646a5","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Removes a domain from the list of domains that have been deemed safe to create
\nhttps://developer.box.com/reference/delete-collaboration-whitelist-entries-id
\n","urlObject":{"protocol":"https","path":["2.0","collaboration_whitelist_entries",":collaboration_whitelist_entry_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"e3348998-26f4-4292-9d21-490b108318e8","description":{"content":"The ID of the entry in the list.
\n","type":"text/plain"},"type":"any","value":"213123","key":"collaboration_whitelist_entry_id"}]}},"response":[{"id":"7f711f35-0a89-4547-806d-4ba0df5252f4","name":"[204] A blank response is returned if the entry was","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/collaboration_whitelist_entries/:collaboration_whitelist_entry_id","protocol":"https","host":["api.box.com"],"path":["2.0","collaboration_whitelist_entries",":collaboration_whitelist_entry_id"],"variable":[{"id":"e3348998-26f4-4292-9d21-490b108318e8","key":"collaboration_whitelist_entry_id","value":"213123","description":"The ID of the entry in the list."}]},"description":"Removes a domain from the list of domains that have been deemed safe to create\n\nhttps://developer.box.com/reference/delete-collaboration-whitelist-entries-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4cb231f6-4d27-4fea-829e-b902bd1646a5"}],"id":"ba0694f6-27e5-4537-a71f-2ddb0feecc19","_postman_id":"ba0694f6-27e5-4537-a71f-2ddb0feecc19","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Returns the contents of a file in binary format.
\nhttps://developer.box.com/reference/get-files-id-content
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","content"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"The file version to download.
\n","type":"text/plain"},"key":"version","value":"4"},{"disabled":true,"description":{"content":"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.\nWhen 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.
\n","type":"text/plain"},"key":"access_token","value":"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ"}],"variable":[{"id":"f699b0b4-a86a-458a-be9f-da2f8a1a202d","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
Retrieves all email aliases for a user. The collection
\nhttps://developer.box.com/reference/get-users-id-email-aliases
\n","urlObject":{"protocol":"https","path":["2.0","users",":user_id","email_aliases"],"host":["api.box.com"],"query":[],"variable":[{"id":"7a5369cd-10db-4176-8839-d40467d22b72","description":{"content":"The ID of the user.
\n","type":"text/plain"},"type":"any","value":"12345","key":"user_id"}]}},"response":[{"id":"73446ada-8050-46ce-9929-028d7a347eda","name":"[200] Returns a collection of email aliases.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/users/:user_id/email_aliases","protocol":"https","host":["api.box.com"],"path":["2.0","users",":user_id","email_aliases"],"variable":[{"id":"7a5369cd-10db-4176-8839-d40467d22b72","key":"user_id","value":"12345","description":"The ID of the user."}]},"description":"Retrieves all email aliases for a user. The collection\n\nhttps://developer.box.com/reference/get-users-id-email-aliases"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 5000,\n \"entries\": [\n {\n \"id\": \"11446498\",\n \"type\": \"email_alias\",\n \"email\": \"alias@example.com\",\n \"is_confirmed\": true\n }\n ]\n}"}],"_postman_id":"f9693ff5-267f-463c-9919-004a7f850ef9"},{"name":"Create email alias","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"19885a60-8985-4609-8e4e-0bd0387df39f","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Adds a new email alias to a user account..
\nhttps://developer.box.com/reference/post-users-id-email-aliases
\n","urlObject":{"protocol":"https","path":["2.0","users",":user_id","email_aliases"],"host":["api.box.com"],"query":[],"variable":[{"id":"852c6e46-639c-4b96-8d36-5ff6ff2df670","description":{"content":"The ID of the user.
\n","type":"text/plain"},"type":"any","value":"12345","key":"user_id"}]}},"response":[{"id":"a4ec269b-b220-4585-b26f-b2d1f53a3d95","name":"[201] Returns the newly created email alias object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"alias@example.com\"\n}"},"url":{"raw":"https://api.box.com/2.0/users/:user_id/email_aliases","protocol":"https","host":["api.box.com"],"path":["2.0","users",":user_id","email_aliases"],"variable":[{"id":"852c6e46-639c-4b96-8d36-5ff6ff2df670","key":"user_id","value":"12345","description":"The ID of the user."}]},"description":"Adds a new email alias to a user account..\n\nhttps://developer.box.com/reference/post-users-id-email-aliases"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"email_alias\",\n \"email\": \"alias@example.com\",\n \"is_confirmed\": true\n}"}],"_postman_id":"19885a60-8985-4609-8e4e-0bd0387df39f"},{"name":"Remove email alias","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"0ba31cec-a0d4-4ebc-b5a5-0d5596178339","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Removes an email alias from a user.
\nhttps://developer.box.com/reference/delete-users-id-email-aliases-id
\n","urlObject":{"protocol":"https","path":["2.0","users",":user_id","email_aliases",":email_alias_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"8814276b-f876-42ad-bfb6-1c4b938d8163","description":{"content":"The ID of the user.
\n","type":"text/plain"},"type":"any","value":"12345","key":"user_id"},{"id":"a6256322-4705-4a22-afba-14207180e681","description":{"content":"The ID of the email alias.
\n","type":"text/plain"},"type":"any","value":"23432","key":"email_alias_id"}]}},"response":[{"id":"f5e9feb4-dd6b-4cb5-8c8c-3535a4ba2766","name":"[204] Removes the alias and returns an empty response.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/users/:user_id/email_aliases/:email_alias_id","protocol":"https","host":["api.box.com"],"path":["2.0","users",":user_id","email_aliases",":email_alias_id"],"variable":[{"id":"8814276b-f876-42ad-bfb6-1c4b938d8163","key":"user_id","value":"12345","description":"The ID of the user."},{"id":"a6256322-4705-4a22-afba-14207180e681","key":"email_alias_id","value":"23432","description":"The ID of the email alias."}]},"description":"Removes an email alias from a user.\n\nhttps://developer.box.com/reference/delete-users-id-email-aliases-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0ba31cec-a0d4-4ebc-b5a5-0d5596178339"}],"id":"d6282ec8-2ab0-44eb-8445-ce5d3c20bf0a","_postman_id":"d6282ec8-2ab0-44eb-8445-ce5d3c20bf0a","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"}],"url":"https://api.box.com/2.0/enterprise_configurations/:enterprise_id?categories=security,content_and_sharing,user_settings,shield","description":"Retrieves the configuration for an enterprise.
\nhttps://developer.box.com/reference/get-enterprise-configurations-id-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","enterprise_configurations",":enterprise_id"],"host":["api.box.com"],"query":[{"description":{"content":"A comma-separated list of the enterprise configuration categories.\nAllowed values: security, content_and_sharing, user_settings, shield.
The ID of the enterprise.
\n","type":"text/plain"},"type":"any","value":"3442311","key":"enterprise_id"}]}},"response":[{"id":"27cfd54d-1744-4073-bd1f-a366ee9fbb8c","name":"[200] Returns the enterprise configuration.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[{"key":"box-version","value":"2025.0","description":"Version header."}],"url":{"raw":"https://api.box.com/2.0/enterprise_configurations/:enterprise_id?categories=security,content_and_sharing,user_settings,shield","protocol":"https","host":["api.box.com"],"path":["2.0","enterprise_configurations",":enterprise_id"],"query":[{"key":"categories","value":"security,content_and_sharing,user_settings,shield","description":"A comma-separated list of the enterprise configuration categories.\nAllowed values: `security`, `content_and_sharing`, `user_settings`, `shield`."}],"variable":[{"id":"1f29e013-238b-4aca-b2b8-313cd467f573","key":"enterprise_id","value":"3442311","description":"The ID of the enterprise."}]},"description":"Retrieves the configuration for an enterprise.\n\nhttps://developer.box.com/reference/get-enterprise-configurations-id-v2025.0"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"enterprise_configuration\",\n \"security\": {\n \"is_managed_user_signup_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_managed_user_signup_notification_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_managed_user_signup_corporate_email_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_new_user_notification_daily_digest_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_managed_user_email_change_disabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_multi_factor_auth_required\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_weak_password_prevention_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_password_leak_detection_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"last_password_reset_at\": {\n \"is_used\": true,\n \"value\": \"2012-12-12T10:53:43-08:00\"\n },\n \"is_password_request_notification_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_password_change_notification_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_strong_password_for_ext_collab_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_managed_user_migration_disabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"join_link\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"join_url\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"failed_login_attempts_to_trigger_admin_notification\": {\n \"is_used\": true,\n \"value\": 1234\n },\n \"password_min_length\": {\n \"is_used\": true,\n \"value\": 1234\n },\n \"password_min_uppercase_characters\": {\n \"is_used\": true,\n \"value\": 1234\n },\n \"password_min_numeric_characters\": {\n \"is_used\": true,\n \"value\": 1234\n },\n \"password_min_special_characters\": {\n \"is_used\": true,\n \"value\": 1234\n },\n \"password_reset_frequency\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"previous_password_reuse_limit\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"session_duration\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"external_collab_multi_factor_auth_settings\": {\n \"is_used\": true,\n \"value\": {\n \"denylist_domains\": [\n \"example.com\"\n ],\n \"denylist_emails\": [\n \"spam@example.com\"\n ],\n \"allowlist_domains\": [\n \"example.com\"\n ],\n \"allowlist_emails\": [\n \"mail@example.com\"\n ],\n \"state\": \"enabled\",\n \"scheduled_status\": \"inprogress\",\n \"scheduled_at\": \"2012-12-12T10:53:43-08:00\",\n \"factor_type_settings\": \"totp\"\n }\n },\n \"keysafe\": {\n \"is_used\": true,\n \"value\": {\n \"keysafe_enabled\": true,\n \"cloud_provider\": \"\",\n \"key_id\": \"1234\",\n \"account_id\": \"1234\",\n \"location_id\": \"1234\",\n \"project_id\": \"1234\",\n \"keyring_id\": \"1234\"\n }\n },\n \"is_custom_session_duration_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"custom_session_duration_value\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"custom_session_duration_groups\": {\n \"is_used\": true,\n \"value\": [\n {\n \"id\": \"1234\",\n \"name\": \"Group Name\"\n }\n ]\n },\n \"multi_factor_auth_type\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"enforced_mfa_frequency\": {\n \"is_used\": true,\n \"value\": {\n \"days\": 30,\n \"hours\": 24\n }\n }\n },\n \"content_and_sharing\": {\n \"enterprise_feature_settings\": [\n {\n \"is_used\": true,\n \"value\": {\n \"id\": \"eyJlbnRlcnByaXNlSWQiOiIxMTExNDQyNzY3IiwiZmVhdHVyZUlkIjoiY2FudmFzIn0=\",\n \"feature\": {\n \"id\": \"canvas\"\n },\n \"state\": \"enabled\",\n \"can_configure\": true,\n \"is_configured\": true,\n \"allowlist\": [\n {\n \"type\": \"user\",\n \"id\": \"12345\"\n }\n ],\n \"denylist\": [\n {\n \"type\": \"user\",\n \"id\": \"12345\"\n }\n ]\n }\n }\n ],\n \"sharing_item_type\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"shared_link_company_definition\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"shared_link_access\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"shared_link_default_access\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"shared_link_default_permissions_selected\": {\n \"is_used\": true,\n \"value\": {\n \"shared_links_option\": \"settings_shared_link_preview\",\n \"default_shared_link_type\": \"settings_default_shared_link_preview\",\n \"notes_shared_link_option\": \"settings_notes_option_to_edit\",\n \"default_notes_shared_link_type\": \"settings_default_notes_shared_link_to_edit\"\n }\n },\n \"is_open_custom_urls_disabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_custom_domain_hidden_in_shared_link\": {\n \"is_used\": true,\n \"value\": true\n },\n \"collaboration_permissions\": {\n \"is_used\": true,\n \"value\": {\n \"is_co_owner_role_enabled\": true,\n \"is_editor_role_enabled\": true,\n \"is_previewer_role_enabled\": true,\n \"is_previewer_uploader_role_enabled\": true,\n \"is_uploader_role_enabled\": true,\n \"is_viewer_role_enabled\": true,\n \"is_viewer_uploader_role_enabled\": true\n }\n },\n \"default_collaboration_role\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"is_invite_privilege_restricted\": {\n \"is_used\": true,\n \"value\": true\n },\n \"collaboration_restrictions\": {\n \"is_used\": true,\n \"value\": [\n \"internal\"\n ]\n },\n \"is_collaborator_invite_links_disabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_invite_group_collaborator_disabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_ownership_transfer_restricted\": {\n \"is_used\": true,\n \"value\": true\n },\n \"external_collaboration_status\": {\n \"is_used\": true,\n \"value\": \"enable_external_collaboration\"\n },\n \"external_collaboration_allowlist_users\": {\n \"is_used\": true,\n \"value\": [\n {\n \"id\": 1234,\n \"name\": \"John Doe\",\n \"email\": \"johndoe@box.com\"\n }\n ]\n },\n \"is_watermarking_enterprise_feature_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_root_content_creation_restricted\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_tag_creation_restricted\": {\n \"is_used\": true,\n \"value\": true\n },\n \"tag_creation_restriction\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"is_email_uploads_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_custom_settings_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_forms_login_required\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_forms_branding_default_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_cc_free_trial_active\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_file_request_editors_allowed\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_file_request_branding_default_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_file_request_login_required\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_shared_links_expiration_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"shared_links_expiration_days\": {\n \"is_used\": true,\n \"value\": 1234\n },\n \"is_public_shared_links_expiration_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"public_shared_links_expiration_days\": {\n \"is_used\": true,\n \"value\": 1234\n },\n \"shared_expiration_target\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"is_shared_links_expiration_notification_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"shared_links_expiration_notification_days\": {\n \"is_used\": true,\n \"value\": 1234\n },\n \"is_shared_links_expiration_notification_prevented\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_auto_delete_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"auto_delete_days\": {\n \"is_used\": true,\n \"value\": 1234\n },\n \"is_auto_delete_expiration_modification_prevented\": {\n \"is_used\": true,\n \"value\": true\n },\n \"auto_delete_target\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"is_collaboration_expiration_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"collaboration_expiration_days\": {\n \"is_used\": true,\n \"value\": 1234\n },\n \"is_collaboration_expiration_modification_prevented\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_collaboration_expiration_notification_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"collaboration_expiration_target\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"trash_auto_clear_time\": {\n \"is_used\": true,\n \"value\": 1234\n },\n \"permanent_deletion_access\": {\n \"is_used\": true,\n \"value\": \"value of configuration\"\n },\n \"permanent_deletion_allowlist_users\": {\n \"is_used\": true,\n \"value\": [\n {\n \"id\": 1234,\n \"name\": \"John Doe\",\n \"email\": \"johndoe@box.com\"\n }\n ]\n }\n },\n \"user_settings\": {\n \"enterprise_feature_settings\": [\n {\n \"is_used\": true,\n \"value\": {\n \"id\": \"eyJlbnRlcnByaXNlSWQiOiIxMTExNDQyNzY3IiwiZmVhdHVyZUlkIjoiY2FudmFzIn0=\",\n \"feature\": {\n \"id\": \"canvas\"\n },\n \"state\": \"enabled\",\n \"can_configure\": true,\n \"is_configured\": true,\n \"allowlist\": [\n {\n \"type\": \"user\",\n \"id\": \"12345\"\n }\n ],\n \"denylist\": [\n {\n \"type\": \"user\",\n \"id\": \"12345\"\n }\n ]\n }\n }\n ],\n \"user_invites_expiration_time_frame\": {\n \"is_used\": true,\n \"value\": \"7 days\"\n },\n \"is_username_change_restricted\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_box_sync_restricted_for_new_users\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_view_all_users_enabled_for_new_users\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_device_limit_exemption_enabled_for_new_users\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_external_collaboration_restricted_for_new_users\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_unlimited_storage_enabled_for_new_users\": {\n \"is_used\": true,\n \"value\": true\n },\n \"new_user_default_storage_limit\": {\n \"is_used\": true,\n \"value\": 1234\n },\n \"new_user_default_timezone\": {\n \"is_used\": true,\n \"value\": \"GMT-05:00 America\\\\/Chicago CDT\"\n },\n \"new_user_default_language\": {\n \"is_used\": true,\n \"value\": \"English (US)\"\n },\n \"is_enterprise_sso_required\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_enterprise_sso_in_testing\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_sso_auto_add_groups_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_sso_auto_add_user_to_groups_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"is_sso_auto_remove_user_from_groups_enabled\": {\n \"is_used\": true,\n \"value\": true\n },\n \"user_tracking_codes\": {\n \"is_used\": true,\n \"value\": [\n {\n \"id\": 1234,\n \"name\": \"Employee ID\"\n }\n ]\n },\n \"number_of_user_tracking_codes_remaining\": {\n \"is_used\": true,\n \"value\": 1234\n },\n \"is_instant_login_restricted\": {\n \"is_used\": true,\n \"value\": true\n }\n },\n \"shield\": {\n \"shield_rules\": [\n {\n \"id\": \"1234567890\",\n \"type\": \"shield_rule\",\n \"rule_category\": \"Malicious Content\",\n \"name\": \"Block malicious files\",\n \"description\": \"Blocks files identified as malicious content\",\n \"priority\": \"high\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ]\n }\n}"}],"_postman_id":"96152325-2a8b-4409-b2fa-231e1f99bd1d"}],"id":"b810ae68-2874-4a63-8622-163805a4624e","_postman_id":"b810ae68-2874-4a63-8622-163805a4624e","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Returns up to a year of past events for a given user
\nhttps://developer.box.com/reference/get-events
\n","urlObject":{"protocol":"https","path":["2.0","events"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the type of events that are returned
\nall returns everything for a user and is the defaultchanges returns events that may cause file tree changes\nsuch as file updates or collaborations.sync is similar to changes but only applies to synced foldersadmin_logs returns all events for an entire enterprise and\nrequires the user making the API call to have admin permissions. This\nstream type is for programmatically pulling from a 1 year history of\nevents across all users within the enterprise and within a\ncreated_after and created_before time frame. The complete history\nof events will be returned in chronological order based on the event\ntime, but latency will be much higher than admin_logs_streaming.admin_logs_streaming returns all events for an entire enterprise and\nrequires the user making the API call to have admin permissions. This\nstream type is for polling for recent events across all users within\nthe enterprise. Latency will be much lower than admin_logs, but\nevents will not be returned in chronological order and may\ncontain duplicates.The location in the event stream to start receiving events from.
\nnow will return an empty list events and\nthe latest stream position for initialization.0 or null will return all events.Limits the number of events returned.
\nNote: Sometimes, the events less than the limit requested can be returned\neven when there may be more events remaining. This is primarily done in\nthe case where a number of events have already been retrieved and these\nretrieved events are returned rather than delaying for an unknown amount\nof time to see if there are any more results.
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"A comma-separated list of events to filter by. This can only be used when\nrequesting the events with a stream_type of admin_logs or\nadming_logs_streaming. For any other stream_type this value will be\nignored.
The lower bound date and time to return events for. This can only be used\nwhen requesting the events with a stream_type of admin_logs. For any\nother stream_type this value will be ignored.
The upper bound date and time to return events for. This can only be used\nwhen requesting the events with a stream_type of admin_logs. For any\nother stream_type this value will be ignored.
Returns a list of real-time servers that can be used for long-polling updates
\nhttps://developer.box.com/reference/options-events
\n","urlObject":{"protocol":"https","path":["2.0","events"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"05a68a82-c433-403b-9d12-568ab4302a8a","name":"[200] Returns a paginated array of servers that can be used","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"OPTIONS","header":[],"url":"https://api.box.com/2.0/events","description":"Returns a list of real-time servers that can be used for long-polling updates\n\nhttps://developer.box.com/reference/options-events"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"chunk_size\": 1,\n \"entries\": [\n {\n \"type\": \"realtime_server\",\n \"url\": \"http://2.realtime.services.box.net/subscribe?channel=cc807c9c4869ffb1c81a&stream_type=all\",\n \"ttl\": \"10\",\n \"max_retries\": \"10\",\n \"retry_timeout\": 610\n }\n ]\n}"}],"_postman_id":"85aed12c-2a51-4289-b4f5-2b8c92f79428"}],"id":"4c60b9c5-c9d2-40cc-874b-5ec42c5f0822","_postman_id":"4c60b9c5-c9d2-40cc-874b-5ec42c5f0822","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Version header.
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"external_users\": [\n {\n \"type\": \"user\",\n \"id\": \"12345\"\n }\n ]\n}"},"url":"https://api.box.com/2.0/external_users/submit_delete_job","description":"Delete external users from current user enterprise. This will remove each
\nhttps://developer.box.com/reference/post-external-users-submit-delete-job-v2025.0
\n","urlObject":{"protocol":"https","path":["2.0","external_users","submit_delete_job"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"5d2cf586-5cea-4e68-86bb-fd5dea07fc8b","name":"[207] Multi-status response containing the result for each external user deletion request.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"external_users\": [\n {\n \"type\": \"user\",\n \"id\": \"12345\"\n }\n ]\n}"},"url":"https://api.box.com/2.0/external_users/submit_delete_job","description":"Delete external users from current user enterprise. This will remove each\n\nhttps://developer.box.com/reference/post-external-users-submit-delete-job-v2025.0"},"status":"Multi-Status","code":207,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"user_id\": \"12345\",\n \"status\": 202,\n \"detail\": \"Deletion request status details. This property is only present when the deletion request is not successful.\"\n }\n ]\n}"},{"id":"ddd89d67-eb3b-4311-9642-ae844d02bd4f","name":"[404] Returns an error if the listed external users are not found, or the authenticated","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"box-version","value":"2025.0","description":"Version header."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"external_users\": [\n {\n \"type\": \"user\",\n \"id\": \"12345\"\n }\n ]\n}"},"url":"https://api.box.com/2.0/external_users/submit_delete_job","description":"Delete external users from current user enterprise. This will remove each\n\nhttps://developer.box.com/reference/post-external-users-submit-delete-job-v2025.0"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"34e1f01d-2942-4fb7-9882-5d83ae991376"}],"id":"16054e58-a166-4502-94da-66260eecf8a3","_postman_id":"16054e58-a166-4502-94da-66260eecf8a3","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves the information about a file request.
\nhttps://developer.box.com/reference/get-file-requests-id
\n","urlObject":{"protocol":"https","path":["2.0","file_requests",":file_request_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"ff0703a9-8786-49d6-a39f-b86154bed236","description":{"content":"The unique identifier that represent a file request.
\nThe ID for any file request can be determined\nby visiting a file request builder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/filerequest/123\nthe file_request_id is 123.
Copies an existing file request that is already present on one folder,
\nhttps://developer.box.com/reference/post-file-requests-id-copy
\n","urlObject":{"protocol":"https","path":["2.0","file_requests",":file_request_id","copy"],"host":["api.box.com"],"query":[],"variable":[{"id":"bed7e012-e2b3-4775-9de5-06c16c570c76","description":{"content":"The unique identifier that represent a file request.
\nThe ID for any file request can be determined\nby visiting a file request builder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/filerequest/123\nthe file_request_id is 123.
Updates a file request. This can be used to activate or
\nhttps://developer.box.com/reference/put-file-requests-id
\n","urlObject":{"protocol":"https","path":["2.0","file_requests",":file_request_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"5fc56863-f605-401c-b5ff-b7e83b3463b9","description":{"content":"The unique identifier that represent a file request.
\nThe ID for any file request can be determined\nby visiting a file request builder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/filerequest/123\nthe file_request_id is 123.
Deletes a file request permanently.
\nhttps://developer.box.com/reference/delete-file-requests-id
\n","urlObject":{"protocol":"https","path":["2.0","file_requests",":file_request_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"faf6bb8f-18eb-4a91-8274-ad66f60d5672","description":{"content":"The unique identifier that represent a file request.
\nThe ID for any file request can be determined\nby visiting a file request builder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/filerequest/123\nthe file_request_id is 123.
Retrieves information about the legal hold policies
\nhttps://developer.box.com/reference/get-file-version-legal-holds-id
\n","urlObject":{"protocol":"https","path":["2.0","file_version_legal_holds",":file_version_legal_hold_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"fdf65316-5900-400d-92c7-64d75340ec2d","description":{"content":"The ID of the file version legal hold.
\n","type":"text/plain"},"type":"any","value":"2348213","key":"file_version_legal_hold_id"}]}},"response":[{"id":"cd1ea9b8-341c-4420-b29d-4adc4bc0e736","name":"[200] Returns the legal hold policy assignments for the file version.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/file_version_legal_holds/:file_version_legal_hold_id","protocol":"https","host":["api.box.com"],"path":["2.0","file_version_legal_holds",":file_version_legal_hold_id"],"variable":[{"id":"fdf65316-5900-400d-92c7-64d75340ec2d","key":"file_version_legal_hold_id","value":"2348213","description":"The ID of the file version legal hold."}]},"description":"Retrieves information about the legal hold policies\n\nhttps://developer.box.com/reference/get-file-version-legal-holds-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"file_version_legal_hold\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n },\n \"file\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n }\n },\n \"legal_hold_policy_assignments\": [\n {\n \"id\": \"11446498\",\n \"type\": \"legal_hold_policy_assignment\",\n \"legal_hold_policy\": {\n \"id\": \"11446498\",\n \"type\": \"legal_hold_policy\"\n },\n \"assigned_to\": {\n \"type\": \"folder\",\n \"id\": \"6564564\"\n },\n \"assigned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"deleted_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ],\n \"deleted_at\": \"2012-12-12T10:53:43-08:00\"\n}"}],"_postman_id":"66736d37-0827-4fb2-b6ca-fb5c9fb17a2f"},{"name":"List file version legal holds","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"78501944-1f7e-4130-9d2f-2e76beeb736b","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Get a list of file versions on legal hold for a legal hold
\nhttps://developer.box.com/reference/get-file-version-legal-holds
\n","urlObject":{"protocol":"https","path":["2.0","file_version_legal_holds"],"host":["api.box.com"],"query":[{"description":{"content":"The ID of the legal hold policy to get the file version legal\nholds for.
\n","type":"text/plain"},"key":"policy_id","value":"133870"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"cd367936-ab03-4f3b-bf37-eb493611caeb","name":"[200] Returns the list of file version legal holds for a specific legal","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/file_version_legal_holds?policy_id=133870","protocol":"https","host":["api.box.com"],"path":["2.0","file_version_legal_holds"],"query":[{"key":"policy_id","value":"133870","description":"The ID of the legal hold policy to get the file version legal\nholds for."},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Get a list of file versions on legal hold for a legal hold\n\nhttps://developer.box.com/reference/get-file-version-legal-holds"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"11446498\",\n \"type\": \"file_version_legal_hold\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n },\n \"file\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n }\n },\n \"legal_hold_policy_assignments\": [\n {\n \"id\": \"11446498\",\n \"type\": \"legal_hold_policy_assignment\",\n \"legal_hold_policy\": {\n \"id\": \"11446498\",\n \"type\": \"legal_hold_policy\"\n },\n \"assigned_to\": {\n \"type\": \"folder\",\n \"id\": \"6564564\"\n },\n \"assigned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"deleted_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ],\n \"deleted_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ]\n}"}],"_postman_id":"78501944-1f7e-4130-9d2f-2e76beeb736b"}],"id":"b83f3e78-8840-434e-af6f-2dc420e8ae78","_postman_id":"b83f3e78-8840-434e-af6f-2dc420e8ae78","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves all file version retentions for the given enterprise.
\nhttps://developer.box.com/reference/get-file-version-retentions
\n","urlObject":{"protocol":"https","path":["2.0","file_version_retentions"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Filters results by files with this ID.
\n","type":"text/plain"},"key":"file_id","value":"43123123"},{"disabled":true,"description":{"content":"Filters results by file versions with this ID.
\n","type":"text/plain"},"key":"file_version_id","value":"1"},{"disabled":true,"description":{"content":"Filters results by the retention policy with this ID.
\n","type":"text/plain"},"key":"policy_id","value":"982312"},{"disabled":true,"description":{"content":"Filters results by the retention policy with this disposition\naction.
\n","type":"text/plain"},"key":"disposition_action","value":"permanently_delete"},{"disabled":true,"description":{"content":"Filters results by files that will have their disposition\ncome into effect before this date.
\n","type":"text/plain"},"key":"disposition_before","value":"2012-12-12T10:53:43-08:00"},{"disabled":true,"description":{"content":"Filters results by files that will have their disposition\ncome into effect after this date.
\n","type":"text/plain"},"key":"disposition_after","value":"2012-12-19T10:34:23-08:00"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
Returns information about a file version retention.
\nhttps://developer.box.com/reference/get-file-version-retentions-id
\n","urlObject":{"protocol":"https","path":["2.0","file_version_retentions",":file_version_retention_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"ed8043aa-91b4-4b36-8b97-31c3b80eed35","description":{"content":"The ID of the file version retention.
\n","type":"text/plain"},"type":"any","value":"3424234","key":"file_version_retention_id"}]}},"response":[{"id":"d2e7577a-d3a5-40b1-80a9-f83d06dcc5cd","name":"[200] Returns a file version retention object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/file_version_retentions/:file_version_retention_id","protocol":"https","host":["api.box.com"],"path":["2.0","file_version_retentions",":file_version_retention_id"],"variable":[{"id":"ed8043aa-91b4-4b36-8b97-31c3b80eed35","key":"file_version_retention_id","value":"3424234","description":"The ID of the file version retention."}]},"description":"Returns information about a file version retention.\n\nhttps://developer.box.com/reference/get-file-version-retentions-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"file_version_retention\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n },\n \"file\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n }\n },\n \"applied_at\": \"2012-12-12T10:53:43-08:00\",\n \"disposition_at\": \"2012-12-12T10:53:43-08:00\",\n \"winning_retention_policy\": {\n \"id\": \"12345\",\n \"type\": \"retention_policy\",\n \"policy_name\": \"Some Policy Name\",\n \"retention_length\": \"365\",\n \"disposition_action\": \"permanently_delete\"\n }\n}"}],"_postman_id":"b2ba7740-6b53-4bb2-97e7-d0552531b970"}],"id":"e27fad64-870a-4687-b884-b3676d0d066d","_postman_id":"e27fad64-870a-4687-b884-b3676d0d066d","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieve a list of the past versions for a file.
\nhttps://developer.box.com/reference/get-files-id-versions
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","versions"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"The offset of the item at which to begin the response.
\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.
\n","type":"text/plain"},"key":"offset","value":"1000"}],"variable":[{"id":"474506f2-fad6-4fff-bd28-cdd541705bae","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
Retrieve a specific version of a file.
\nhttps://developer.box.com/reference/get-files-id-versions-id
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","versions",":file_version_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"a5d619f2-04d7-4a56-a74b-60f3f14eee82","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
The ID of the file version.
\n","type":"text/plain"},"type":"any","value":"1234","key":"file_version_id"}]}},"response":[{"id":"1683c972-ef7b-4f58-857b-8ca58ab06b81","name":"[200] Returns a specific version of a file.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/files/:file_id/versions/:file_version_id","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","versions",":file_version_id"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}],"variable":[{"id":"a5d619f2-04d7-4a56-a74b-60f3f14eee82","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"b0129991-1806-4ad6-9f11-46da2580c92f","key":"file_version_id","value":"1234","description":"The ID of the file version."}]},"description":"Retrieve a specific version of a file.\n\nhttps://developer.box.com/reference/get-files-id-versions-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\",\n \"name\": \"tigers.jpeg\",\n \"size\": 629644,\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"trashed_at\": \"2012-12-12T10:53:43-08:00\",\n \"trashed_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"restored_at\": \"2012-12-12T10:53:43-08:00\",\n \"restored_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"purged_at\": \"2012-12-12T10:53:43-08:00\",\n \"uploader_display_name\": \"Ellis Wiggins\",\n \"version_number\": \"1\"\n}"}],"_postman_id":"90cccaf0-995b-4351-bc6d-66d6ba433057"},{"name":"Promote file version","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"8620fce0-af6c-4dbf-b01b-45d81dfcaaab","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Promote a specific version of a file.
\nhttps://developer.box.com/reference/post-files-id-versions-current
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","versions","current"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"042e3099-36a2-4a05-aad7-d202ac664c71","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
Restores a specific version of a file after it was deleted.
\nhttps://developer.box.com/reference/put-files-id-versions-id
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","versions",":file_version_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"50fc4a84-1006-4bb3-aa6b-8d859a50488f","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
The ID of the file version.
\n","type":"text/plain"},"type":"any","value":"1234","key":"file_version_id"}]}},"response":[{"id":"51af5a33-a9c9-4a7c-9117-662835df641f","name":"[200] Returns a restored file version object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"trashed_at\": null\n}"},"url":{"raw":"https://api.box.com/2.0/files/:file_id/versions/:file_version_id","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","versions",":file_version_id"],"variable":[{"id":"50fc4a84-1006-4bb3-aa6b-8d859a50488f","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"7825dc3d-553e-403c-bb94-e4bb725cd9a6","key":"file_version_id","value":"1234","description":"The ID of the file version."}]},"description":"Restores a specific version of a file after it was deleted.\n\nhttps://developer.box.com/reference/put-files-id-versions-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\",\n \"name\": \"tigers.jpeg\",\n \"size\": 629644,\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"trashed_at\": \"2012-12-12T10:53:43-08:00\",\n \"trashed_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"restored_at\": \"2012-12-12T10:53:43-08:00\",\n \"restored_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"purged_at\": \"2012-12-12T10:53:43-08:00\",\n \"uploader_display_name\": \"Ellis Wiggins\",\n \"version_number\": \"1\"\n}"}],"_postman_id":"3bbb8f01-0bbe-4e29-aa2d-879fe62e4c9f"},{"name":"Remove file version","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"ac70ca25-b082-434f-9c15-fc98d9a1900b","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Move a file version to the trash.
\nhttps://developer.box.com/reference/delete-files-id-versions-id
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","versions",":file_version_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"cb9a1feb-658c-40d8-b58e-6110cf185fc5","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
The ID of the file version.
\n","type":"text/plain"},"type":"any","value":"1234","key":"file_version_id"}]}},"response":[{"id":"879bfba7-3f2e-4059-832b-2d8d8a100dfb","name":"[204] Returns an empty response when the file has been successfully","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[{"key":"if-match","value":"1","description":"Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.","disabled":true}],"url":{"raw":"https://api.box.com/2.0/files/:file_id/versions/:file_version_id","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","versions",":file_version_id"],"variable":[{"id":"cb9a1feb-658c-40d8-b58e-6110cf185fc5","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"21ea6f12-1990-4d89-90a6-14ec0187df99","key":"file_version_id","value":"1234","description":"The ID of the file version."}]},"description":"Move a file version to the trash.\n\nhttps://developer.box.com/reference/delete-files-id-versions-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ac70ca25-b082-434f-9c15-fc98d9a1900b"}],"id":"ab22a815-6361-4596-a858-5e5a3e143cec","_postman_id":"ab22a815-6361-4596-a858-5e5a3e143cec","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves the details about a file.
\nhttps://developer.box.com/reference/get-files-id
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the metadata field as well\nas the scope and key of the template to retrieve, for example\n?fields=metadata.enterprise_12345.contractTemplate.
The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
Retrieves a thumbnail, or smaller image representation, of a file.
\nhttps://developer.box.com/reference/get-files-id-thumbnail-id
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","thumbnail.:extension"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"The minimum height of the thumbnail.
\n","type":"text/plain"},"key":"min_height","value":"32"},{"disabled":true,"description":{"content":"The minimum width of the thumbnail.
\n","type":"text/plain"},"key":"min_width","value":"32"},{"disabled":true,"description":{"content":"The maximum height of the thumbnail.
\n","type":"text/plain"},"key":"max_height","value":"320"},{"disabled":true,"description":{"content":"The maximum width of the thumbnail.
\n","type":"text/plain"},"key":"max_width","value":"320"}],"variable":[{"id":"cc0794f9-a96a-42df-83db-e4bb945ef7c0","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
The file format for the thumbnail.
\n","type":"text/plain"},"type":"any","value":"png","key":"extension"}]}},"response":[{"id":"f6f372e7-3ecf-4e8e-8dfc-167341558bbd","name":"[200] When a thumbnail can be created the thumbnail data will be","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/files/:file_id/thumbnail.:extension","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","thumbnail.:extension"],"query":[{"key":"min_height","value":"32","description":"The minimum height of the thumbnail.","disabled":true},{"key":"min_width","value":"32","description":"The minimum width of the thumbnail.","disabled":true},{"key":"max_height","value":"320","description":"The maximum height of the thumbnail.","disabled":true},{"key":"max_width","value":"320","description":"The maximum width of the thumbnail.","disabled":true}],"variable":[{"id":"cc0794f9-a96a-42df-83db-e4bb945ef7c0","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"586dda4a-3f16-4230-bdf0-aa6198e8edd8","key":"extension","value":"png","description":"The file format for the thumbnail."}]},"description":"Retrieves a thumbnail, or smaller image representation, of a file.\n\nhttps://developer.box.com/reference/get-files-id-thumbnail-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"image/jpg"}],"cookie":[],"responseTime":null,"body":null},{"id":"d044a113-7e4d-441b-91b5-fadb64e92dbf","name":"[202] Sometimes generating a thumbnail can take a few seconds. In these","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/files/:file_id/thumbnail.:extension","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","thumbnail.:extension"],"query":[{"key":"min_height","value":"32","description":"The minimum height of the thumbnail.","disabled":true},{"key":"min_width","value":"32","description":"The minimum width of the thumbnail.","disabled":true},{"key":"max_height","value":"320","description":"The maximum height of the thumbnail.","disabled":true},{"key":"max_width","value":"320","description":"The maximum width of the thumbnail.","disabled":true}],"variable":[{"id":"cc0794f9-a96a-42df-83db-e4bb945ef7c0","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"586dda4a-3f16-4230-bdf0-aa6198e8edd8","key":"extension","value":"png","description":"The file format for the thumbnail."}]},"description":"Retrieves a thumbnail, or smaller image representation, of a file.\n\nhttps://developer.box.com/reference/get-files-id-thumbnail-id"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[{"key":"Retry-After","value":"","description":"The time in seconds after which the thumbnail will be available.\n\nYour application only attempt to get the thumbnail again after\nthis time."},{"key":"Location","value":"","description":"A pointer to a placeholder graphic that can be used until the\nthumbnail has been generated."}],"cookie":[],"responseTime":null,"body":null},{"id":"7ff1454a-d485-4ded-9a45-202b16e33e2c","name":"[302] Returns an error when Box is not able to create a thumbnail for this","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/files/:file_id/thumbnail.:extension","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","thumbnail.:extension"],"query":[{"key":"min_height","value":"32","description":"The minimum height of the thumbnail.","disabled":true},{"key":"min_width","value":"32","description":"The minimum width of the thumbnail.","disabled":true},{"key":"max_height","value":"320","description":"The maximum height of the thumbnail.","disabled":true},{"key":"max_width","value":"320","description":"The maximum width of the thumbnail.","disabled":true}],"variable":[{"id":"cc0794f9-a96a-42df-83db-e4bb945ef7c0","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"586dda4a-3f16-4230-bdf0-aa6198e8edd8","key":"extension","value":"png","description":"The file format for the thumbnail."}]},"description":"Retrieves a thumbnail, or smaller image representation, of a file.\n\nhttps://developer.box.com/reference/get-files-id-thumbnail-id"},"status":"Found","code":302,"_postman_previewlanguage":"Text","header":[{"key":"Location","value":"","description":"A pointer to a placeholder graphic that can be used for this\nfile type."}],"cookie":[],"responseTime":null,"body":null},{"id":"f8f0385f-4477-48bc-a802-d8d347dd2bea","name":"[400] Returns an error if some of the parameters are missing or","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/files/:file_id/thumbnail.:extension","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","thumbnail.:extension"],"query":[{"key":"min_height","value":"32","description":"The minimum height of the thumbnail.","disabled":true},{"key":"min_width","value":"32","description":"The minimum width of the thumbnail.","disabled":true},{"key":"max_height","value":"320","description":"The maximum height of the thumbnail.","disabled":true},{"key":"max_width","value":"320","description":"The maximum width of the thumbnail.","disabled":true}],"variable":[{"id":"cc0794f9-a96a-42df-83db-e4bb945ef7c0","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"586dda4a-3f16-4230-bdf0-aa6198e8edd8","key":"extension","value":"png","description":"The file format for the thumbnail."}]},"description":"Retrieves a thumbnail, or smaller image representation, of a file.\n\nhttps://developer.box.com/reference/get-files-id-thumbnail-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"b287c27d-36ac-46ff-a0eb-c9902c9e7722","name":"[403] Returned when the access token provided in the `Authorization` header","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/files/:file_id/thumbnail.:extension","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","thumbnail.:extension"],"query":[{"key":"min_height","value":"32","description":"The minimum height of the thumbnail.","disabled":true},{"key":"min_width","value":"32","description":"The minimum width of the thumbnail.","disabled":true},{"key":"max_height","value":"320","description":"The maximum height of the thumbnail.","disabled":true},{"key":"max_width","value":"320","description":"The maximum width of the thumbnail.","disabled":true}],"variable":[{"id":"cc0794f9-a96a-42df-83db-e4bb945ef7c0","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"586dda4a-3f16-4230-bdf0-aa6198e8edd8","key":"extension","value":"png","description":"The file format for the thumbnail."}]},"description":"Retrieves a thumbnail, or smaller image representation, of a file.\n\nhttps://developer.box.com/reference/get-files-id-thumbnail-id"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"4f411e50-6885-4010-b040-bb4456f4967a","name":"[404] Returned if the file is not found, or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/files/:file_id/thumbnail.:extension","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","thumbnail.:extension"],"query":[{"key":"min_height","value":"32","description":"The minimum height of the thumbnail.","disabled":true},{"key":"min_width","value":"32","description":"The minimum width of the thumbnail.","disabled":true},{"key":"max_height","value":"320","description":"The maximum height of the thumbnail.","disabled":true},{"key":"max_width","value":"320","description":"The maximum width of the thumbnail.","disabled":true}],"variable":[{"id":"cc0794f9-a96a-42df-83db-e4bb945ef7c0","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"586dda4a-3f16-4230-bdf0-aa6198e8edd8","key":"extension","value":"png","description":"The file format for the thumbnail."}]},"description":"Retrieves a thumbnail, or smaller image representation, of a file.\n\nhttps://developer.box.com/reference/get-files-id-thumbnail-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"0201bf44-52d9-4990-b730-ed3562ec4020"},{"name":"Copy file","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"20488e66-302f-4e61-b366-4b03492cc103","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates a copy of a file.
\nhttps://developer.box.com/reference/post-files-id-copy
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","copy"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"1a654b9e-c21f-43eb-ab6c-4237333e7161","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
Updates a file. This can be used to rename or move a file,
\nhttps://developer.box.com/reference/put-files-id
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"d7ed29d2-f1fa-486c-97ff-f6d2d65127ba","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
Deletes a file, either permanently or by moving it to
\nhttps://developer.box.com/reference/delete-files-id
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"58ff36ef-1f4e-41d9-a483-2bac2aaa1c8d","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
Retrieves folder lock details for a given folder.
\nhttps://developer.box.com/reference/get-folder-locks
\n","urlObject":{"protocol":"https","path":["2.0","folder_locks"],"host":["api.box.com"],"query":[{"description":{"content":"The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder of a Box account is\nalways represented by the ID 0.
Creates a folder lock on a folder, preventing it from being moved and/or
\nhttps://developer.box.com/reference/post-folder-locks
\n","urlObject":{"protocol":"https","path":["2.0","folder_locks"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"7d23da74-8d27-4cb8-96bf-6638e1a2f904","name":"[200] Returns the instance of the folder lock that was applied to the folder,","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"locked_operations\": {\n \"move\": true,\n \"delete\": true\n },\n \"folder\": {\n \"type\": \"folder\",\n \"id\": \"1234567890\"\n }\n}"},"url":"https://api.box.com/2.0/folder_locks","description":"Creates a folder lock on a folder, preventing it from being moved and/or\n\nhttps://developer.box.com/reference/post-folder-locks"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"folder\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"id\": \"12345678\",\n \"type\": \"folder_lock\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\"\n },\n \"created_at\": \"2020-09-14T23:12:53Z\",\n \"locked_operations\": {\n \"move\": true,\n \"delete\": true\n },\n \"lock_type\": \"freeze\"\n}"},{"id":"c7f95333-3478-48ff-9711-4344417cbab7","name":"[400] Returns an error when the request body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"locked_operations\": {\n \"move\": true,\n \"delete\": true\n },\n \"folder\": {\n \"type\": \"folder\",\n \"id\": \"1234567890\"\n }\n}"},"url":"https://api.box.com/2.0/folder_locks","description":"Creates a folder lock on a folder, preventing it from being moved and/or\n\nhttps://developer.box.com/reference/post-folder-locks"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"a87033cb-7c3b-4f12-9d35-25ed8720fb98","name":"[404] Returns an error when the folder was not found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"locked_operations\": {\n \"move\": true,\n \"delete\": true\n },\n \"folder\": {\n \"type\": \"folder\",\n \"id\": \"1234567890\"\n }\n}"},"url":"https://api.box.com/2.0/folder_locks","description":"Creates a folder lock on a folder, preventing it from being moved and/or\n\nhttps://developer.box.com/reference/post-folder-locks"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"7b741dd3-aa7e-4b1a-87c7-d02981672c1a"},{"name":"Delete folder lock","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"14f7ddd2-98eb-4b73-b269-29e469b7e810","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Deletes a folder lock on a given folder.
\nhttps://developer.box.com/reference/delete-folder-locks-id
\n","urlObject":{"protocol":"https","path":["2.0","folder_locks",":folder_lock_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"26e4a23a-9595-45c7-8f8d-414a94a708d4","description":{"content":"The ID of the folder lock.
\n","type":"text/plain"},"type":"any","value":"12345","key":"folder_lock_id"}]}},"response":[{"id":"de298596-75f0-4046-a123-17687e7e76fb","name":"[204] Returns an empty response when the folder lock is successfully deleted.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/folder_locks/:folder_lock_id","protocol":"https","host":["api.box.com"],"path":["2.0","folder_locks",":folder_lock_id"],"variable":[{"id":"26e4a23a-9595-45c7-8f8d-414a94a708d4","key":"folder_lock_id","value":"12345","description":"The ID of the folder lock."}]},"description":"Deletes a folder lock on a given folder.\n\nhttps://developer.box.com/reference/delete-folder-locks-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"55147f56-ecfa-4d38-b3c0-641c460d5624","name":"[403] Returns an error if the user does not have the required","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/folder_locks/:folder_lock_id","protocol":"https","host":["api.box.com"],"path":["2.0","folder_locks",":folder_lock_id"],"variable":[{"id":"26e4a23a-9595-45c7-8f8d-414a94a708d4","key":"folder_lock_id","value":"12345","description":"The ID of the folder lock."}]},"description":"Deletes a folder lock on a given folder.\n\nhttps://developer.box.com/reference/delete-folder-locks-id"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"2299e5ef-4f1c-466f-9c8e-78fe9e0bb267","name":"[404] Returns an error if the folder could not be found,","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/folder_locks/:folder_lock_id","protocol":"https","host":["api.box.com"],"path":["2.0","folder_locks",":folder_lock_id"],"variable":[{"id":"26e4a23a-9595-45c7-8f8d-414a94a708d4","key":"folder_lock_id","value":"12345","description":"The ID of the folder lock."}]},"description":"Deletes a folder lock on a given folder.\n\nhttps://developer.box.com/reference/delete-folder-locks-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"14f7ddd2-98eb-4b73-b269-29e469b7e810"}],"id":"d39c4516-eb45-4432-ab51-7b5a1c4b7153","_postman_id":"d39c4516-eb45-4432-ab51-7b5a1c4b7153","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves details for a folder, including the first 100 entries
\nhttps://developer.box.com/reference/get-folders-id
\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the metadata field as well\nas the scope and key of the template to retrieve, for example\n?fields=metadata.enterprise_12345.contractTemplate.
Defines the second attribute by which items\nare sorted.
\nThe folder type affects the way the items\nare sorted:
\nStandard folder:\n Items are always sorted by\n their type first, with\n folders listed before files,\n and files listed\n before web links.
Root folder:\n This parameter is not supported\n for marker-based pagination\n on the root folder
\n (the folder with an id of 0).
type first, with\n folders listed before files,\n and files listed\n before web links.The direction to sort results in. This can be either in alphabetical ascending\n(ASC) or descending (DESC) order.
The offset of the item at which to begin the response.
\nOffset-based pagination is not guaranteed to work reliably for high offset values and may fail for large datasets. In\nthose cases, reduce the number of items in the folder (for example, by\nrestructuring the folder into smaller subfolders) before retrying the\nrequest.
\n","type":"text/plain"},"key":"offset","value":"1000"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[{"id":"471b612b-e514-4358-904a-d13b824806d7","description":{"content":"The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder of a Box account is\nalways represented by the ID 0.
Retrieves a page of items in a folder. These items can be files,
\nhttps://developer.box.com/reference/get-folders-id-items
\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id","items"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the metadata field as well\nas the scope and key of the template to retrieve, for example\n?fields=metadata.enterprise_12345.contractTemplate.
Specifies whether to use marker-based pagination instead of\noffset-based pagination. Only one pagination method can\nbe used at a time.
\nBy setting this value to true, the API will return a marker field\nthat can be passed as a parameter to this endpoint to get the next\npage of the response.
Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The offset of the item at which to begin the response.
\nOffset-based pagination is not guaranteed to work reliably for high offset values and may fail for large datasets. In\nthose cases, use marker-based pagination by setting usemarker to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"Defines the second attribute by which items\nare sorted.
\nThe folder type affects the way the items\nare sorted:
\nStandard folder:\n Items are always sorted by\n their type first, with\n folders listed before files,\n and files listed\n before web links.
Root folder:\n This parameter is not supported\n for marker-based pagination\n on the root folder
\n (the folder with an id of 0).
type first, with\n folders listed before files,\n and files listed\n before web links.The direction to sort results in. This can be either in alphabetical ascending\n(ASC) or descending (DESC) order.
The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder of a Box account is\nalways represented by the ID 0.
Creates a new empty folder within the specified parent folder.
\nhttps://developer.box.com/reference/post-folders
\n","urlObject":{"protocol":"https","path":["2.0","folders"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[]}},"response":[{"id":"312accf8-2c9d-40b3-9376-8a830801e9eb","name":"[201] Returns a folder object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New Folder\",\n \"parent\": {\n \"id\": \"0\"\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"sync_state\": \"synced\"\n}"},"url":{"raw":"https://api.box.com/2.0/folders","protocol":"https","host":["api.box.com"],"path":["2.0","folders"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}]},"description":"Creates a new empty folder within the specified parent folder.\n\nhttps://developer.box.com/reference/post-folders"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"description\": \"Legal contracts for the new ACME deal\",\n \"size\": 629644,\n \"path_collection\": {\n \"total_count\": 1,\n \"entries\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n }\n ]\n },\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"trashed_at\": \"2012-12-12T10:53:43-08:00\",\n \"purged_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_created_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"owned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"shared_link\": {\n \"url\": \"https://www.box.com/s/vspke7y05sb214wjokpk\",\n \"download_url\": \"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg\",\n \"vanity_url\": \"https://acme.app.box.com/v/my_url/\",\n \"vanity_name\": \"my_url\",\n \"access\": \"open\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_download\",\n \"unshared_at\": \"2018-04-13T13:53:23-07:00\",\n \"is_password_enabled\": true,\n \"permissions\": {\n \"can_download\": true,\n \"can_preview\": true,\n \"can_edit\": false\n },\n \"download_count\": 3,\n \"preview_count\": 3\n },\n \"folder_upload_email\": {\n \"access\": \"open\",\n \"email\": \"upload.Contracts.asd7asd@u.box.com\"\n },\n \"parent\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"item_status\": \"active\",\n \"item_collection\": {\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"total_count\": 5000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"ASC\"\n }\n ],\n \"entries\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n },\n \"description\": \"Contract for Q1 renewal\",\n \"size\": 629644,\n \"path_collection\": {\n \"total_count\": 1,\n \"entries\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n }\n ]\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"trashed_at\": \"2012-12-12T10:53:43-08:00\",\n \"purged_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_created_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"owned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"shared_link\": {\n \"url\": \"https://www.box.com/s/vspke7y05sb214wjokpk\",\n \"download_url\": \"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg\",\n \"vanity_url\": \"https://acme.app.box.com/v/my_url/\",\n \"vanity_name\": \"my_url\",\n \"access\": \"open\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_download\",\n \"unshared_at\": \"2018-04-13T13:53:23-07:00\",\n \"is_password_enabled\": true,\n \"permissions\": {\n \"can_download\": true,\n \"can_preview\": true,\n \"can_edit\": false\n },\n \"download_count\": 3,\n \"preview_count\": 3\n },\n \"parent\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"item_status\": \"active\",\n \"version_number\": \"1\",\n \"comment_count\": 10,\n \"permissions\": {\n \"can_delete\": true,\n \"can_download\": true,\n \"can_invite_collaborator\": true,\n \"can_rename\": true,\n \"can_set_share_access\": true,\n \"can_share\": true,\n \"can_annotate\": true,\n \"can_comment\": true,\n \"can_preview\": true,\n \"can_upload\": true,\n \"can_view_annotations_all\": true,\n \"can_view_annotations_self\": true,\n \"can_apply_watermark\": true\n },\n \"tags\": [\n \"approved\"\n ],\n \"lock\": {\n \"id\": \"11446498\",\n \"type\": \"lock\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"expired_at\": \"2012-12-12T10:53:43-08:00\",\n \"is_download_prevented\": true,\n \"app_type\": \"office_wopiplus\"\n },\n \"extension\": \"pdf\",\n \"is_package\": true,\n \"expiring_embed_link\": {\n \"access_token\": \"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ\",\n \"expires_in\": 3600,\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_download\",\n \"object\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n }\n }\n ],\n \"url\": \"https://cloud.app.box.com/preview/expiring_embed/...\"\n },\n \"watermark_info\": {\n \"is_watermarked\": true,\n \"is_watermark_inherited\": false,\n \"is_watermarked_by_access_policy\": false\n },\n \"is_accessible_via_shared_link\": true,\n \"allowed_invitee_roles\": [\n \"editor\"\n ],\n \"is_externally_owned\": true,\n \"has_collaborations\": true,\n \"metadata\": {\n \"enterprise_27335\": {\n \"marketingCollateral\": {\n \"$canEdit\": true,\n \"$id\": \"01234500-12f1-1234-aa12-b1d234cb567e\",\n \"$parent\": \"folder_59449484661\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"marketingCollateral\",\n \"$type\": \"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0\",\n \"$typeVersion\": 2,\n \"$version\": 1\n }\n }\n },\n \"expires_at\": \"2012-12-12T10:53:43-08:00\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567\"\n },\n \"info\": {\n \"url\": \"https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048\"\n },\n \"properties\": {\n \"dimensions\": \"2048x2048\",\n \"paged\": \"true\",\n \"thumb\": \"true\"\n },\n \"representation\": \"png\",\n \"status\": {\n \"state\": \"success\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"Top Secret\",\n \"definition\": \"Content that should not be shared outside the company.\",\n \"color\": \"#FF0000\"\n },\n \"uploader_display_name\": \"Ellis Wiggins\",\n \"disposition_at\": \"2012-12-12T10:53:43-08:00\",\n \"shared_link_permission_options\": [\n \"can_preview\"\n ],\n \"is_associated_with_app_item\": true\n }\n },\n \"sync_state\": \"synced\",\n \"has_collaborations\": true,\n \"permissions\": {\n \"can_delete\": true,\n \"can_download\": true,\n \"can_invite_collaborator\": true,\n \"can_rename\": true,\n \"can_set_share_access\": true,\n \"can_share\": true,\n \"can_upload\": true,\n \"can_apply_watermark\": true\n },\n \"tags\": [\n \"approved\"\n ],\n \"can_non_owners_invite\": true,\n \"is_externally_owned\": true,\n \"metadata\": {\n \"enterprise_27335\": {\n \"marketingCollateral\": {\n \"$canEdit\": true,\n \"$id\": \"01234500-12f1-1234-aa12-b1d234cb567e\",\n \"$parent\": \"folder_59449484661\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"marketingCollateral\",\n \"$type\": \"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0\",\n \"$typeVersion\": 2,\n \"$version\": 1\n }\n }\n },\n \"is_collaboration_restricted_to_enterprise\": true,\n \"allowed_shared_link_access_levels\": [\n \"open\"\n ],\n \"allowed_invitee_roles\": [\n \"editor\"\n ],\n \"watermark_info\": {\n \"is_watermarked\": true,\n \"is_watermark_inherited\": false,\n \"is_watermarked_by_access_policy\": false\n },\n \"is_accessible_via_shared_link\": true,\n \"can_non_owners_view_collaborators\": true,\n \"classification\": {\n \"name\": \"Top Secret\",\n \"definition\": \"Content that should not be shared outside the company.\",\n \"color\": \"#FF0000\"\n },\n \"is_associated_with_app_item\": true\n}"},{"id":"19c7cf4c-889c-4767-9541-370415af432f","name":"[400] Returns an error if some of the parameters are missing or","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New Folder\",\n \"parent\": {\n \"id\": \"0\"\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"sync_state\": \"synced\"\n}"},"url":{"raw":"https://api.box.com/2.0/folders","protocol":"https","host":["api.box.com"],"path":["2.0","folders"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}]},"description":"Creates a new empty folder within the specified parent folder.\n\nhttps://developer.box.com/reference/post-folders"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"074f4e6e-95b7-431d-97cf-4f2e3740bf72","name":"[403] Returns an error if the user does not have the required","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New Folder\",\n \"parent\": {\n \"id\": \"0\"\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"sync_state\": \"synced\"\n}"},"url":{"raw":"https://api.box.com/2.0/folders","protocol":"https","host":["api.box.com"],"path":["2.0","folders"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}]},"description":"Creates a new empty folder within the specified parent folder.\n\nhttps://developer.box.com/reference/post-folders"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"0ee4b424-1380-49e9-ae61-9f20cbf44e16","name":"[404] Returns an error if the parent folder could not be found,","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New Folder\",\n \"parent\": {\n \"id\": \"0\"\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"sync_state\": \"synced\"\n}"},"url":{"raw":"https://api.box.com/2.0/folders","protocol":"https","host":["api.box.com"],"path":["2.0","folders"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}]},"description":"Creates a new empty folder within the specified parent folder.\n\nhttps://developer.box.com/reference/post-folders"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"ed2fa5f6-7f9a-4ce7-bc9c-477124596317","name":"[409] `operation_blocked_temporary`: Returned if either of the destination","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New Folder\",\n \"parent\": {\n \"id\": \"0\"\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"sync_state\": \"synced\"\n}"},"url":{"raw":"https://api.box.com/2.0/folders","protocol":"https","host":["api.box.com"],"path":["2.0","folders"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}]},"description":"Creates a new empty folder within the specified parent folder.\n\nhttps://developer.box.com/reference/post-folders"},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"c854705b-4733-4fb7-9fdc-307d1cc620cb"},{"name":"Copy folder","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"90c8a11c-0409-4d4f-810a-ac3dffe11eaa","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates a copy of a folder within a destination folder.
\nhttps://developer.box.com/reference/post-folders-id-copy
\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id","copy"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"c4d884e2-349a-40ab-8be5-ee3f3e3eb862","description":{"content":"The unique identifier of the folder to copy.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder with the ID 0 can not be copied.
Updates a folder. This can be also be used to move the folder,
\nhttps://developer.box.com/reference/put-folders-id
\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"12bfbfb3-1f80-4832-b2b9-153e09d0a186","description":{"content":"The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder of a Box account is\nalways represented by the ID 0.
Deletes a folder, either permanently or by moving it to
\nhttps://developer.box.com/reference/delete-folders-id
\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Delete a folder that is not empty by recursively deleting the\nfolder and all of its content.
\n","type":"text/plain"},"key":"recursive","value":"true"}],"variable":[{"id":"c4c87ce4-8f97-48fb-ba2e-8b70f620a7dc","description":{"content":"The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder of a Box account is\nalways represented by the ID 0.
Retrieves all the groups for a user. Only members of this
\nhttps://developer.box.com/reference/get-users-id-memberships
\n","urlObject":{"protocol":"https","path":["2.0","users",":user_id","memberships"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"The offset of the item at which to begin the response.
\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.
\n","type":"text/plain"},"key":"offset","value":"1000"}],"variable":[{"id":"6bf735b7-5058-4956-b053-a717ae228a1e","description":{"content":"The ID of the user.
\n","type":"text/plain"},"type":"any","value":"12345","key":"user_id"}]}},"response":[{"id":"c01d7446-7800-44fb-9ace-22ad3df76ffc","name":"[200] Returns a collection of membership objects. If there are no","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/users/:user_id/memberships","protocol":"https","host":["api.box.com"],"path":["2.0","users",":user_id","memberships"],"query":[{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"offset","value":"1000","description":"The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.","disabled":true}],"variable":[{"id":"6bf735b7-5058-4956-b053-a717ae228a1e","key":"user_id","value":"12345","description":"The ID of the user."}]},"description":"Retrieves all the groups for a user. Only members of this\n\nhttps://developer.box.com/reference/get-users-id-memberships"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 5000,\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"ASC\"\n }\n ],\n \"entries\": [\n {\n \"id\": \"11446498\",\n \"type\": \"group_membership\",\n \"user\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"group\": {\n \"id\": \"11446498\",\n \"type\": \"group\",\n \"name\": \"Support\",\n \"group_type\": \"managed_group\"\n },\n \"role\": \"member\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ]\n}"}],"_postman_id":"59e38b07-b89b-4fcd-af08-67d856f0a916"},{"name":"List members of group","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"ad3534c3-197b-4559-a6a4-c2ed6e80cff3","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves all the members for a group. Only members of this
\nhttps://developer.box.com/reference/get-groups-id-memberships
\n","urlObject":{"protocol":"https","path":["2.0","groups",":group_id","memberships"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"The offset of the item at which to begin the response.
\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.
\n","type":"text/plain"},"key":"offset","value":"1000"}],"variable":[{"id":"e55772f8-8d4e-4d4b-9385-12bff256f953","description":{"content":"The ID of the group.
\n","type":"text/plain"},"type":"any","value":"57645","key":"group_id"}]}},"response":[{"id":"f6585e0e-f1d0-4704-93b1-fd81af4fda7e","name":"[200] Returns a collection of membership objects. If there are no","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/groups/:group_id/memberships","protocol":"https","host":["api.box.com"],"path":["2.0","groups",":group_id","memberships"],"query":[{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"offset","value":"1000","description":"The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.","disabled":true}],"variable":[{"id":"e55772f8-8d4e-4d4b-9385-12bff256f953","key":"group_id","value":"57645","description":"The ID of the group."}]},"description":"Retrieves all the members for a group. Only members of this\n\nhttps://developer.box.com/reference/get-groups-id-memberships"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 5000,\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"ASC\"\n }\n ],\n \"entries\": [\n {\n \"id\": \"11446498\",\n \"type\": \"group_membership\",\n \"user\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"group\": {\n \"id\": \"11446498\",\n \"type\": \"group\",\n \"name\": \"Support\",\n \"group_type\": \"managed_group\"\n },\n \"role\": \"member\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ]\n}"}],"_postman_id":"ad3534c3-197b-4559-a6a4-c2ed6e80cff3"},{"name":"Get group membership","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"d865421b-250c-4739-b63d-53d1bc882d3b","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves a specific group membership. Only admins of this
\nhttps://developer.box.com/reference/get-group-memberships-id
\n","urlObject":{"protocol":"https","path":["2.0","group_memberships",":group_membership_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"48186c7a-5106-4280-8e21-abbce3e39d59","description":{"content":"The ID of the group membership.
\n","type":"text/plain"},"type":"any","value":"434534","key":"group_membership_id"}]}},"response":[{"id":"c07bd648-04b8-43af-94aa-4c5c85fa67b8","name":"[200] Returns the group membership object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/group_memberships/:group_membership_id","protocol":"https","host":["api.box.com"],"path":["2.0","group_memberships",":group_membership_id"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}],"variable":[{"id":"48186c7a-5106-4280-8e21-abbce3e39d59","key":"group_membership_id","value":"434534","description":"The ID of the group membership."}]},"description":"Retrieves a specific group membership. Only admins of this\n\nhttps://developer.box.com/reference/get-group-memberships-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"group_membership\",\n \"user\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"group\": {\n \"id\": \"11446498\",\n \"type\": \"group\",\n \"name\": \"Support\",\n \"group_type\": \"managed_group\"\n },\n \"role\": \"member\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n}"}],"_postman_id":"d865421b-250c-4739-b63d-53d1bc882d3b"},{"name":"Add user to group","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"d468ff80-ad58-415e-bc8d-237f4501135a","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates a group membership. Only users with
\nhttps://developer.box.com/reference/post-group-memberships
\n","urlObject":{"protocol":"https","path":["2.0","group_memberships"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[]}},"response":[{"id":"cc88b2cb-8dc2-4d23-bf04-8345a416a271","name":"[201] Returns a new group membership object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"id\": \"1434325\"\n },\n \"group\": {\n \"id\": \"4545523\"\n },\n \"role\": \"member\",\n \"configurable_permissions\": {\n \"can_run_reports\": true\n }\n}"},"url":{"raw":"https://api.box.com/2.0/group_memberships","protocol":"https","host":["api.box.com"],"path":["2.0","group_memberships"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}]},"description":"Creates a group membership. Only users with\n\nhttps://developer.box.com/reference/post-group-memberships"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"group_membership\",\n \"user\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"group\": {\n \"id\": \"11446498\",\n \"type\": \"group\",\n \"name\": \"Support\",\n \"group_type\": \"managed_group\"\n },\n \"role\": \"member\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n}"},{"id":"c2e48e56-8e70-47d1-8786-b8b348d5cd87","name":"[403] Returns an error when the user cannot be added","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"id\": \"1434325\"\n },\n \"group\": {\n \"id\": \"4545523\"\n },\n \"role\": \"member\",\n \"configurable_permissions\": {\n \"can_run_reports\": true\n }\n}"},"url":{"raw":"https://api.box.com/2.0/group_memberships","protocol":"https","host":["api.box.com"],"path":["2.0","group_memberships"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}]},"description":"Creates a group membership. Only users with\n\nhttps://developer.box.com/reference/post-group-memberships"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"d468ff80-ad58-415e-bc8d-237f4501135a"},{"name":"Update group membership","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"cd61b532-a695-48fb-a5a1-2d563e2b555c","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Updates a user's group membership. Only admins of this
\nhttps://developer.box.com/reference/put-group-memberships-id
\n","urlObject":{"protocol":"https","path":["2.0","group_memberships",":group_membership_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"f1b1bfe3-a4ef-43b3-b56c-de9c1a2574e8","description":{"content":"The ID of the group membership.
\n","type":"text/plain"},"type":"any","value":"434534","key":"group_membership_id"}]}},"response":[{"id":"28827e50-73c0-47ab-9600-e745ef7b5559","name":"[200] Returns a new group membership object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"role\": \"member\",\n \"configurable_permissions\": {\n \"can_run_reports\": true\n }\n}"},"url":{"raw":"https://api.box.com/2.0/group_memberships/:group_membership_id","protocol":"https","host":["api.box.com"],"path":["2.0","group_memberships",":group_membership_id"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}],"variable":[{"id":"f1b1bfe3-a4ef-43b3-b56c-de9c1a2574e8","key":"group_membership_id","value":"434534","description":"The ID of the group membership."}]},"description":"Updates a user's group membership. Only admins of this\n\nhttps://developer.box.com/reference/put-group-memberships-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"group_membership\",\n \"user\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"group\": {\n \"id\": \"11446498\",\n \"type\": \"group\",\n \"name\": \"Support\",\n \"group_type\": \"managed_group\"\n },\n \"role\": \"member\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n}"}],"_postman_id":"cd61b532-a695-48fb-a5a1-2d563e2b555c"},{"name":"Remove user from group","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"8aad85e7-5fea-400e-8d36-b4442031d920","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Deletes a specific group membership. Only admins of this
\nhttps://developer.box.com/reference/delete-group-memberships-id
\n","urlObject":{"protocol":"https","path":["2.0","group_memberships",":group_membership_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"5f1dd450-60dd-4df1-bcb4-492b0b27bbb4","description":{"content":"The ID of the group membership.
\n","type":"text/plain"},"type":"any","value":"434534","key":"group_membership_id"}]}},"response":[{"id":"98da632c-fa98-48e0-9c71-07d6fe4edf43","name":"[204] A blank response is returned if the membership was","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/group_memberships/:group_membership_id","protocol":"https","host":["api.box.com"],"path":["2.0","group_memberships",":group_membership_id"],"variable":[{"id":"5f1dd450-60dd-4df1-bcb4-492b0b27bbb4","key":"group_membership_id","value":"434534","description":"The ID of the group membership."}]},"description":"Deletes a specific group membership. Only admins of this\n\nhttps://developer.box.com/reference/delete-group-memberships-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8aad85e7-5fea-400e-8d36-b4442031d920"}],"id":"d8f85cbd-c495-402f-b574-42043fb5c68e","_postman_id":"d8f85cbd-c495-402f-b574-42043fb5c68e","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves all of the groups for a given enterprise. The user
\nhttps://developer.box.com/reference/get-groups
\n","urlObject":{"protocol":"https","path":["2.0","groups"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Limits the results to only groups whose name starts\nwith the search term.
A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"The offset of the item at which to begin the response.
\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.
\n","type":"text/plain"},"key":"offset","value":"1000"}],"variable":[]}},"response":[{"id":"520edaa4-d1ef-4c95-9d1f-274cca017acd","name":"[200] Returns a collection of group objects. If there are no groups, an","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/groups","protocol":"https","host":["api.box.com"],"path":["2.0","groups"],"query":[{"key":"filter_term","value":"Engineering","description":"Limits the results to only groups whose `name` starts\nwith the search term.","disabled":true},{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"offset","value":"1000","description":"The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.","disabled":true}]},"description":"Retrieves all of the groups for a given enterprise. The user\n\nhttps://developer.box.com/reference/get-groups"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 5000,\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"ASC\"\n }\n ],\n \"entries\": [\n {\n \"id\": \"11446498\",\n \"type\": \"group\",\n \"name\": \"Support\",\n \"group_type\": \"managed_group\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"provenance\": \"Active Directory\",\n \"external_sync_identifier\": \"AD:123456\",\n \"description\": \"Support Group - as imported from Active Directory\",\n \"invitability_level\": \"admins_only\",\n \"member_viewability_level\": \"admins_only\",\n \"permissions\": {\n \"can_invite_as_collaborator\": true\n }\n }\n ]\n}"}],"_postman_id":"e2bfa258-21a6-43fd-a40e-cbeae0700731"},{"name":"Get group","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"504ceb55-0a54-4c66-97d5-130215a82961","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves information about a group. Only members of this
\nhttps://developer.box.com/reference/get-groups-id
\n","urlObject":{"protocol":"https","path":["2.0","groups",":group_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"c54e0de3-4656-48ea-b35f-566b04cf59a7","description":{"content":"The ID of the group.
\n","type":"text/plain"},"type":"any","value":"57645","key":"group_id"}]}},"response":[{"id":"9208a29f-8e32-4111-a9b6-38430484f24e","name":"[200] Returns the group object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/groups/:group_id","protocol":"https","host":["api.box.com"],"path":["2.0","groups",":group_id"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}],"variable":[{"id":"c54e0de3-4656-48ea-b35f-566b04cf59a7","key":"group_id","value":"57645","description":"The ID of the group."}]},"description":"Retrieves information about a group. Only members of this\n\nhttps://developer.box.com/reference/get-groups-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"group\",\n \"name\": \"Support\",\n \"group_type\": \"managed_group\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"provenance\": \"Active Directory\",\n \"external_sync_identifier\": \"AD:123456\",\n \"description\": \"Support Group - as imported from Active Directory\",\n \"invitability_level\": \"admins_only\",\n \"member_viewability_level\": \"admins_only\",\n \"permissions\": {\n \"can_invite_as_collaborator\": true\n }\n}"}],"_postman_id":"504ceb55-0a54-4c66-97d5-130215a82961"},{"name":"Create group","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"ce56c469-0313-4462-a196-37f375fb075f","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates a new group of users in an enterprise. Only users with admin
\nhttps://developer.box.com/reference/post-groups
\n","urlObject":{"protocol":"https","path":["2.0","groups"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[]}},"response":[{"id":"a4c50130-9c7c-4376-852e-0b2aaed58197","name":"[201] Returns the new group object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Customer Support\",\n \"provenance\": \"Active Directory\",\n \"external_sync_identifier\": \"AD:123456\",\n \"description\": \"\\\"Customer Support Group - as imported from Active Directory\\\"\",\n \"invitability_level\": \"admins_only\",\n \"member_viewability_level\": \"admins_only\"\n}"},"url":{"raw":"https://api.box.com/2.0/groups","protocol":"https","host":["api.box.com"],"path":["2.0","groups"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}]},"description":"Creates a new group of users in an enterprise. Only users with admin\n\nhttps://developer.box.com/reference/post-groups"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"group\",\n \"name\": \"Support\",\n \"group_type\": \"managed_group\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"provenance\": \"Active Directory\",\n \"external_sync_identifier\": \"AD:123456\",\n \"description\": \"Support Group - as imported from Active Directory\",\n \"invitability_level\": \"admins_only\",\n \"member_viewability_level\": \"admins_only\",\n \"permissions\": {\n \"can_invite_as_collaborator\": true\n }\n}"},{"id":"947885d7-2c69-4293-8edc-180976e210f7","name":"[409] Returns an error a conflict is stopping the group from being created.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Customer Support\",\n \"provenance\": \"Active Directory\",\n \"external_sync_identifier\": \"AD:123456\",\n \"description\": \"\\\"Customer Support Group - as imported from Active Directory\\\"\",\n \"invitability_level\": \"admins_only\",\n \"member_viewability_level\": \"admins_only\"\n}"},"url":{"raw":"https://api.box.com/2.0/groups","protocol":"https","host":["api.box.com"],"path":["2.0","groups"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}]},"description":"Creates a new group of users in an enterprise. Only users with admin\n\nhttps://developer.box.com/reference/post-groups"},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"ce56c469-0313-4462-a196-37f375fb075f"},{"name":"Update group","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"32bc6337-ca43-40ba-a240-519a043a85cf","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Updates a specific group. Only admins of this
\nhttps://developer.box.com/reference/put-groups-id
\n","urlObject":{"protocol":"https","path":["2.0","groups",":group_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"0bc061bc-6332-4ebe-b5da-2d726b369312","description":{"content":"The ID of the group.
\n","type":"text/plain"},"type":"any","value":"57645","key":"group_id"}]}},"response":[{"id":"44f83a24-c02b-418a-9727-94ec550a37f1","name":"[200] Returns the updated group object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Customer Support\",\n \"provenance\": \"Active Directory\",\n \"external_sync_identifier\": \"AD:123456\",\n \"description\": \"\\\"Customer Support Group - as imported from Active Directory\\\"\",\n \"invitability_level\": \"admins_only\",\n \"member_viewability_level\": \"admins_only\"\n}"},"url":{"raw":"https://api.box.com/2.0/groups/:group_id","protocol":"https","host":["api.box.com"],"path":["2.0","groups",":group_id"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}],"variable":[{"id":"0bc061bc-6332-4ebe-b5da-2d726b369312","key":"group_id","value":"57645","description":"The ID of the group."}]},"description":"Updates a specific group. Only admins of this\n\nhttps://developer.box.com/reference/put-groups-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"group\",\n \"name\": \"Support\",\n \"group_type\": \"managed_group\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"provenance\": \"Active Directory\",\n \"external_sync_identifier\": \"AD:123456\",\n \"description\": \"Support Group - as imported from Active Directory\",\n \"invitability_level\": \"admins_only\",\n \"member_viewability_level\": \"admins_only\",\n \"permissions\": {\n \"can_invite_as_collaborator\": true\n }\n}"},{"id":"7c82aaf5-bd7b-4fbf-9dff-cf182b23ec79","name":"[409] Returns an error a conflict is stopping the group from being created.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Customer Support\",\n \"provenance\": \"Active Directory\",\n \"external_sync_identifier\": \"AD:123456\",\n \"description\": \"\\\"Customer Support Group - as imported from Active Directory\\\"\",\n \"invitability_level\": \"admins_only\",\n \"member_viewability_level\": \"admins_only\"\n}"},"url":{"raw":"https://api.box.com/2.0/groups/:group_id","protocol":"https","host":["api.box.com"],"path":["2.0","groups",":group_id"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}],"variable":[{"id":"0bc061bc-6332-4ebe-b5da-2d726b369312","key":"group_id","value":"57645","description":"The ID of the group."}]},"description":"Updates a specific group. Only admins of this\n\nhttps://developer.box.com/reference/put-groups-id"},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"32bc6337-ca43-40ba-a240-519a043a85cf"},{"name":"Remove group","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"fc418d2d-42f8-443a-96ff-e5d23e2f2c99","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Permanently deletes a group. Only users with
\nhttps://developer.box.com/reference/delete-groups-id
\n","urlObject":{"protocol":"https","path":["2.0","groups",":group_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"b30c17f6-962f-4501-a271-5597a485edfa","description":{"content":"The ID of the group.
\n","type":"text/plain"},"type":"any","value":"57645","key":"group_id"}]}},"response":[{"id":"82b97a2a-1a4f-42f5-814c-382334d0cced","name":"[204] A blank response is returned if the group was","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/groups/:group_id","protocol":"https","host":["api.box.com"],"path":["2.0","groups",":group_id"],"variable":[{"id":"b30c17f6-962f-4501-a271-5597a485edfa","key":"group_id","value":"57645","description":"The ID of the group."}]},"description":"Permanently deletes a group. Only users with\n\nhttps://developer.box.com/reference/delete-groups-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fc418d2d-42f8-443a-96ff-e5d23e2f2c99"}],"id":"d4cb4fcf-d938-454a-9823-2d948d907ba6","_postman_id":"d4cb4fcf-d938-454a-9823-2d948d907ba6","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Lists Slack integration mappings in a users' enterprise.
\nhttps://developer.box.com/reference/get-integration-mappings-slack
\n","urlObject":{"protocol":"https","path":["2.0","integration_mappings","slack"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"Mapped item type, for which the mapping should be returned.
\n","type":"text/plain"},"key":"partner_item_type","value":"channel"},{"disabled":true,"description":{"content":"ID of the mapped item,\nfor which the mapping should be returned.
\n","type":"text/plain"},"key":"partner_item_id","value":"12345"},{"disabled":true,"description":{"content":"Box item ID, for which the mappings should be returned.
\n","type":"text/plain"},"key":"box_item_id","value":"12345"},{"disabled":true,"description":{"content":"Box item type, for\nwhich the mappings should be returned.
\n","type":"text/plain"},"key":"box_item_type","value":"folder"},{"disabled":true,"description":{"content":"Whether the mapping has been manually created.
\n","type":"text/plain"},"key":"is_manually_created","value":"true"}],"variable":[]}},"response":[{"id":"f40fcba7-d6a5-4c2f-8de4-7db9d15da3e9","name":"[200] Returns a collection of integration mappings.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/integration_mappings/slack","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","slack"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"partner_item_type","value":"channel","description":"Mapped item type, for which the mapping should be returned.","disabled":true},{"key":"partner_item_id","value":"12345","description":"ID of the mapped item,\nfor which the mapping should be returned.","disabled":true},{"key":"box_item_id","value":"12345","description":"Box item ID, for which the mappings should be returned.","disabled":true},{"key":"box_item_type","value":"folder","description":"Box item type, for\nwhich the mappings should be returned.","disabled":true},{"key":"is_manually_created","value":"true","description":"Whether the mapping has been manually created.","disabled":true}]},"description":"Lists Slack integration mappings in a users' enterprise.\n\nhttps://developer.box.com/reference/get-integration-mappings-slack"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"entries\": [\n {\n \"id\": \"12345\",\n \"type\": \"integration_mapping\",\n \"integration_type\": \"slack\",\n \"is_manually_created\": true,\n \"options\": {\n \"is_access_management_disabled\": true\n },\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"partner_item\": {\n \"id\": \"C12378991223\",\n \"type\": \"channel\",\n \"slack_org_id\": \"E1234567\"\n },\n \"box_item\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ]\n}"},{"id":"7e98450a-e459-4889-ac94-4cbff330d353","name":"[400] The server cannot or will not process the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/integration_mappings/slack","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","slack"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"partner_item_type","value":"channel","description":"Mapped item type, for which the mapping should be returned.","disabled":true},{"key":"partner_item_id","value":"12345","description":"ID of the mapped item,\nfor which the mapping should be returned.","disabled":true},{"key":"box_item_id","value":"12345","description":"Box item ID, for which the mappings should be returned.","disabled":true},{"key":"box_item_type","value":"folder","description":"Box item type, for\nwhich the mappings should be returned.","disabled":true},{"key":"is_manually_created","value":"true","description":"Whether the mapping has been manually created.","disabled":true}]},"description":"Lists Slack integration mappings in a users' enterprise.\n\nhttps://developer.box.com/reference/get-integration-mappings-slack"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"93da4017-989d-4b87-8def-323ffb39d54f","name":"[404] Returns a `not_found` error if the integration mapping could not be found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/integration_mappings/slack","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","slack"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"partner_item_type","value":"channel","description":"Mapped item type, for which the mapping should be returned.","disabled":true},{"key":"partner_item_id","value":"12345","description":"ID of the mapped item,\nfor which the mapping should be returned.","disabled":true},{"key":"box_item_id","value":"12345","description":"Box item ID, for which the mappings should be returned.","disabled":true},{"key":"box_item_type","value":"folder","description":"Box item type, for\nwhich the mappings should be returned.","disabled":true},{"key":"is_manually_created","value":"true","description":"Whether the mapping has been manually created.","disabled":true}]},"description":"Lists Slack integration mappings in a users' enterprise.\n\nhttps://developer.box.com/reference/get-integration-mappings-slack"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"715d6792-448a-4c51-a9ce-b540a65a8824"},{"name":"List Teams integration mappings","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"a5629032-ab68-4570-b106-c4414809f8ef","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Lists Teams integration mappings in a users' enterprise.
\nhttps://developer.box.com/reference/get-integration-mappings-teams
\n","urlObject":{"protocol":"https","path":["2.0","integration_mappings","teams"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Mapped item type, for which the mapping should be returned.
\n","type":"text/plain"},"key":"partner_item_type","value":"channel"},{"disabled":true,"description":{"content":"ID of the mapped item,\nfor which the mapping should be returned.
\n","type":"text/plain"},"key":"partner_item_id","value":"12345"},{"disabled":true,"description":{"content":"Box item ID, for which the mappings should be returned.
\n","type":"text/plain"},"key":"box_item_id","value":"12345"},{"disabled":true,"description":{"content":"Box item type, for\nwhich the mappings should be returned.
\n","type":"text/plain"},"key":"box_item_type","value":"folder"}],"variable":[]}},"response":[{"id":"ff305902-e894-42a4-b7d0-0f7b85217741","name":"[200] Returns a collection of integration mappings.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/integration_mappings/teams","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","teams"],"query":[{"key":"partner_item_type","value":"channel","description":"Mapped item type, for which the mapping should be returned.","disabled":true},{"key":"partner_item_id","value":"12345","description":"ID of the mapped item,\nfor which the mapping should be returned.","disabled":true},{"key":"box_item_id","value":"12345","description":"Box item ID, for which the mappings should be returned.","disabled":true},{"key":"box_item_type","value":"folder","description":"Box item type, for\nwhich the mappings should be returned.","disabled":true}]},"description":"Lists Teams integration mappings in a users' enterprise.\n\nhttps://developer.box.com/reference/get-integration-mappings-teams"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"id\": \"12345\",\n \"type\": \"integration_mapping\",\n \"integration_type\": \"teams\",\n \"is_overridden_by_manual_mapping\": true,\n \"partner_item\": {\n \"id\": \"19%3ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2\",\n \"type\": \"channel\",\n \"tenant_id\": \"E1234567\",\n \"team_id\": \"hjgjgjg-bhhj-564a-b643-hghgj685u\"\n },\n \"box_item\": {\n \"type\": \"folder\",\n \"id\": \"42037322\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ]\n}"},{"id":"eb2f8e74-2da0-4307-85d3-2132fbde81cc","name":"[400] The server cannot or will not process the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/integration_mappings/teams","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","teams"],"query":[{"key":"partner_item_type","value":"channel","description":"Mapped item type, for which the mapping should be returned.","disabled":true},{"key":"partner_item_id","value":"12345","description":"ID of the mapped item,\nfor which the mapping should be returned.","disabled":true},{"key":"box_item_id","value":"12345","description":"Box item ID, for which the mappings should be returned.","disabled":true},{"key":"box_item_type","value":"folder","description":"Box item type, for\nwhich the mappings should be returned.","disabled":true}]},"description":"Lists Teams integration mappings in a users' enterprise.\n\nhttps://developer.box.com/reference/get-integration-mappings-teams"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"4cc7f7ed-9070-4227-82c3-a6da940f729e","name":"[404] Returns a `not_found` error if the integration mapping could not be found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/integration_mappings/teams","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","teams"],"query":[{"key":"partner_item_type","value":"channel","description":"Mapped item type, for which the mapping should be returned.","disabled":true},{"key":"partner_item_id","value":"12345","description":"ID of the mapped item,\nfor which the mapping should be returned.","disabled":true},{"key":"box_item_id","value":"12345","description":"Box item ID, for which the mappings should be returned.","disabled":true},{"key":"box_item_type","value":"folder","description":"Box item type, for\nwhich the mappings should be returned.","disabled":true}]},"description":"Lists Teams integration mappings in a users' enterprise.\n\nhttps://developer.box.com/reference/get-integration-mappings-teams"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"a5629032-ab68-4570-b106-c4414809f8ef"},{"name":"Create Slack integration mapping","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"d276c3e7-4ea8-4af5-b1f5-1bf0504c2993","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates a Slack integration mapping
\nhttps://developer.box.com/reference/post-integration-mappings-slack
\n","urlObject":{"protocol":"https","path":["2.0","integration_mappings","slack"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"3281ab65-986c-48ee-a2cb-9d749eed7b12","name":"[201] Returns the created integration mapping.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partner_item\": {\n \"type\": \"channel\",\n \"id\": \"C12378991223\",\n \"slack_workspace_id\": \"T12352314\",\n \"slack_org_id\": \"E1234567\"\n },\n \"box_item\": {\n \"type\": \"folder\",\n \"id\": \"1234567891\"\n },\n \"options\": {\n \"is_access_management_disabled\": true\n }\n}"},"url":"https://api.box.com/2.0/integration_mappings/slack","description":"Creates a Slack integration mapping\n\nhttps://developer.box.com/reference/post-integration-mappings-slack"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"type\": \"integration_mapping\",\n \"integration_type\": \"slack\",\n \"is_manually_created\": true,\n \"options\": {\n \"is_access_management_disabled\": true\n },\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"partner_item\": {\n \"id\": \"C12378991223\",\n \"type\": \"channel\",\n \"slack_org_id\": \"E1234567\"\n },\n \"box_item\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n}"},{"id":"bcce45cc-cc51-4d37-a4fa-32022fc3dd76","name":"[400] Returns a `bad_request` if an incorrect `options`","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partner_item\": {\n \"type\": \"channel\",\n \"id\": \"C12378991223\",\n \"slack_workspace_id\": \"T12352314\",\n \"slack_org_id\": \"E1234567\"\n },\n \"box_item\": {\n \"type\": \"folder\",\n \"id\": \"1234567891\"\n },\n \"options\": {\n \"is_access_management_disabled\": true\n }\n}"},"url":"https://api.box.com/2.0/integration_mappings/slack","description":"Creates a Slack integration mapping\n\nhttps://developer.box.com/reference/post-integration-mappings-slack"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"8655a38b-17ec-43a7-bcef-74729c719ecd","name":"[404] Returns a `not_found` error if the integration mapping could not be found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partner_item\": {\n \"type\": \"channel\",\n \"id\": \"C12378991223\",\n \"slack_workspace_id\": \"T12352314\",\n \"slack_org_id\": \"E1234567\"\n },\n \"box_item\": {\n \"type\": \"folder\",\n \"id\": \"1234567891\"\n },\n \"options\": {\n \"is_access_management_disabled\": true\n }\n}"},"url":"https://api.box.com/2.0/integration_mappings/slack","description":"Creates a Slack integration mapping\n\nhttps://developer.box.com/reference/post-integration-mappings-slack"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"d276c3e7-4ea8-4af5-b1f5-1bf0504c2993"},{"name":"Create Teams integration mapping","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"e330e304-4383-4c25-a60e-61f34f8c623e","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates a Teams integration mapping
\nhttps://developer.box.com/reference/post-integration-mappings-teams
\n","urlObject":{"protocol":"https","path":["2.0","integration_mappings","teams"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"8be97042-3274-44c3-a652-adf9efcf7e16","name":"[201] Returns the created integration mapping.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partner_item\": {\n \"type\": \"channel\",\n \"id\": \"19%ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2\",\n \"tenant_id\": \"abcd-defg-1235-7890\",\n \"team_id\": \"hjgjgjg-bhhj-564a-b643-hghgj685u\"\n },\n \"box_item\": {\n \"type\": \"folder\",\n \"id\": \"42037322\"\n }\n}"},"url":"https://api.box.com/2.0/integration_mappings/teams","description":"Creates a Teams integration mapping\n\nhttps://developer.box.com/reference/post-integration-mappings-teams"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"type\": \"integration_mapping\",\n \"integration_type\": \"teams\",\n \"is_overridden_by_manual_mapping\": true,\n \"partner_item\": {\n \"id\": \"19%3ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2\",\n \"type\": \"channel\",\n \"tenant_id\": \"E1234567\",\n \"team_id\": \"hjgjgjg-bhhj-564a-b643-hghgj685u\"\n },\n \"box_item\": {\n \"type\": \"folder\",\n \"id\": \"42037322\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n}"},{"id":"32668dc9-17a8-4745-a35e-c4ddfbec8de7","name":"[400] Returns a `bad_request` if an incorrect `options`","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partner_item\": {\n \"type\": \"channel\",\n \"id\": \"19%ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2\",\n \"tenant_id\": \"abcd-defg-1235-7890\",\n \"team_id\": \"hjgjgjg-bhhj-564a-b643-hghgj685u\"\n },\n \"box_item\": {\n \"type\": \"folder\",\n \"id\": \"42037322\"\n }\n}"},"url":"https://api.box.com/2.0/integration_mappings/teams","description":"Creates a Teams integration mapping\n\nhttps://developer.box.com/reference/post-integration-mappings-teams"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"84006e43-6739-4c3b-8533-804339e19dcc","name":"[404] Returns a `not_found` error if the integration mapping, record or folder could not be found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partner_item\": {\n \"type\": \"channel\",\n \"id\": \"19%ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2\",\n \"tenant_id\": \"abcd-defg-1235-7890\",\n \"team_id\": \"hjgjgjg-bhhj-564a-b643-hghgj685u\"\n },\n \"box_item\": {\n \"type\": \"folder\",\n \"id\": \"42037322\"\n }\n}"},"url":"https://api.box.com/2.0/integration_mappings/teams","description":"Creates a Teams integration mapping\n\nhttps://developer.box.com/reference/post-integration-mappings-teams"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"e330e304-4383-4c25-a60e-61f34f8c623e"},{"name":"Update Slack integration mapping","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"4a78ed03-e94e-4330-b781-be4f81566523","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Updates a Slack integration mapping.
\nhttps://developer.box.com/reference/put-integration-mappings-slack-id
\n","urlObject":{"protocol":"https","path":["2.0","integration_mappings","slack",":integration_mapping_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"40c895b9-eac3-443d-9283-596b47f95140","description":{"content":"An ID of an integration mapping.
\n","type":"text/plain"},"type":"any","value":"11235432","key":"integration_mapping_id"}]}},"response":[{"id":"c871a0d4-cd7b-4e8d-a816-ff54f267af88","name":"[200] Returns the updated integration mapping object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"box_item\": {\n \"type\": \"folder\",\n \"id\": \"1234567891\"\n },\n \"options\": {\n \"is_access_management_disabled\": true\n }\n}"},"url":{"raw":"https://api.box.com/2.0/integration_mappings/slack/:integration_mapping_id","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","slack",":integration_mapping_id"],"variable":[{"id":"40c895b9-eac3-443d-9283-596b47f95140","key":"integration_mapping_id","value":"11235432","description":"An ID of an integration mapping."}]},"description":"Updates a Slack integration mapping.\n\nhttps://developer.box.com/reference/put-integration-mappings-slack-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"type\": \"integration_mapping\",\n \"integration_type\": \"slack\",\n \"is_manually_created\": true,\n \"options\": {\n \"is_access_management_disabled\": true\n },\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"partner_item\": {\n \"id\": \"C12378991223\",\n \"type\": \"channel\",\n \"slack_org_id\": \"E1234567\"\n },\n \"box_item\": {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"folder\",\n \"sequence_id\": \"3\",\n \"name\": \"Contracts\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n}"},{"id":"ba98fc45-d775-4e11-8a95-afc187cc452c","name":"[400] Returns a `bad_request` if an incorrect `options` was","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"box_item\": {\n \"type\": \"folder\",\n \"id\": \"1234567891\"\n },\n \"options\": {\n \"is_access_management_disabled\": true\n }\n}"},"url":{"raw":"https://api.box.com/2.0/integration_mappings/slack/:integration_mapping_id","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","slack",":integration_mapping_id"],"variable":[{"id":"40c895b9-eac3-443d-9283-596b47f95140","key":"integration_mapping_id","value":"11235432","description":"An ID of an integration mapping."}]},"description":"Updates a Slack integration mapping.\n\nhttps://developer.box.com/reference/put-integration-mappings-slack-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"2ca5a878-25b7-423e-b073-306354a02554","name":"[404] Returns `not_found` if integration mapping object was not found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"box_item\": {\n \"type\": \"folder\",\n \"id\": \"1234567891\"\n },\n \"options\": {\n \"is_access_management_disabled\": true\n }\n}"},"url":{"raw":"https://api.box.com/2.0/integration_mappings/slack/:integration_mapping_id","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","slack",":integration_mapping_id"],"variable":[{"id":"40c895b9-eac3-443d-9283-596b47f95140","key":"integration_mapping_id","value":"11235432","description":"An ID of an integration mapping."}]},"description":"Updates a Slack integration mapping.\n\nhttps://developer.box.com/reference/put-integration-mappings-slack-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"4a78ed03-e94e-4330-b781-be4f81566523"},{"name":"Update Teams integration mapping","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"645f5e78-ee4e-4545-b5be-2c6cdce10d72","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Updates a Teams integration mapping.
\nhttps://developer.box.com/reference/put-integration-mappings-teams-id
\n","urlObject":{"protocol":"https","path":["2.0","integration_mappings","teams",":integration_mapping_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"ea452d86-8ff5-4e5c-b483-63f5d781878e","description":{"content":"An ID of an integration mapping.
\n","type":"text/plain"},"type":"any","value":"11235432","key":"integration_mapping_id"}]}},"response":[{"id":"3bc91a7a-ba9e-4f19-a2c9-e6dda055329b","name":"[200] Returns the updated integration mapping object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"box_item\": {\n \"type\": \"folder\",\n \"id\": \"42037322\"\n }\n}"},"url":{"raw":"https://api.box.com/2.0/integration_mappings/teams/:integration_mapping_id","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","teams",":integration_mapping_id"],"variable":[{"id":"ea452d86-8ff5-4e5c-b483-63f5d781878e","key":"integration_mapping_id","value":"11235432","description":"An ID of an integration mapping."}]},"description":"Updates a Teams integration mapping.\n\nhttps://developer.box.com/reference/put-integration-mappings-teams-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"type\": \"integration_mapping\",\n \"integration_type\": \"teams\",\n \"is_overridden_by_manual_mapping\": true,\n \"partner_item\": {\n \"id\": \"19%3ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2\",\n \"type\": \"channel\",\n \"tenant_id\": \"E1234567\",\n \"team_id\": \"hjgjgjg-bhhj-564a-b643-hghgj685u\"\n },\n \"box_item\": {\n \"type\": \"folder\",\n \"id\": \"42037322\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n}"},{"id":"bd5a29ef-6c54-468d-a9ee-a3e03b992271","name":"[400] Returns a `bad_request` if an incorrect `options` was","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"box_item\": {\n \"type\": \"folder\",\n \"id\": \"42037322\"\n }\n}"},"url":{"raw":"https://api.box.com/2.0/integration_mappings/teams/:integration_mapping_id","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","teams",":integration_mapping_id"],"variable":[{"id":"ea452d86-8ff5-4e5c-b483-63f5d781878e","key":"integration_mapping_id","value":"11235432","description":"An ID of an integration mapping."}]},"description":"Updates a Teams integration mapping.\n\nhttps://developer.box.com/reference/put-integration-mappings-teams-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"801a7143-f264-4ff4-a4a6-fc6fcd894523","name":"[404] Returns `not_found` if integration mapping object was not found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"box_item\": {\n \"type\": \"folder\",\n \"id\": \"42037322\"\n }\n}"},"url":{"raw":"https://api.box.com/2.0/integration_mappings/teams/:integration_mapping_id","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","teams",":integration_mapping_id"],"variable":[{"id":"ea452d86-8ff5-4e5c-b483-63f5d781878e","key":"integration_mapping_id","value":"11235432","description":"An ID of an integration mapping."}]},"description":"Updates a Teams integration mapping.\n\nhttps://developer.box.com/reference/put-integration-mappings-teams-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"645f5e78-ee4e-4545-b5be-2c6cdce10d72"},{"name":"Delete Slack integration mapping","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"54a80d0f-f8a7-4dc8-b780-b3b6c4c9578b","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Deletes a Slack integration mapping.
\nhttps://developer.box.com/reference/delete-integration-mappings-slack-id
\n","urlObject":{"protocol":"https","path":["2.0","integration_mappings","slack",":integration_mapping_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"0cdd4aba-97b4-48af-8224-efe167f04e8f","description":{"content":"An ID of an integration mapping.
\n","type":"text/plain"},"type":"any","value":"11235432","key":"integration_mapping_id"}]}},"response":[{"id":"1b9ca8b8-2b44-45ac-8ff5-623b0c49e1f1","name":"[204] Empty body in response.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/integration_mappings/slack/:integration_mapping_id","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","slack",":integration_mapping_id"],"variable":[{"id":"0cdd4aba-97b4-48af-8224-efe167f04e8f","key":"integration_mapping_id","value":"11235432","description":"An ID of an integration mapping."}]},"description":"Deletes a Slack integration mapping.\n\nhttps://developer.box.com/reference/delete-integration-mappings-slack-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"920f372c-8a6c-400d-9d9c-ac80c33baac4","name":"[404] Returns a `not_found` error if the integration mapping could not be found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/integration_mappings/slack/:integration_mapping_id","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","slack",":integration_mapping_id"],"variable":[{"id":"0cdd4aba-97b4-48af-8224-efe167f04e8f","key":"integration_mapping_id","value":"11235432","description":"An ID of an integration mapping."}]},"description":"Deletes a Slack integration mapping.\n\nhttps://developer.box.com/reference/delete-integration-mappings-slack-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"54a80d0f-f8a7-4dc8-b780-b3b6c4c9578b"},{"name":"Delete Teams integration mapping","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"0897cd8d-5fb4-4b30-bef7-484691b8f780","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Deletes a Teams integration mapping.
\nhttps://developer.box.com/reference/delete-integration-mappings-teams-id
\n","urlObject":{"protocol":"https","path":["2.0","integration_mappings","teams",":integration_mapping_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"09d195b4-8a2c-4bee-ac3d-219b9937665b","description":{"content":"An ID of an integration mapping.
\n","type":"text/plain"},"type":"any","value":"11235432","key":"integration_mapping_id"}]}},"response":[{"id":"67a67b87-3ee1-480f-ae69-76955afda4bf","name":"[204] Empty body in response.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/integration_mappings/teams/:integration_mapping_id","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","teams",":integration_mapping_id"],"variable":[{"id":"09d195b4-8a2c-4bee-ac3d-219b9937665b","key":"integration_mapping_id","value":"11235432","description":"An ID of an integration mapping."}]},"description":"Deletes a Teams integration mapping.\n\nhttps://developer.box.com/reference/delete-integration-mappings-teams-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"997e626e-6b59-42c4-a385-18012758e019","name":"[404] Returns a `not_found` error if the integration mapping could not be found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/integration_mappings/teams/:integration_mapping_id","protocol":"https","host":["api.box.com"],"path":["2.0","integration_mappings","teams",":integration_mapping_id"],"variable":[{"id":"09d195b4-8a2c-4bee-ac3d-219b9937665b","key":"integration_mapping_id","value":"11235432","description":"An ID of an integration mapping."}]},"description":"Deletes a Teams integration mapping.\n\nhttps://developer.box.com/reference/delete-integration-mappings-teams-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"0897cd8d-5fb4-4b30-bef7-484691b8f780"}],"id":"c1439dcf-1000-446c-b6ae-8702cde688f3","_postman_id":"c1439dcf-1000-446c-b6ae-8702cde688f3","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Returns the status of a user invite.
\nhttps://developer.box.com/reference/get-invites-id
\n","urlObject":{"protocol":"https","path":["2.0","invites",":invite_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"d21200b5-e4eb-40c6-a964-d192eedd62ab","description":{"content":"The ID of an invite.
\n","type":"text/plain"},"type":"any","value":"213723","key":"invite_id"}]}},"response":[{"id":"9e0f2f5c-41c1-4c27-b20d-08d6741db73e","name":"[200] Returns an invite object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/invites/:invite_id","protocol":"https","host":["api.box.com"],"path":["2.0","invites",":invite_id"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}],"variable":[{"id":"d21200b5-e4eb-40c6-a964-d192eedd62ab","key":"invite_id","value":"213723","description":"The ID of an invite."}]},"description":"Returns the status of a user invite.\n\nhttps://developer.box.com/reference/get-invites-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"invite\",\n \"invited_to\": {\n \"id\": \"11446498\",\n \"type\": \"enterprise\",\n \"name\": \"Acme Inc.\"\n },\n \"actionable_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"invited_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"status\": \"pending\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n}"}],"_postman_id":"d575b9a8-33e7-4cc7-9635-2c8388540509"},{"name":"Create user invite","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"5d025bf2-5a85-478c-9a66-a1b73d0e26cf","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Invites an existing external user to join an enterprise.
\nhttps://developer.box.com/reference/post-invites
\n","urlObject":{"protocol":"https","path":["2.0","invites"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[]}},"response":[{"id":"744590f8-4c59-4c64-bd89-163a5e5e9de1","name":"[200] Returns a new invite object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"enterprise\": {\n \"id\": \"1232234\"\n },\n \"actionable_by\": {\n \"login\": \"john@example.com\"\n }\n}"},"url":{"raw":"https://api.box.com/2.0/invites","protocol":"https","host":["api.box.com"],"path":["2.0","invites"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}]},"description":"Invites an existing external user to join an enterprise.\n\nhttps://developer.box.com/reference/post-invites"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"invite\",\n \"invited_to\": {\n \"id\": \"11446498\",\n \"type\": \"enterprise\",\n \"name\": \"Acme Inc.\"\n },\n \"actionable_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"invited_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"status\": \"pending\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n}"},{"id":"b3753d4f-65c2-490a-886c-6666f713211a","name":"[404] Returns `not_found` when user was not found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"enterprise\": {\n \"id\": \"1232234\"\n },\n \"actionable_by\": {\n \"login\": \"john@example.com\"\n }\n}"},"url":{"raw":"https://api.box.com/2.0/invites","protocol":"https","host":["api.box.com"],"path":["2.0","invites"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}]},"description":"Invites an existing external user to join an enterprise.\n\nhttps://developer.box.com/reference/post-invites"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"5d025bf2-5a85-478c-9a66-a1b73d0e26cf"}],"id":"25a57bb5-3b55-4a27-aea6-2efddb4c6b1a","_postman_id":"25a57bb5-3b55-4a27-aea6-2efddb4c6b1a","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves a list of legal hold policies that belong to
\nhttps://developer.box.com/reference/get-legal-hold-policies
\n","urlObject":{"protocol":"https","path":["2.0","legal_hold_policies"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Limits results to policies for which the names start with\nthis search term. This is a case-insensitive prefix.
\n","type":"text/plain"},"key":"policy_name","value":"Sales Policy"},{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"9b5ba95f-9253-442d-994c-7099b42699ae","name":"[200] Returns a list of legal hold policies.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/legal_hold_policies","protocol":"https","host":["api.box.com"],"path":["2.0","legal_hold_policies"],"query":[{"key":"policy_name","value":"Sales Policy","description":"Limits results to policies for which the names start with\nthis search term. This is a case-insensitive prefix.","disabled":true},{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Retrieves a list of legal hold policies that belong to\n\nhttps://developer.box.com/reference/get-legal-hold-policies"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"11446498\",\n \"type\": \"legal_hold_policy\",\n \"policy_name\": \"Policy 4\",\n \"description\": \"Postman created policy\",\n \"status\": \"active\",\n \"assignment_counts\": {\n \"user\": 1,\n \"folder\": 2,\n \"file\": 3,\n \"file_version\": 4,\n \"ownership\": 5,\n \"interactions\": 6\n },\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"deleted_at\": \"2012-12-12T10:53:43-08:00\",\n \"filter_started_at\": \"2012-12-12T10:53:43-08:00\",\n \"filter_ended_at\": \"2012-12-12T10:53:43-08:00\",\n \"release_notes\": \"Example\"\n }\n ]\n}"}],"_postman_id":"cf11e6a7-3961-436c-a5df-3f20a29d3d42"},{"name":"Get legal hold policy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"d896ce8d-14cb-4066-9060-bdc55a56da25","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieve a legal hold policy.
\nhttps://developer.box.com/reference/get-legal-hold-policies-id
\n","urlObject":{"protocol":"https","path":["2.0","legal_hold_policies",":legal_hold_policy_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"90a45cd3-f022-49d9-b395-e026460dc28d","description":{"content":"The ID of the legal hold policy.
\n","type":"text/plain"},"type":"any","value":"324432","key":"legal_hold_policy_id"}]}},"response":[{"id":"3624e383-0b72-470d-99fd-e25b70545f60","name":"[200] Returns a legal hold policy object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/legal_hold_policies/:legal_hold_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","legal_hold_policies",":legal_hold_policy_id"],"variable":[{"id":"90a45cd3-f022-49d9-b395-e026460dc28d","key":"legal_hold_policy_id","value":"324432","description":"The ID of the legal hold policy."}]},"description":"Retrieve a legal hold policy.\n\nhttps://developer.box.com/reference/get-legal-hold-policies-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"legal_hold_policy\",\n \"policy_name\": \"Policy 4\",\n \"description\": \"Postman created policy\",\n \"status\": \"active\",\n \"assignment_counts\": {\n \"user\": 1,\n \"folder\": 2,\n \"file\": 3,\n \"file_version\": 4,\n \"ownership\": 5,\n \"interactions\": 6\n },\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"deleted_at\": \"2012-12-12T10:53:43-08:00\",\n \"filter_started_at\": \"2012-12-12T10:53:43-08:00\",\n \"filter_ended_at\": \"2012-12-12T10:53:43-08:00\",\n \"release_notes\": \"Example\"\n}"}],"_postman_id":"d896ce8d-14cb-4066-9060-bdc55a56da25"},{"name":"Create legal hold policy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"c1053e3d-9e26-462e-94c2-ba964cbd8838","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Create a new legal hold policy.
\nhttps://developer.box.com/reference/post-legal-hold-policies
\n","urlObject":{"protocol":"https","path":["2.0","legal_hold_policies"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"19766816-32a0-4bff-84ff-839cf14d53e4","name":"[201] Returns a new legal hold policy object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_name\": \"Sales Policy\",\n \"description\": \"A custom policy for the sales team\",\n \"filter_started_at\": \"2012-12-12T10:53:43-08:00\",\n \"filter_ended_at\": \"2012-12-18T10:53:43-08:00\",\n \"is_ongoing\": true\n}"},"url":"https://api.box.com/2.0/legal_hold_policies","description":"Create a new legal hold policy.\n\nhttps://developer.box.com/reference/post-legal-hold-policies"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"legal_hold_policy\",\n \"policy_name\": \"Policy 4\",\n \"description\": \"Postman created policy\",\n \"status\": \"active\",\n \"assignment_counts\": {\n \"user\": 1,\n \"folder\": 2,\n \"file\": 3,\n \"file_version\": 4,\n \"ownership\": 5,\n \"interactions\": 6\n },\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"deleted_at\": \"2012-12-12T10:53:43-08:00\",\n \"filter_started_at\": \"2012-12-12T10:53:43-08:00\",\n \"filter_ended_at\": \"2012-12-12T10:53:43-08:00\",\n \"release_notes\": \"Example\"\n}"},{"id":"321ccee7-3b9b-4d52-95c9-70527da4c24a","name":"[400] Returns an error if required parameters are missing,","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_name\": \"Sales Policy\",\n \"description\": \"A custom policy for the sales team\",\n \"filter_started_at\": \"2012-12-12T10:53:43-08:00\",\n \"filter_ended_at\": \"2012-12-18T10:53:43-08:00\",\n \"is_ongoing\": true\n}"},"url":"https://api.box.com/2.0/legal_hold_policies","description":"Create a new legal hold policy.\n\nhttps://developer.box.com/reference/post-legal-hold-policies"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"e93a677a-25e5-4d76-8aa4-3a65c9797110","name":"[409] Returns an error if a policy with this name already exists.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_name\": \"Sales Policy\",\n \"description\": \"A custom policy for the sales team\",\n \"filter_started_at\": \"2012-12-12T10:53:43-08:00\",\n \"filter_ended_at\": \"2012-12-18T10:53:43-08:00\",\n \"is_ongoing\": true\n}"},"url":"https://api.box.com/2.0/legal_hold_policies","description":"Create a new legal hold policy.\n\nhttps://developer.box.com/reference/post-legal-hold-policies"},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"c1053e3d-9e26-462e-94c2-ba964cbd8838"},{"name":"Update legal hold policy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"7b5a96b0-cc6f-4f6e-8347-593d6bebb89b","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Update legal hold policy.
\nhttps://developer.box.com/reference/put-legal-hold-policies-id
\n","urlObject":{"protocol":"https","path":["2.0","legal_hold_policies",":legal_hold_policy_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"bc0798d1-3ef2-4f7a-a706-d2e59bda47be","description":{"content":"The ID of the legal hold policy.
\n","type":"text/plain"},"type":"any","value":"324432","key":"legal_hold_policy_id"}]}},"response":[{"id":"850594fe-f2f5-43f1-a97c-721b352801bd","name":"[200] Returns a new legal hold policy object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_name\": \"Sales Policy\",\n \"description\": \"A custom policy for the sales team\",\n \"release_notes\": \"Required for GDPR\"\n}"},"url":{"raw":"https://api.box.com/2.0/legal_hold_policies/:legal_hold_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","legal_hold_policies",":legal_hold_policy_id"],"variable":[{"id":"bc0798d1-3ef2-4f7a-a706-d2e59bda47be","key":"legal_hold_policy_id","value":"324432","description":"The ID of the legal hold policy."}]},"description":"Update legal hold policy.\n\nhttps://developer.box.com/reference/put-legal-hold-policies-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"legal_hold_policy\",\n \"policy_name\": \"Policy 4\",\n \"description\": \"Postman created policy\",\n \"status\": \"active\",\n \"assignment_counts\": {\n \"user\": 1,\n \"folder\": 2,\n \"file\": 3,\n \"file_version\": 4,\n \"ownership\": 5,\n \"interactions\": 6\n },\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"deleted_at\": \"2012-12-12T10:53:43-08:00\",\n \"filter_started_at\": \"2012-12-12T10:53:43-08:00\",\n \"filter_ended_at\": \"2012-12-12T10:53:43-08:00\",\n \"release_notes\": \"Example\"\n}"},{"id":"48cfbd7d-f023-49eb-9a8e-499d2108bae0","name":"[409] Returns an error if a policy with this name already exists.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_name\": \"Sales Policy\",\n \"description\": \"A custom policy for the sales team\",\n \"release_notes\": \"Required for GDPR\"\n}"},"url":{"raw":"https://api.box.com/2.0/legal_hold_policies/:legal_hold_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","legal_hold_policies",":legal_hold_policy_id"],"variable":[{"id":"bc0798d1-3ef2-4f7a-a706-d2e59bda47be","key":"legal_hold_policy_id","value":"324432","description":"The ID of the legal hold policy."}]},"description":"Update legal hold policy.\n\nhttps://developer.box.com/reference/put-legal-hold-policies-id"},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"7b5a96b0-cc6f-4f6e-8347-593d6bebb89b"},{"name":"Remove legal hold policy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"16a56f84-e00a-4c7b-8751-75ff97cc0a31","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Delete an existing legal hold policy.
\nhttps://developer.box.com/reference/delete-legal-hold-policies-id
\n","urlObject":{"protocol":"https","path":["2.0","legal_hold_policies",":legal_hold_policy_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"12758a28-d315-4e6e-8f12-2da4ee2cdb4d","description":{"content":"The ID of the legal hold policy.
\n","type":"text/plain"},"type":"any","value":"324432","key":"legal_hold_policy_id"}]}},"response":[{"id":"7d099bd5-e17d-4255-9533-0e59d4ed1b95","name":"[202] A blank response is returned if the policy was","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/legal_hold_policies/:legal_hold_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","legal_hold_policies",":legal_hold_policy_id"],"variable":[{"id":"12758a28-d315-4e6e-8f12-2da4ee2cdb4d","key":"legal_hold_policy_id","value":"324432","description":"The ID of the legal hold policy."}]},"description":"Delete an existing legal hold policy.\n\nhttps://developer.box.com/reference/delete-legal-hold-policies-id"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"16a56f84-e00a-4c7b-8751-75ff97cc0a31"}],"id":"ceac837a-b703-4241-9278-51346fa10203","_postman_id":"ceac837a-b703-4241-9278-51346fa10203","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves a list of items a legal hold policy has been assigned to.
\nhttps://developer.box.com/reference/get-legal-hold-policy-assignments
\n","urlObject":{"protocol":"https","path":["2.0","legal_hold_policy_assignments"],"host":["api.box.com"],"query":[{"description":{"content":"The ID of the legal hold policy.
\n","type":"text/plain"},"key":"policy_id","value":"324432"},{"disabled":true,"description":{"content":"Filters the results by the type of item the\npolicy was applied to.
\n","type":"text/plain"},"key":"assign_to_type","value":"file"},{"disabled":true,"description":{"content":"Filters the results by the ID of item the\npolicy was applied to.
\n","type":"text/plain"},"key":"assign_to_id","value":"1234323"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[]}},"response":[{"id":"cfa249b3-5408-455f-ad61-ce32f33271c1","name":"[200] Returns a list of legal hold policy assignments.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/legal_hold_policy_assignments?policy_id=324432","protocol":"https","host":["api.box.com"],"path":["2.0","legal_hold_policy_assignments"],"query":[{"key":"policy_id","value":"324432","description":"The ID of the legal hold policy."},{"key":"assign_to_type","value":"file","description":"Filters the results by the type of item the\npolicy was applied to.","disabled":true},{"key":"assign_to_id","value":"1234323","description":"Filters the results by the ID of item the\npolicy was applied to.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}]},"description":"Retrieves a list of items a legal hold policy has been assigned to.\n\nhttps://developer.box.com/reference/get-legal-hold-policy-assignments"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"11446498\",\n \"type\": \"legal_hold_policy_assignment\",\n \"legal_hold_policy\": {\n \"id\": \"11446498\",\n \"type\": \"legal_hold_policy\"\n },\n \"assigned_to\": {\n \"type\": \"folder\",\n \"id\": \"6564564\"\n },\n \"assigned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"deleted_at\": \"2012-12-12T10:53:43-08:00\"\n }\n ]\n}"}],"_postman_id":"b2903029-cda5-41b4-9eba-ea22a48cbe89"},{"name":"Get legal hold policy assignment","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"70cec63d-518b-4dbe-9188-a169a5901a15","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieve a legal hold policy assignment.
\nhttps://developer.box.com/reference/get-legal-hold-policy-assignments-id
\n","urlObject":{"protocol":"https","path":["2.0","legal_hold_policy_assignments",":legal_hold_policy_assignment_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"78795809-14a6-4dff-b0e2-89752099a5cb","description":{"content":"The ID of the legal hold policy assignment.
\n","type":"text/plain"},"type":"any","value":"753465","key":"legal_hold_policy_assignment_id"}]}},"response":[{"id":"7f897cf3-a6bc-495b-a192-84614f59e67e","name":"[200] Returns a legal hold policy object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/legal_hold_policy_assignments/:legal_hold_policy_assignment_id","protocol":"https","host":["api.box.com"],"path":["2.0","legal_hold_policy_assignments",":legal_hold_policy_assignment_id"],"variable":[{"id":"78795809-14a6-4dff-b0e2-89752099a5cb","key":"legal_hold_policy_assignment_id","value":"753465","description":"The ID of the legal hold policy assignment."}]},"description":"Retrieve a legal hold policy assignment.\n\nhttps://developer.box.com/reference/get-legal-hold-policy-assignments-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"legal_hold_policy_assignment\",\n \"legal_hold_policy\": {\n \"id\": \"11446498\",\n \"type\": \"legal_hold_policy\"\n },\n \"assigned_to\": {\n \"type\": \"folder\",\n \"id\": \"6564564\"\n },\n \"assigned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"deleted_at\": \"2012-12-12T10:53:43-08:00\"\n}"}],"_postman_id":"70cec63d-518b-4dbe-9188-a169a5901a15"},{"name":"List files with current file versions for legal hold policy assignment","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"8c5757bb-4b1e-4c8a-b45c-e5f5e263180c","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Get a list of files with current file versions for a legal hold
\nhttps://developer.box.com/reference/get-legal-hold-policy-assignments-id-files-on-hold
\n","urlObject":{"protocol":"https","path":["2.0","legal_hold_policy_assignments",":legal_hold_policy_assignment_id","files_on_hold"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"c596c25a-aa32-495c-9a22-f505fe0232ee","description":{"content":"The ID of the legal hold policy assignment.
\n","type":"text/plain"},"type":"any","value":"753465","key":"legal_hold_policy_assignment_id"}]}},"response":[{"id":"8e8405b2-22ac-4092-b283-345cad95af5b","name":"[200] Returns the list of current file versions held under legal hold for a","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold","protocol":"https","host":["api.box.com"],"path":["2.0","legal_hold_policy_assignments",":legal_hold_policy_assignment_id","files_on_hold"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}],"variable":[{"id":"c596c25a-aa32-495c-9a22-f505fe0232ee","key":"legal_hold_policy_assignment_id","value":"753465","description":"The ID of the legal hold policy assignment."}]},"description":"Get a list of files with current file versions for a legal hold\n\nhttps://developer.box.com/reference/get-legal-hold-policy-assignments-id-files-on-hold"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n }\n }\n ]\n}"}],"_postman_id":"8c5757bb-4b1e-4c8a-b45c-e5f5e263180c"},{"name":"List previous file versions for legal hold policy assignment","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"d9c765e8-8ffb-496c-856d-91386040bdeb","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Get a list of previous file versions for a legal hold
\nhttps://developer.box.com/reference/get-legal-hold-policy-assignments-id-file-versions-on-hold
\n","urlObject":{"protocol":"https","path":["2.0","legal_hold_policy_assignments",":legal_hold_policy_assignment_id","file_versions_on_hold"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"03bda3e2-423c-41db-add5-ae99d5471ee6","description":{"content":"The ID of the legal hold policy assignment.
\n","type":"text/plain"},"type":"any","value":"753465","key":"legal_hold_policy_assignment_id"}]}},"response":[{"id":"63318588-3086-496b-948e-ae0e2d8acc83","name":"[200] Returns the list of previous file versions held under legal hold for a","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold","protocol":"https","host":["api.box.com"],"path":["2.0","legal_hold_policy_assignments",":legal_hold_policy_assignment_id","file_versions_on_hold"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}],"variable":[{"id":"03bda3e2-423c-41db-add5-ae99d5471ee6","key":"legal_hold_policy_assignment_id","value":"753465","description":"The ID of the legal hold policy assignment."}]},"description":"Get a list of previous file versions for a legal hold\n\nhttps://developer.box.com/reference/get-legal-hold-policy-assignments-id-file-versions-on-hold"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\",\n \"name\": \"tigers.jpeg\",\n \"size\": 629644,\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"trashed_at\": \"2012-12-12T10:53:43-08:00\",\n \"trashed_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"restored_at\": \"2012-12-12T10:53:43-08:00\",\n \"restored_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"purged_at\": \"2012-12-12T10:53:43-08:00\",\n \"uploader_display_name\": \"Ellis Wiggins\"\n }\n ]\n}"}],"_postman_id":"d9c765e8-8ffb-496c-856d-91386040bdeb"},{"name":"Assign legal hold policy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"ee1e33f7-15b8-43a3-8d72-3fc239b00ef8","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Assign a legal hold to an item type of: file, file version, folder, user, ownership, or interactions.
\nhttps://developer.box.com/reference/post-legal-hold-policy-assignments
\n","urlObject":{"protocol":"https","path":["2.0","legal_hold_policy_assignments"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"4181eea6-6593-4602-9b5a-7ef2e8c3ea5b","name":"[201] Returns a new legal hold policy assignment.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_id\": \"123244\",\n \"assign_to\": {\n \"type\": \"folder\",\n \"id\": \"6564564\"\n }\n}"},"url":"https://api.box.com/2.0/legal_hold_policy_assignments","description":"Assign a legal hold to an item type of: file, file version, folder, user, ownership, or interactions.\n\nhttps://developer.box.com/reference/post-legal-hold-policy-assignments"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"legal_hold_policy_assignment\",\n \"legal_hold_policy\": {\n \"id\": \"11446498\",\n \"type\": \"legal_hold_policy\"\n },\n \"assigned_to\": {\n \"type\": \"folder\",\n \"id\": \"6564564\"\n },\n \"assigned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"deleted_at\": \"2012-12-12T10:53:43-08:00\"\n}"}],"_postman_id":"ee1e33f7-15b8-43a3-8d72-3fc239b00ef8"},{"name":"Unassign legal hold policy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"0f6fd2c5-d427-44ce-be7c-726c332c398c","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Remove a legal hold from an item.
\nhttps://developer.box.com/reference/delete-legal-hold-policy-assignments-id
\n","urlObject":{"protocol":"https","path":["2.0","legal_hold_policy_assignments",":legal_hold_policy_assignment_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"7201e4a7-728d-4568-985d-1cb1eb953fea","description":{"content":"The ID of the legal hold policy assignment.
\n","type":"text/plain"},"type":"any","value":"753465","key":"legal_hold_policy_assignment_id"}]}},"response":[{"id":"35501a0b-2b43-4db5-be12-069229cd5b42","name":"[202] A blank response is returned if the assignment was","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/legal_hold_policy_assignments/:legal_hold_policy_assignment_id","protocol":"https","host":["api.box.com"],"path":["2.0","legal_hold_policy_assignments",":legal_hold_policy_assignment_id"],"variable":[{"id":"7201e4a7-728d-4568-985d-1cb1eb953fea","key":"legal_hold_policy_assignment_id","value":"753465","description":"The ID of the legal hold policy assignment."}]},"description":"Remove a legal hold from an item.\n\nhttps://developer.box.com/reference/delete-legal-hold-policy-assignments-id"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0f6fd2c5-d427-44ce-be7c-726c332c398c"}],"id":"5a181a0d-05ab-43a3-a57d-3c7a8327d798","_postman_id":"5a181a0d-05ab-43a3-a57d-3c7a8327d798","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves a list of all the metadata cascade policies
\nhttps://developer.box.com/reference/get-metadata-cascade-policies
\n","urlObject":{"protocol":"https","path":["2.0","metadata_cascade_policies"],"host":["api.box.com"],"query":[{"description":{"content":"Specifies which folder to return policies for. This can not be used on the\nroot folder with ID 0.
The ID of the enterprise ID for which to find metadata\ncascade policies. If not specified, it defaults to the\ncurrent enterprise.
\n","type":"text/plain"},"key":"owner_enterprise_id","value":"31232"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The offset of the item at which to begin the response.
\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.
\n","type":"text/plain"},"key":"offset","value":"1000"}],"variable":[]}},"response":[{"id":"2d711934-0965-4938-9b5e-131cb39229c6","name":"[200] Returns a list of metadata cascade policies.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_cascade_policies?folder_id=31232","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_cascade_policies"],"query":[{"key":"folder_id","value":"31232","description":"Specifies which folder to return policies for. This can not be used on the\nroot folder with ID `0`."},{"key":"owner_enterprise_id","value":"31232","description":"The ID of the enterprise ID for which to find metadata\ncascade policies. If not specified, it defaults to the\ncurrent enterprise.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"offset","value":"1000","description":"The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.","disabled":true}]},"description":"Retrieves a list of all the metadata cascade policies\n\nhttps://developer.box.com/reference/get-metadata-cascade-policies"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7\",\n \"type\": \"metadata_cascade_policy\",\n \"owner_enterprise\": {\n \"type\": \"enterprise\",\n \"id\": \"690678\"\n },\n \"parent\": {\n \"type\": \"folder\",\n \"id\": \"1234567\"\n },\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\"\n }\n ]\n}"},{"id":"c6bf7242-2069-4a1f-a40b-1e48de086329","name":"[400] Returns an error when any of the parameters are not in a valid format.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_cascade_policies?folder_id=31232","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_cascade_policies"],"query":[{"key":"folder_id","value":"31232","description":"Specifies which folder to return policies for. This can not be used on the\nroot folder with ID `0`."},{"key":"owner_enterprise_id","value":"31232","description":"The ID of the enterprise ID for which to find metadata\ncascade policies. If not specified, it defaults to the\ncurrent enterprise.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"offset","value":"1000","description":"The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.","disabled":true}]},"description":"Retrieves a list of all the metadata cascade policies\n\nhttps://developer.box.com/reference/get-metadata-cascade-policies"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"c4819132-c6d6-4e99-9b47-62a8de25ca44","name":"[403] Returns an error when the folder can not be accessed. This error often","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_cascade_policies?folder_id=31232","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_cascade_policies"],"query":[{"key":"folder_id","value":"31232","description":"Specifies which folder to return policies for. This can not be used on the\nroot folder with ID `0`."},{"key":"owner_enterprise_id","value":"31232","description":"The ID of the enterprise ID for which to find metadata\ncascade policies. If not specified, it defaults to the\ncurrent enterprise.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"offset","value":"1000","description":"The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.","disabled":true}]},"description":"Retrieves a list of all the metadata cascade policies\n\nhttps://developer.box.com/reference/get-metadata-cascade-policies"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"6572b7e3-43a8-487f-afa4-93a91ae073f8","name":"[404] Returns an error when the folder can not be found or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_cascade_policies?folder_id=31232","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_cascade_policies"],"query":[{"key":"folder_id","value":"31232","description":"Specifies which folder to return policies for. This can not be used on the\nroot folder with ID `0`."},{"key":"owner_enterprise_id","value":"31232","description":"The ID of the enterprise ID for which to find metadata\ncascade policies. If not specified, it defaults to the\ncurrent enterprise.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"offset","value":"1000","description":"The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.","disabled":true}]},"description":"Retrieves a list of all the metadata cascade policies\n\nhttps://developer.box.com/reference/get-metadata-cascade-policies"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"7bd29e63-b220-49b7-92b0-738c883630f4"},{"name":"Get metadata cascade policy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"e3e3ca67-ba89-4f97-9e76-6588b1ef8dc9","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieve a specific metadata cascade policy assigned to a folder.
\nhttps://developer.box.com/reference/get-metadata-cascade-policies-id
\n","urlObject":{"protocol":"https","path":["2.0","metadata_cascade_policies",":metadata_cascade_policy_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"d5bc90ab-4ade-43e1-adc3-45e40ba889c3","description":{"content":"The ID of the metadata cascade policy.
\n","type":"text/plain"},"type":"any","value":"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7","key":"metadata_cascade_policy_id"}]}},"response":[{"id":"bab341f4-77c0-4f06-a251-6a602f911c8f","name":"[200] Returns a metadata cascade policy.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_cascade_policies/:metadata_cascade_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_cascade_policies",":metadata_cascade_policy_id"],"variable":[{"id":"d5bc90ab-4ade-43e1-adc3-45e40ba889c3","key":"metadata_cascade_policy_id","value":"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7","description":"The ID of the metadata cascade policy."}]},"description":"Retrieve a specific metadata cascade policy assigned to a folder.\n\nhttps://developer.box.com/reference/get-metadata-cascade-policies-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7\",\n \"type\": \"metadata_cascade_policy\",\n \"owner_enterprise\": {\n \"type\": \"enterprise\",\n \"id\": \"690678\"\n },\n \"parent\": {\n \"type\": \"folder\",\n \"id\": \"1234567\"\n },\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\"\n}"},{"id":"02a4db35-b510-47fa-b7eb-7fff7fe29f30","name":"[404] Returns an error when the policy can not be found or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_cascade_policies/:metadata_cascade_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_cascade_policies",":metadata_cascade_policy_id"],"variable":[{"id":"d5bc90ab-4ade-43e1-adc3-45e40ba889c3","key":"metadata_cascade_policy_id","value":"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7","description":"The ID of the metadata cascade policy."}]},"description":"Retrieve a specific metadata cascade policy assigned to a folder.\n\nhttps://developer.box.com/reference/get-metadata-cascade-policies-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"e3e3ca67-ba89-4f97-9e76-6588b1ef8dc9"},{"name":"Create metadata cascade policy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"e1e0556f-d0a3-409e-8826-38b3a158ffa1","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates a new metadata cascade policy that applies a given
\nhttps://developer.box.com/reference/post-metadata-cascade-policies
\n","urlObject":{"protocol":"https","path":["2.0","metadata_cascade_policies"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"3de10d21-d960-4dca-820c-3a0d20ca1ef6","name":"[201] Returns a new of metadata cascade policy.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"folder_id\": \"1234567\",\n \"scope\": \"enterprise\",\n \"templateKey\": \"productInfo\"\n}"},"url":"https://api.box.com/2.0/metadata_cascade_policies","description":"Creates a new metadata cascade policy that applies a given\n\nhttps://developer.box.com/reference/post-metadata-cascade-policies"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7\",\n \"type\": \"metadata_cascade_policy\",\n \"owner_enterprise\": {\n \"type\": \"enterprise\",\n \"id\": \"690678\"\n },\n \"parent\": {\n \"type\": \"folder\",\n \"id\": \"1234567\"\n },\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\"\n}"},{"id":"ca56661d-8c62-4a64-a19a-c15c8e310baf","name":"[400] Returns an error when any of the parameters are not in a valid format.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"folder_id\": \"1234567\",\n \"scope\": \"enterprise\",\n \"templateKey\": \"productInfo\"\n}"},"url":"https://api.box.com/2.0/metadata_cascade_policies","description":"Creates a new metadata cascade policy that applies a given\n\nhttps://developer.box.com/reference/post-metadata-cascade-policies"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"8f1dc796-3436-4731-91fb-625ff5ba73de","name":"[403] Returns an error when trying to apply a policy to a restricted folder, for","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"folder_id\": \"1234567\",\n \"scope\": \"enterprise\",\n \"templateKey\": \"productInfo\"\n}"},"url":"https://api.box.com/2.0/metadata_cascade_policies","description":"Creates a new metadata cascade policy that applies a given\n\nhttps://developer.box.com/reference/post-metadata-cascade-policies"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"504cf931-6974-467f-816f-7ce6a05d7a42","name":"[404] Returns an error when the template or folder can not be found, or when the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"folder_id\": \"1234567\",\n \"scope\": \"enterprise\",\n \"templateKey\": \"productInfo\"\n}"},"url":"https://api.box.com/2.0/metadata_cascade_policies","description":"Creates a new metadata cascade policy that applies a given\n\nhttps://developer.box.com/reference/post-metadata-cascade-policies"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"2bb63d26-b6a6-49dc-8d5a-b9158a25fc53","name":"[409] Returns an error when a policy for this folder and template is already in","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"folder_id\": \"1234567\",\n \"scope\": \"enterprise\",\n \"templateKey\": \"productInfo\"\n}"},"url":"https://api.box.com/2.0/metadata_cascade_policies","description":"Creates a new metadata cascade policy that applies a given\n\nhttps://developer.box.com/reference/post-metadata-cascade-policies"},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"e1e0556f-d0a3-409e-8826-38b3a158ffa1"},{"name":"Force-apply metadata cascade policy to folder","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"eece9dc9-5c6b-442f-b5ca-b2f8fcd9ea7c","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Force the metadata on a folder with a metadata cascade policy to be applied to
\nhttps://developer.box.com/reference/post-metadata-cascade-policies-id-apply
\n","urlObject":{"protocol":"https","path":["2.0","metadata_cascade_policies",":metadata_cascade_policy_id","apply"],"host":["api.box.com"],"query":[],"variable":[{"id":"c72ce545-26a5-4068-b76c-8a8ce5f8192b","description":{"content":"The ID of the cascade policy to force-apply.
\n","type":"text/plain"},"type":"any","value":"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7","key":"metadata_cascade_policy_id"}]}},"response":[{"id":"644965ef-b28b-4360-98a4-39a8c0b36a24","name":"[202] Returns an empty response when the API call was successful. The metadata","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"conflict_resolution\": \"none\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_cascade_policies/:metadata_cascade_policy_id/apply","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_cascade_policies",":metadata_cascade_policy_id","apply"],"variable":[{"id":"c72ce545-26a5-4068-b76c-8a8ce5f8192b","key":"metadata_cascade_policy_id","value":"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7","description":"The ID of the cascade policy to force-apply."}]},"description":"Force the metadata on a folder with a metadata cascade policy to be applied to\n\nhttps://developer.box.com/reference/post-metadata-cascade-policies-id-apply"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"db975a33-8132-47ab-8bf2-1966191dcc70","name":"[404] Returns an error when the policy can not be found or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"conflict_resolution\": \"none\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_cascade_policies/:metadata_cascade_policy_id/apply","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_cascade_policies",":metadata_cascade_policy_id","apply"],"variable":[{"id":"c72ce545-26a5-4068-b76c-8a8ce5f8192b","key":"metadata_cascade_policy_id","value":"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7","description":"The ID of the cascade policy to force-apply."}]},"description":"Force the metadata on a folder with a metadata cascade policy to be applied to\n\nhttps://developer.box.com/reference/post-metadata-cascade-policies-id-apply"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"eece9dc9-5c6b-442f-b5ca-b2f8fcd9ea7c"},{"name":"Remove metadata cascade policy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"7abb97c3-5f1e-41cb-be2c-cb03b289882d","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Deletes a metadata cascade policy.
\nhttps://developer.box.com/reference/delete-metadata-cascade-policies-id
\n","urlObject":{"protocol":"https","path":["2.0","metadata_cascade_policies",":metadata_cascade_policy_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"6201a79f-545c-46ae-aade-b623a1df3c76","description":{"content":"The ID of the metadata cascade policy.
\n","type":"text/plain"},"type":"any","value":"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7","key":"metadata_cascade_policy_id"}]}},"response":[{"id":"6692f78c-8c4c-48bb-9e03-ac16d2639a6f","name":"[204] Returns an empty response when the policy","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_cascade_policies/:metadata_cascade_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_cascade_policies",":metadata_cascade_policy_id"],"variable":[{"id":"6201a79f-545c-46ae-aade-b623a1df3c76","key":"metadata_cascade_policy_id","value":"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7","description":"The ID of the metadata cascade policy."}]},"description":"Deletes a metadata cascade policy.\n\nhttps://developer.box.com/reference/delete-metadata-cascade-policies-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"c70338fe-dc1c-4252-bede-71ffdf26f426","name":"[404] Returns an error when the policy can not be found or the user does not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_cascade_policies/:metadata_cascade_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_cascade_policies",":metadata_cascade_policy_id"],"variable":[{"id":"6201a79f-545c-46ae-aade-b623a1df3c76","key":"metadata_cascade_policy_id","value":"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7","description":"The ID of the metadata cascade policy."}]},"description":"Deletes a metadata cascade policy.\n\nhttps://developer.box.com/reference/delete-metadata-cascade-policies-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"7abb97c3-5f1e-41cb-be2c-cb03b289882d"}],"id":"1f2e8c8a-4c9b-4ade-b7c5-2ab00e03a830","_postman_id":"1f2e8c8a-4c9b-4ade-b7c5-2ab00e03a830","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves all metadata for a given file.
\nhttps://developer.box.com/reference/get-files-id-metadata
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","metadata"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Taxonomy field values are returned in API view by default, meaning \nthe value is represented with a taxonomy node identifier. \nTo retrieve the Hydrated view, where taxonomy values are represented \nwith the full taxonomy node information, set this parameter to hydrated. \nThis is the only supported value for this parameter.
The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
Retrieves the instance of a metadata template that has been applied to a
\nhttps://developer.box.com/reference/get-files-id-metadata-id-id
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","metadata",":scope",":template_key"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Taxonomy field values are returned in API view by default, meaning \nthe value is represented with a taxonomy node identifier. \nTo retrieve the Hydrated view, where taxonomy values are represented \nwith the full taxonomy node information, set this parameter to hydrated. \nThis is the only supported value for this parameter.
The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
The scope of the metadata template.
\n","type":"text/plain"},"type":"any","value":"global","key":"scope"},{"id":"6a4ba2d5-678d-4650-9d42-e1e76d001046","description":{"content":"The name of the metadata template.
\n","type":"text/plain"},"type":"any","value":"properties","key":"template_key"}]}},"response":[{"id":"b51974fb-01d6-44ef-a8fd-3cd45d01a453","name":"[201] An instance of the metadata template that includes","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/files/:file_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","metadata",":scope",":template_key"],"query":[{"key":"view","value":"hydrated","description":"Taxonomy field values are returned in `API view` by default, meaning \nthe value is represented with a taxonomy node identifier. \nTo retrieve the `Hydrated view`, where taxonomy values are represented \nwith the full taxonomy node information, set this parameter to `hydrated`. \nThis is the only supported value for this parameter.","disabled":true}],"variable":[{"id":"18498ed0-93fa-405e-b3a8-a1538726aa3a","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"a6953d16-773d-4b32-9789-f550ac0f099e","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"6a4ba2d5-678d-4650-9d42-e1e76d001046","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Retrieves the instance of a metadata template that has been applied to a\n\nhttps://developer.box.com/reference/get-files-id-metadata-id-id"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"$parent\": \"folder_59449484661,\",\n \"$template\": \"marketingCollateral\",\n \"$scope\": \"enterprise_27335\",\n \"$version\": 1,\n \"$canEdit\": true,\n \"$id\": \"01234500-12f1-1234-aa12-b1d234cb567e\",\n \"$type\": \"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0\",\n \"$typeVersion\": 2\n}"},{"id":"ef27cec3-3aed-4164-a996-720dec14c968","name":"[400] Returned when the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/files/:file_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","metadata",":scope",":template_key"],"query":[{"key":"view","value":"hydrated","description":"Taxonomy field values are returned in `API view` by default, meaning \nthe value is represented with a taxonomy node identifier. \nTo retrieve the `Hydrated view`, where taxonomy values are represented \nwith the full taxonomy node information, set this parameter to `hydrated`. \nThis is the only supported value for this parameter.","disabled":true}],"variable":[{"id":"18498ed0-93fa-405e-b3a8-a1538726aa3a","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"a6953d16-773d-4b32-9789-f550ac0f099e","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"6a4ba2d5-678d-4650-9d42-e1e76d001046","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Retrieves the instance of a metadata template that has been applied to a\n\nhttps://developer.box.com/reference/get-files-id-metadata-id-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"912bb256-fc6a-4480-b706-0fed2302642e","name":"[404] Returned if the metadata template specified","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/files/:file_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","metadata",":scope",":template_key"],"query":[{"key":"view","value":"hydrated","description":"Taxonomy field values are returned in `API view` by default, meaning \nthe value is represented with a taxonomy node identifier. \nTo retrieve the `Hydrated view`, where taxonomy values are represented \nwith the full taxonomy node information, set this parameter to `hydrated`. \nThis is the only supported value for this parameter.","disabled":true}],"variable":[{"id":"18498ed0-93fa-405e-b3a8-a1538726aa3a","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"a6953d16-773d-4b32-9789-f550ac0f099e","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"6a4ba2d5-678d-4650-9d42-e1e76d001046","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Retrieves the instance of a metadata template that has been applied to a\n\nhttps://developer.box.com/reference/get-files-id-metadata-id-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"26cebfb6-fb60-44cd-ac03-b9e2b0f24c51","name":"[405] Returned when the method was not allowed.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/files/:file_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","metadata",":scope",":template_key"],"query":[{"key":"view","value":"hydrated","description":"Taxonomy field values are returned in `API view` by default, meaning \nthe value is represented with a taxonomy node identifier. \nTo retrieve the `Hydrated view`, where taxonomy values are represented \nwith the full taxonomy node information, set this parameter to `hydrated`. \nThis is the only supported value for this parameter.","disabled":true}],"variable":[{"id":"18498ed0-93fa-405e-b3a8-a1538726aa3a","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"a6953d16-773d-4b32-9789-f550ac0f099e","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"6a4ba2d5-678d-4650-9d42-e1e76d001046","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Retrieves the instance of a metadata template that has been applied to a\n\nhttps://developer.box.com/reference/get-files-id-metadata-id-id"},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"999e075d-3d97-4f36-8989-a4bf3b662f0e"},{"name":"Create metadata instance on file","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"1ccbd446-ad47-4224-a341-52f3c3ad19f7","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Applies an instance of a metadata template to a file.
\nhttps://developer.box.com/reference/post-files-id-metadata-id-id
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","metadata",":scope",":template_key"],"host":["api.box.com"],"query":[],"variable":[{"id":"1f4c43e5-1082-41a2-825c-98cf08e6c8ba","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
The scope of the metadata template.
\n","type":"text/plain"},"type":"any","value":"global","key":"scope"},{"id":"482f6c31-2d05-465b-aa3a-59422e0d5b55","description":{"content":"The name of the metadata template.
\n","type":"text/plain"},"type":"any","value":"properties","key":"template_key"}]}},"response":[{"id":"23bbba18-f9e4-4861-9be4-121c5e008d32","name":"[201] Returns the instance of the template that was applied to the file,","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/files/:file_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","metadata",":scope",":template_key"],"variable":[{"id":"1f4c43e5-1082-41a2-825c-98cf08e6c8ba","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"4ffd8c5c-c177-4b15-a249-b7dd7dc957bd","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"482f6c31-2d05-465b-aa3a-59422e0d5b55","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Applies an instance of a metadata template to a file.\n\nhttps://developer.box.com/reference/post-files-id-metadata-id-id"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"$parent\": \"folder_59449484661,\",\n \"$template\": \"marketingCollateral\",\n \"$scope\": \"enterprise_27335\",\n \"$version\": 1,\n \"$canEdit\": true,\n \"$id\": \"01234500-12f1-1234-aa12-b1d234cb567e\",\n \"$type\": \"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0\",\n \"$typeVersion\": 2\n}"},{"id":"db12fd84-2e1a-46b7-92ec-79f25e802cf9","name":"[400] Returns an error when the request body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/files/:file_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","metadata",":scope",":template_key"],"variable":[{"id":"1f4c43e5-1082-41a2-825c-98cf08e6c8ba","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"4ffd8c5c-c177-4b15-a249-b7dd7dc957bd","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"482f6c31-2d05-465b-aa3a-59422e0d5b55","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Applies an instance of a metadata template to a file.\n\nhttps://developer.box.com/reference/post-files-id-metadata-id-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"bad_request\",\n \"message\": \"Encountered invalid value for template field key=someKey field type=properties\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"7825c380-017b-42fd-a944-b3466bb7f3f3","name":"[404] Returns an error when the file or metadata template was not found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/files/:file_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","metadata",":scope",":template_key"],"variable":[{"id":"1f4c43e5-1082-41a2-825c-98cf08e6c8ba","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"4ffd8c5c-c177-4b15-a249-b7dd7dc957bd","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"482f6c31-2d05-465b-aa3a-59422e0d5b55","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Applies an instance of a metadata template to a file.\n\nhttps://developer.box.com/reference/post-files-id-metadata-id-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"011f632e-0539-4047-9729-4f5ee4f89e53","name":"[409] Returns an error when an instance of this metadata template is already","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/files/:file_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","metadata",":scope",":template_key"],"variable":[{"id":"1f4c43e5-1082-41a2-825c-98cf08e6c8ba","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"4ffd8c5c-c177-4b15-a249-b7dd7dc957bd","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"482f6c31-2d05-465b-aa3a-59422e0d5b55","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Applies an instance of a metadata template to a file.\n\nhttps://developer.box.com/reference/post-files-id-metadata-id-id"},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"bad_request\",\n \"message\": \"Encountered invalid value for template field key=someKey field type=properties\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"1ccbd446-ad47-4224-a341-52f3c3ad19f7"},{"name":"Update metadata instance on file","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"827e264e-e623-4bdd-89d6-fbdbba6fc651","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Updates a piece of metadata on a file.
\nhttps://developer.box.com/reference/put-files-id-metadata-id-id
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","metadata",":scope",":template_key"],"host":["api.box.com"],"query":[],"variable":[{"id":"ddfaac52-2619-4ecb-b940-fdc23d7f113b","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
The scope of the metadata template.
\n","type":"text/plain"},"type":"any","value":"global","key":"scope"},{"id":"e2f2cf75-c89b-4d93-b940-1130175146d8","description":{"content":"The name of the metadata template.
\n","type":"text/plain"},"type":"any","value":"properties","key":"template_key"}]}},"response":[{"id":"9932b412-06bf-49ee-842b-7ee98cc5485b","name":"[200] Returns the updated metadata template instance, with the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/files/:file_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","metadata",":scope",":template_key"],"variable":[{"id":"ddfaac52-2619-4ecb-b940-fdc23d7f113b","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"086c641c-3753-4463-9c03-62fe151dec4b","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"e2f2cf75-c89b-4d93-b940-1130175146d8","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Updates a piece of metadata on a file.\n\nhttps://developer.box.com/reference/put-files-id-metadata-id-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"$parent\": \"folder_59449484661,\",\n \"$template\": \"marketingCollateral\",\n \"$scope\": \"enterprise_27335\",\n \"$version\": 1,\n \"$canEdit\": true,\n \"$id\": \"01234500-12f1-1234-aa12-b1d234cb567e\",\n \"$type\": \"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0\",\n \"$typeVersion\": 2\n}"},{"id":"13f8973a-cfd7-404b-b5ba-c0fbb287418f","name":"[400] Returns an error when the request body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/files/:file_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","metadata",":scope",":template_key"],"variable":[{"id":"ddfaac52-2619-4ecb-b940-fdc23d7f113b","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"086c641c-3753-4463-9c03-62fe151dec4b","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"e2f2cf75-c89b-4d93-b940-1130175146d8","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Updates a piece of metadata on a file.\n\nhttps://developer.box.com/reference/put-files-id-metadata-id-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"58acf91d-216e-467f-9744-2778cb4aa109","name":"[500] Returns an error in some edge cases when the request body is not a valid","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/files/:file_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","metadata",":scope",":template_key"],"variable":[{"id":"ddfaac52-2619-4ecb-b940-fdc23d7f113b","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"086c641c-3753-4463-9c03-62fe151dec4b","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"e2f2cf75-c89b-4d93-b940-1130175146d8","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Updates a piece of metadata on a file.\n\nhttps://developer.box.com/reference/put-files-id-metadata-id-id"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"827e264e-e623-4bdd-89d6-fbdbba6fc651"},{"name":"Remove metadata instance from file","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"cc77f20c-5446-4202-b6cc-23e43b04b9c1","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Deletes a piece of file metadata.
\nhttps://developer.box.com/reference/delete-files-id-metadata-id-id
\n","urlObject":{"protocol":"https","path":["2.0","files",":file_id","metadata",":scope",":template_key"],"host":["api.box.com"],"query":[],"variable":[{"id":"00cab2ee-14f6-4b7b-a449-b1e78e4f2172","description":{"content":"The unique identifier that represents a file.
\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/files/123\nthe file_id is 123.
The scope of the metadata template.
\n","type":"text/plain"},"type":"any","value":"global","key":"scope"},{"id":"da07a548-39f3-4538-87ac-023b0940d27e","description":{"content":"The name of the metadata template.
\n","type":"text/plain"},"type":"any","value":"properties","key":"template_key"}]}},"response":[{"id":"14f37ab9-1831-4ca0-989d-89d4761e18ac","name":"[204] Returns an empty response when the metadata is","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/files/:file_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","metadata",":scope",":template_key"],"variable":[{"id":"00cab2ee-14f6-4b7b-a449-b1e78e4f2172","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"5548d08d-adbe-4272-844e-a31837e2f063","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"da07a548-39f3-4538-87ac-023b0940d27e","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Deletes a piece of file metadata.\n\nhttps://developer.box.com/reference/delete-files-id-metadata-id-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"708e5cd3-397a-4b2c-bf28-7743ae4e8d5a","name":"[400] Returned when the request parameters are not valid. This may happen of the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/files/:file_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","metadata",":scope",":template_key"],"variable":[{"id":"00cab2ee-14f6-4b7b-a449-b1e78e4f2172","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"5548d08d-adbe-4272-844e-a31837e2f063","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"da07a548-39f3-4538-87ac-023b0940d27e","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Deletes a piece of file metadata.\n\nhttps://developer.box.com/reference/delete-files-id-metadata-id-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"55905020-1d4b-46fd-927a-b935beaa0026","name":"[404] Returns an error when the file does not have an instance of the metadata","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/files/:file_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","metadata",":scope",":template_key"],"variable":[{"id":"00cab2ee-14f6-4b7b-a449-b1e78e4f2172","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"5548d08d-adbe-4272-844e-a31837e2f063","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"da07a548-39f3-4538-87ac-023b0940d27e","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Deletes a piece of file metadata.\n\nhttps://developer.box.com/reference/delete-files-id-metadata-id-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"3e84205b-c5dc-45a0-9af6-b3a25131f42b","name":"[405] Returned when the method was not allowed.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/files/:file_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","files",":file_id","metadata",":scope",":template_key"],"variable":[{"id":"00cab2ee-14f6-4b7b-a449-b1e78e4f2172","key":"file_id","value":"12345","description":"The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."},{"id":"5548d08d-adbe-4272-844e-a31837e2f063","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"da07a548-39f3-4538-87ac-023b0940d27e","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Deletes a piece of file metadata.\n\nhttps://developer.box.com/reference/delete-files-id-metadata-id-id"},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"cc77f20c-5446-4202-b6cc-23e43b04b9c1"}],"id":"37353aac-94fb-41d3-ac2c-da2a8f17bb7c","_postman_id":"37353aac-94fb-41d3-ac2c-da2a8f17bb7c","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves all metadata for a given folder. This can not be used on the root
\nhttps://developer.box.com/reference/get-folders-id-metadata
\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id","metadata"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Taxonomy field values are returned in API view by default, meaning \nthe value is represented with a taxonomy node identifier. \nTo retrieve the Hydrated view, where taxonomy values are represented \nwith the full taxonomy node information, set this parameter to hydrated. \nThis is the only supported value for this parameter.
The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder of a Box account is\nalways represented by the ID 0.
Retrieves the instance of a metadata template that has been applied to a
\nhttps://developer.box.com/reference/get-folders-id-metadata-id-id
\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"host":["api.box.com"],"query":[],"variable":[{"id":"7aa728d6-a3a1-4a06-bbfd-e91df772d2e2","description":{"content":"The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder of a Box account is\nalways represented by the ID 0.
The scope of the metadata template.
\n","type":"text/plain"},"type":"any","value":"global","key":"scope"},{"id":"fa95e117-0309-4efc-81db-d718a271a9cf","description":{"content":"The name of the metadata template.
\n","type":"text/plain"},"type":"any","value":"properties","key":"template_key"}]}},"response":[{"id":"61551fa0-ad51-425d-912e-a1d62adb490f","name":"[201] An instance of the metadata template that includes","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/folders/:folder_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"variable":[{"id":"7aa728d6-a3a1-4a06-bbfd-e91df772d2e2","key":"folder_id","value":"12345","description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."},{"id":"d1c18e1b-00ec-42e2-a25e-90077c8a7e0c","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"fa95e117-0309-4efc-81db-d718a271a9cf","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Retrieves the instance of a metadata template that has been applied to a\n\nhttps://developer.box.com/reference/get-folders-id-metadata-id-id"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"$parent\": \"folder_59449484661,\",\n \"$template\": \"marketingCollateral\",\n \"$scope\": \"enterprise_27335\",\n \"$version\": 1,\n \"$canEdit\": true,\n \"$id\": \"01234500-12f1-1234-aa12-b1d234cb567e\",\n \"$type\": \"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0\",\n \"$typeVersion\": 2\n}"},{"id":"0880cc85-6a67-4f1d-9766-985e8cc3c7ef","name":"[403] Returned when the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/folders/:folder_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"variable":[{"id":"7aa728d6-a3a1-4a06-bbfd-e91df772d2e2","key":"folder_id","value":"12345","description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."},{"id":"d1c18e1b-00ec-42e2-a25e-90077c8a7e0c","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"fa95e117-0309-4efc-81db-d718a271a9cf","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Retrieves the instance of a metadata template that has been applied to a\n\nhttps://developer.box.com/reference/get-folders-id-metadata-id-id"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"122177a2-0821-4d04-bc90-af35cb410993","name":"[404] Returned if the metadata template specified","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/folders/:folder_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"variable":[{"id":"7aa728d6-a3a1-4a06-bbfd-e91df772d2e2","key":"folder_id","value":"12345","description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."},{"id":"d1c18e1b-00ec-42e2-a25e-90077c8a7e0c","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"fa95e117-0309-4efc-81db-d718a271a9cf","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Retrieves the instance of a metadata template that has been applied to a\n\nhttps://developer.box.com/reference/get-folders-id-metadata-id-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"4a3273f7-08eb-4bb3-beaf-72a4f2aebc12","name":"[405] Returned when the method was not allowed. This often happens when the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/folders/:folder_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"variable":[{"id":"7aa728d6-a3a1-4a06-bbfd-e91df772d2e2","key":"folder_id","value":"12345","description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."},{"id":"d1c18e1b-00ec-42e2-a25e-90077c8a7e0c","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"fa95e117-0309-4efc-81db-d718a271a9cf","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Retrieves the instance of a metadata template that has been applied to a\n\nhttps://developer.box.com/reference/get-folders-id-metadata-id-id"},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"5db06224-67d3-4eec-91b0-3832c8358ef9"},{"name":"Create metadata instance on folder","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"dc71f46c-360f-4464-850a-40a57833ea87","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Applies an instance of a metadata template to a folder.
\nhttps://developer.box.com/reference/post-folders-id-metadata-id-id
\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"host":["api.box.com"],"query":[],"variable":[{"id":"6aeaecc7-993d-4939-aa19-ba4d8f7bb27c","description":{"content":"The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder of a Box account is\nalways represented by the ID 0.
The scope of the metadata template.
\n","type":"text/plain"},"type":"any","value":"global","key":"scope"},{"id":"a9108167-c47d-4af9-9f55-2ad817cefd2f","description":{"content":"The name of the metadata template.
\n","type":"text/plain"},"type":"any","value":"properties","key":"template_key"}]}},"response":[{"id":"5013eaf7-dc9d-4484-b999-228477002c09","name":"[201] Returns the instance of the template that was applied to the folder,","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/folders/:folder_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"variable":[{"id":"6aeaecc7-993d-4939-aa19-ba4d8f7bb27c","key":"folder_id","value":"12345","description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."},{"id":"69475fbe-d0e5-4534-b6f1-7f40818ff5f0","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"a9108167-c47d-4af9-9f55-2ad817cefd2f","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Applies an instance of a metadata template to a folder.\n\nhttps://developer.box.com/reference/post-folders-id-metadata-id-id"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"$parent\": \"folder_59449484661,\",\n \"$template\": \"marketingCollateral\",\n \"$scope\": \"enterprise_27335\",\n \"$version\": 1,\n \"$canEdit\": true,\n \"$id\": \"01234500-12f1-1234-aa12-b1d234cb567e\",\n \"$type\": \"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0\",\n \"$typeVersion\": 2\n}"},{"id":"ea29475c-61e1-4f60-a7a0-9f7a4d4f238a","name":"[400] Returns an error when the request body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/folders/:folder_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"variable":[{"id":"6aeaecc7-993d-4939-aa19-ba4d8f7bb27c","key":"folder_id","value":"12345","description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."},{"id":"69475fbe-d0e5-4534-b6f1-7f40818ff5f0","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"a9108167-c47d-4af9-9f55-2ad817cefd2f","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Applies an instance of a metadata template to a folder.\n\nhttps://developer.box.com/reference/post-folders-id-metadata-id-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"bad_request\",\n \"message\": \"Encountered invalid value for template field key=someKey field type=properties\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"0bfe54f7-a690-4c2c-8031-848e2289a652","name":"[404] Returns an error when the folder or metadata template was not found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/folders/:folder_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"variable":[{"id":"6aeaecc7-993d-4939-aa19-ba4d8f7bb27c","key":"folder_id","value":"12345","description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."},{"id":"69475fbe-d0e5-4534-b6f1-7f40818ff5f0","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"a9108167-c47d-4af9-9f55-2ad817cefd2f","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Applies an instance of a metadata template to a folder.\n\nhttps://developer.box.com/reference/post-folders-id-metadata-id-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"b30d2716-28e8-41bf-83cd-065e0bc2c102","name":"[409] Returns an error when an instance of this metadata template is already","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/folders/:folder_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"variable":[{"id":"6aeaecc7-993d-4939-aa19-ba4d8f7bb27c","key":"folder_id","value":"12345","description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."},{"id":"69475fbe-d0e5-4534-b6f1-7f40818ff5f0","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"a9108167-c47d-4af9-9f55-2ad817cefd2f","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Applies an instance of a metadata template to a folder.\n\nhttps://developer.box.com/reference/post-folders-id-metadata-id-id"},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"bad_request\",\n \"message\": \"Encountered invalid value for template field key=someKey field type=properties\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"dc71f46c-360f-4464-850a-40a57833ea87"},{"name":"Update metadata instance on folder","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"b779d10b-f4e8-4e5a-9942-95d7635dd27a","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Updates a piece of metadata on a folder.
\nhttps://developer.box.com/reference/put-folders-id-metadata-id-id
\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"host":["api.box.com"],"query":[],"variable":[{"id":"d35aee93-6bea-4497-9069-0b05330ddcac","description":{"content":"The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder of a Box account is\nalways represented by the ID 0.
The scope of the metadata template.
\n","type":"text/plain"},"type":"any","value":"global","key":"scope"},{"id":"582e67e1-7052-41ac-81f5-8ed23a4ef78d","description":{"content":"The name of the metadata template.
\n","type":"text/plain"},"type":"any","value":"properties","key":"template_key"}]}},"response":[{"id":"e00e9ba4-03cc-4a87-a457-78025306a319","name":"[200] Returns the updated metadata template instance, with the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/folders/:folder_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"variable":[{"id":"d35aee93-6bea-4497-9069-0b05330ddcac","key":"folder_id","value":"12345","description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."},{"id":"03c50d5e-e668-41d9-82fa-cca2fef971e6","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"582e67e1-7052-41ac-81f5-8ed23a4ef78d","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Updates a piece of metadata on a folder.\n\nhttps://developer.box.com/reference/put-folders-id-metadata-id-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"$parent\": \"folder_59449484661,\",\n \"$template\": \"marketingCollateral\",\n \"$scope\": \"enterprise_27335\",\n \"$version\": 1,\n \"$canEdit\": true,\n \"$id\": \"01234500-12f1-1234-aa12-b1d234cb567e\",\n \"$type\": \"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0\",\n \"$typeVersion\": 2\n}"},{"id":"7c787fed-d2d9-4982-a6f2-955c40ac9141","name":"[400] Returns an error when the request body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/folders/:folder_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"variable":[{"id":"d35aee93-6bea-4497-9069-0b05330ddcac","key":"folder_id","value":"12345","description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."},{"id":"03c50d5e-e668-41d9-82fa-cca2fef971e6","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"582e67e1-7052-41ac-81f5-8ed23a4ef78d","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Updates a piece of metadata on a folder.\n\nhttps://developer.box.com/reference/put-folders-id-metadata-id-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"3e8bfcd3-baae-465b-8c3c-ccf3ba1028f8","name":"[500] Returns an error in some edge cases when the request body is not a valid","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/folders/:folder_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"variable":[{"id":"d35aee93-6bea-4497-9069-0b05330ddcac","key":"folder_id","value":"12345","description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."},{"id":"03c50d5e-e668-41d9-82fa-cca2fef971e6","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"582e67e1-7052-41ac-81f5-8ed23a4ef78d","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Updates a piece of metadata on a folder.\n\nhttps://developer.box.com/reference/put-folders-id-metadata-id-id"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"b779d10b-f4e8-4e5a-9942-95d7635dd27a"},{"name":"Remove metadata instance from folder","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"e8f4a5ec-42f9-42f0-abef-91cbd580956a","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Deletes a piece of folder metadata.
\nhttps://developer.box.com/reference/delete-folders-id-metadata-id-id
\n","urlObject":{"protocol":"https","path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"host":["api.box.com"],"query":[],"variable":[{"id":"bf1a4576-ceb2-47f8-9831-cf20556d2c34","description":{"content":"The unique identifier that represent a folder.
\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL https://*.app.box.com/folder/123\nthe folder_id is 123.
The root folder of a Box account is\nalways represented by the ID 0.
The scope of the metadata template.
\n","type":"text/plain"},"type":"any","value":"global","key":"scope"},{"id":"f9fe850f-9c33-42d7-a8ad-f407c537f8b1","description":{"content":"The name of the metadata template.
\n","type":"text/plain"},"type":"any","value":"properties","key":"template_key"}]}},"response":[{"id":"5f8cf355-c3c3-4f14-bfb3-349d0843ff74","name":"[204] Returns an empty response when the metadata is","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/folders/:folder_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"variable":[{"id":"bf1a4576-ceb2-47f8-9831-cf20556d2c34","key":"folder_id","value":"12345","description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."},{"id":"d678ced6-2a0b-4611-9045-7c4420097a6a","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"f9fe850f-9c33-42d7-a8ad-f407c537f8b1","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Deletes a piece of folder metadata.\n\nhttps://developer.box.com/reference/delete-folders-id-metadata-id-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"5d3be156-37ce-4bac-97f7-0e8ca81ce26d","name":"[400] Returned when the request parameters are not valid. This may happen of the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/folders/:folder_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"variable":[{"id":"bf1a4576-ceb2-47f8-9831-cf20556d2c34","key":"folder_id","value":"12345","description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."},{"id":"d678ced6-2a0b-4611-9045-7c4420097a6a","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"f9fe850f-9c33-42d7-a8ad-f407c537f8b1","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Deletes a piece of folder metadata.\n\nhttps://developer.box.com/reference/delete-folders-id-metadata-id-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"e422f3cc-ccf1-4d66-aebb-2fe849704f00","name":"[404] Returns an error when the folder does not have an instance of the metadata","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/folders/:folder_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"variable":[{"id":"bf1a4576-ceb2-47f8-9831-cf20556d2c34","key":"folder_id","value":"12345","description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."},{"id":"d678ced6-2a0b-4611-9045-7c4420097a6a","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"f9fe850f-9c33-42d7-a8ad-f407c537f8b1","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Deletes a piece of folder metadata.\n\nhttps://developer.box.com/reference/delete-folders-id-metadata-id-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"87e5f3d3-8a98-4eff-ad14-4b7526270ec6","name":"[405] Returned when the method was not allowed. This often happens when the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/folders/:folder_id/metadata/:scope/:template_key","protocol":"https","host":["api.box.com"],"path":["2.0","folders",":folder_id","metadata",":scope",":template_key"],"variable":[{"id":"bf1a4576-ceb2-47f8-9831-cf20556d2c34","key":"folder_id","value":"12345","description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."},{"id":"d678ced6-2a0b-4611-9045-7c4420097a6a","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"f9fe850f-9c33-42d7-a8ad-f407c537f8b1","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Deletes a piece of folder metadata.\n\nhttps://developer.box.com/reference/delete-folders-id-metadata-id-id"},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"e8f4a5ec-42f9-42f0-abef-91cbd580956a"}],"id":"e36216b2-9852-4dba-9949-f28174745a85","_postman_id":"e36216b2-9852-4dba-9949-f28174745a85","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Used to retrieve all metadata taxonomies in a namespace.
\nhttps://developer.box.com/reference/get-metadata-taxonomies-id
\n","urlObject":{"protocol":"https","path":["2.0","metadata_taxonomies",":namespace"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[{"id":"105624d2-49ea-4c26-ad78-5295749475f6","description":{"content":"The namespace of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"enterprise_123456","key":"namespace"}]}},"response":[{"id":"c3b1f1bd-104b-47cc-b3a2-189c98d89a53","name":"[200] Returns all of the metadata taxonomies within a namespace","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"105624d2-49ea-4c26-ad78-5295749475f6","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."}]},"description":"Used to retrieve all metadata taxonomies in a namespace.\n\nhttps://developer.box.com/reference/get-metadata-taxonomies-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\",\n \"key\": \"geography\",\n \"displayName\": \"Geography\",\n \"namespace\": \"enterprise_123456\",\n \"levels\": [\n {\n \"displayName\": \"Continent\",\n \"description\": \"Continent\",\n \"level\": 1\n }\n ]\n }\n ]\n}"},{"id":"ee6ee588-58aa-4368-9b50-df491b6e5e24","name":"[400] Returned when the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"105624d2-49ea-4c26-ad78-5295749475f6","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."}]},"description":"Used to retrieve all metadata taxonomies in a namespace.\n\nhttps://developer.box.com/reference/get-metadata-taxonomies-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"fca5e8a2-5234-4866-8f61-b2eb443f90f3"},{"name":"Get metadata taxonomy by taxonomy key","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"38e415bd-a6f0-4fec-8613-1fb5167c070f","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Used to retrieve a metadata taxonomy by taxonomy key.
\nhttps://developer.box.com/reference/get-metadata-taxonomies-id-id
\n","urlObject":{"protocol":"https","path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key"],"host":["api.box.com"],"query":[],"variable":[{"id":"4004a80b-2856-4a37-b118-c82ec463da79","description":{"content":"The namespace of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"enterprise_123456","key":"namespace"},{"id":"f4208493-4df9-4295-95a9-72a8d4cc8dca","description":{"content":"The key of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"geography","key":"taxonomy_key"}]}},"response":[{"id":"fed185c3-3e02-4d5b-9a2c-6eb05dec736c","name":"[200] Returns the metadata taxonomy identified by the taxonomy key.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key"],"variable":[{"id":"4004a80b-2856-4a37-b118-c82ec463da79","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"f4208493-4df9-4295-95a9-72a8d4cc8dca","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Used to retrieve a metadata taxonomy by taxonomy key.\n\nhttps://developer.box.com/reference/get-metadata-taxonomies-id-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\",\n \"key\": \"geography\",\n \"displayName\": \"Geography\",\n \"namespace\": \"enterprise_123456\",\n \"levels\": [\n {\n \"displayName\": \"Continent\",\n \"description\": \"Continent\",\n \"level\": 1\n }\n ]\n}"},{"id":"cfa0c9c1-6eab-40c3-a9fb-aff93e9b17a3","name":"[400] Returned when the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key"],"variable":[{"id":"4004a80b-2856-4a37-b118-c82ec463da79","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"f4208493-4df9-4295-95a9-72a8d4cc8dca","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Used to retrieve a metadata taxonomy by taxonomy key.\n\nhttps://developer.box.com/reference/get-metadata-taxonomies-id-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"c1dc8529-9d13-445d-82af-6c08937540d5","name":"[404] Returned when a taxonomy with the given `namespace` and `taxonomy_key` cannot","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key"],"variable":[{"id":"4004a80b-2856-4a37-b118-c82ec463da79","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"f4208493-4df9-4295-95a9-72a8d4cc8dca","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Used to retrieve a metadata taxonomy by taxonomy key.\n\nhttps://developer.box.com/reference/get-metadata-taxonomies-id-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"38e415bd-a6f0-4fec-8613-1fb5167c070f"},{"name":"List metadata taxonomy nodes","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"9f3f3c6c-b561-4b7b-89b0-cd49391fa46c","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Used to retrieve metadata taxonomy nodes based on the parameters specified.
\nhttps://developer.box.com/reference/get-metadata-taxonomies-id-id-nodes
\n","urlObject":{"protocol":"https","path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Filters results by taxonomy level. Multiple values can be provided. \nResults include nodes that match any of the specified values.
\n","type":"text/plain"},"key":"level","value":"[1]"},{"disabled":true,"description":{"content":"Node identifier of a direct parent node. Multiple values can be provided. \nResults include nodes that match any of the specified values.
\n","type":"text/plain"},"key":"parent","value":"[\"c73a9bf3-f377-4210-9159-3df06a481905\"]"},{"disabled":true,"description":{"content":"Node identifier of any ancestor node. Multiple values can be provided. \nResults include nodes that match any of the specified values.
\n","type":"text/plain"},"key":"ancestor","value":"[\"c73a9bf3-f377-4210-9159-3df06a481905\",\"bf8b8213-be1f-4011-bd45-533c0713fa0a\"]"},{"disabled":true,"description":{"content":"Query text to search for the taxonomy nodes.
\n","type":"text/plain"},"key":"query","value":"France"},{"disabled":true,"description":{"content":"When set to true this provides the total number of nodes that matched the query. \nThe response will compute counts of up to 10,000 elements. Defaults to false.
Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[{"id":"502989a8-4c90-46b4-a262-13da1a4d3f06","description":{"content":"The namespace of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"enterprise_123456","key":"namespace"},{"id":"863e7f57-d4ab-4c9f-9144-d89522f10a4f","description":{"content":"The key of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"geography","key":"taxonomy_key"}]}},"response":[{"id":"829bff86-a104-44f5-bd5f-95c2366e7fcb","name":"[200] Returns a list of the taxonomy nodes that match the specified parameters.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/nodes","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes"],"query":[{"key":"level","value":"[1]","description":"Filters results by taxonomy level. Multiple values can be provided. \nResults include nodes that match any of the specified values.","disabled":true},{"key":"parent","value":"[\"c73a9bf3-f377-4210-9159-3df06a481905\"]","description":"Node identifier of a direct parent node. Multiple values can be provided. \nResults include nodes that match any of the specified values.","disabled":true},{"key":"ancestor","value":"[\"c73a9bf3-f377-4210-9159-3df06a481905\",\"bf8b8213-be1f-4011-bd45-533c0713fa0a\"]","description":"Node identifier of any ancestor node. Multiple values can be provided. \nResults include nodes that match any of the specified values.","disabled":true},{"key":"query","value":"France","description":"Query text to search for the taxonomy nodes.","disabled":true},{"key":"include-total-result-count","value":"true","description":"When set to `true` this provides the total number of nodes that matched the query. \nThe response will compute counts of up to 10,000 elements. Defaults to `false`.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"502989a8-4c90-46b4-a262-13da1a4d3f06","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"863e7f57-d4ab-4c9f-9144-d89522f10a4f","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Used to retrieve metadata taxonomy nodes based on the parameters specified.\n\nhttps://developer.box.com/reference/get-metadata-taxonomies-id-id-nodes"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"14d3d433-c77f-49c5-b146-9dea370f6e32\",\n \"displayName\": \"France\",\n \"level\": 2,\n \"parentId\": \"99df4513-7102-4896-8228-94635ee9d330\",\n \"nodePath\": [\n \"99df4513-7102-4896-8228-94635ee9d330\"\n ],\n \"ancestors\": [\n {\n \"id\": \"14d3d433-c77f-49c5-b146-9dea370f6e32\",\n \"displayName\": \"France\",\n \"level\": 2\n }\n ]\n }\n ]\n}"},{"id":"6b6ae9e7-546b-4192-a056-80aa08479ff7","name":"[400] Returned when the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/nodes","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes"],"query":[{"key":"level","value":"[1]","description":"Filters results by taxonomy level. Multiple values can be provided. \nResults include nodes that match any of the specified values.","disabled":true},{"key":"parent","value":"[\"c73a9bf3-f377-4210-9159-3df06a481905\"]","description":"Node identifier of a direct parent node. Multiple values can be provided. \nResults include nodes that match any of the specified values.","disabled":true},{"key":"ancestor","value":"[\"c73a9bf3-f377-4210-9159-3df06a481905\",\"bf8b8213-be1f-4011-bd45-533c0713fa0a\"]","description":"Node identifier of any ancestor node. Multiple values can be provided. \nResults include nodes that match any of the specified values.","disabled":true},{"key":"query","value":"France","description":"Query text to search for the taxonomy nodes.","disabled":true},{"key":"include-total-result-count","value":"true","description":"When set to `true` this provides the total number of nodes that matched the query. \nThe response will compute counts of up to 10,000 elements. Defaults to `false`.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"502989a8-4c90-46b4-a262-13da1a4d3f06","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"863e7f57-d4ab-4c9f-9144-d89522f10a4f","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Used to retrieve metadata taxonomy nodes based on the parameters specified.\n\nhttps://developer.box.com/reference/get-metadata-taxonomies-id-id-nodes"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"9f3f3c6c-b561-4b7b-89b0-cd49391fa46c"},{"name":"Get metadata taxonomy node by ID","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"3c122aa5-98a8-4ffd-aeab-82bedb72cfda","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves a metadata taxonomy node by its identifier.
\nhttps://developer.box.com/reference/get-metadata-taxonomies-id-id-nodes-id
\n","urlObject":{"protocol":"https","path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes",":node_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"9bdf32ae-2fea-4524-865f-dacd6336c6cb","description":{"content":"The namespace of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"enterprise_123456","key":"namespace"},{"id":"72b222ea-6ef1-4b34-ac4a-475e7d30c1a4","description":{"content":"The key of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"geography","key":"taxonomy_key"},{"id":"d4c3c9a9-ec13-4421-95ea-9f5dc8ba2381","description":{"content":"The identifier of the metadata taxonomy node.
\n","type":"text/plain"},"type":"any","value":"14d3d433-c77f-49c5-b146-9dea370f6e32","key":"node_id"}]}},"response":[{"id":"9654283a-55b3-48ab-adcc-a71f9fde5f90","name":"[200] Returns the metadata taxonomy node that matches the identifier.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/nodes/:node_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes",":node_id"],"variable":[{"id":"9bdf32ae-2fea-4524-865f-dacd6336c6cb","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"72b222ea-6ef1-4b34-ac4a-475e7d30c1a4","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."},{"id":"d4c3c9a9-ec13-4421-95ea-9f5dc8ba2381","key":"node_id","value":"14d3d433-c77f-49c5-b146-9dea370f6e32","description":"The identifier of the metadata taxonomy node."}]},"description":"Retrieves a metadata taxonomy node by its identifier.\n\nhttps://developer.box.com/reference/get-metadata-taxonomies-id-id-nodes-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"14d3d433-c77f-49c5-b146-9dea370f6e32\",\n \"displayName\": \"France\",\n \"level\": 2,\n \"parentId\": \"99df4513-7102-4896-8228-94635ee9d330\",\n \"nodePath\": [\n \"99df4513-7102-4896-8228-94635ee9d330\"\n ],\n \"ancestors\": [\n {\n \"id\": \"14d3d433-c77f-49c5-b146-9dea370f6e32\",\n \"displayName\": \"France\",\n \"level\": 2\n }\n ]\n}"},{"id":"1479b357-b46f-4923-9e40-0d52539e8a4f","name":"[400] Returned if any of the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/nodes/:node_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes",":node_id"],"variable":[{"id":"9bdf32ae-2fea-4524-865f-dacd6336c6cb","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"72b222ea-6ef1-4b34-ac4a-475e7d30c1a4","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."},{"id":"d4c3c9a9-ec13-4421-95ea-9f5dc8ba2381","key":"node_id","value":"14d3d433-c77f-49c5-b146-9dea370f6e32","description":"The identifier of the metadata taxonomy node."}]},"description":"Retrieves a metadata taxonomy node by its identifier.\n\nhttps://developer.box.com/reference/get-metadata-taxonomies-id-id-nodes-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"adfadd6b-4b44-4a4b-8465-3f65e8bd6082","name":"[404] Returned if the taxonomy node with the given `node_id` cannot be found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/nodes/:node_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes",":node_id"],"variable":[{"id":"9bdf32ae-2fea-4524-865f-dacd6336c6cb","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"72b222ea-6ef1-4b34-ac4a-475e7d30c1a4","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."},{"id":"d4c3c9a9-ec13-4421-95ea-9f5dc8ba2381","key":"node_id","value":"14d3d433-c77f-49c5-b146-9dea370f6e32","description":"The identifier of the metadata taxonomy node."}]},"description":"Retrieves a metadata taxonomy node by its identifier.\n\nhttps://developer.box.com/reference/get-metadata-taxonomies-id-id-nodes-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"3c122aa5-98a8-4ffd-aeab-82bedb72cfda"},{"name":"List metadata template's options for taxonomy field","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"87b4ceab-ddd1-471e-a0a0-69f3bfcab4b6","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based
\nhttps://developer.box.com/reference/get-metadata-templates-id-id-fields-id-options
\n","urlObject":{"protocol":"https","path":["2.0","metadata_templates",":namespace",":template_key","fields",":field_key","options"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Filters results by taxonomy level. Multiple values can be provided. \nResults include nodes that match any of the specified values.
\n","type":"text/plain"},"key":"level","value":"[1]"},{"disabled":true,"description":{"content":"Node identifier of a direct parent node. Multiple values can be provided. \nResults include nodes that match any of the specified values.
\n","type":"text/plain"},"key":"parent","value":"[\"c73a9bf3-f377-4210-9159-3df06a481905\"]"},{"disabled":true,"description":{"content":"Node identifier of any ancestor node. Multiple values can be provided. \nResults include nodes that match any of the specified values.
\n","type":"text/plain"},"key":"ancestor","value":"[\"c73a9bf3-f377-4210-9159-3df06a481905\",\"bf8b8213-be1f-4011-bd45-533c0713fa0a\"]"},{"disabled":true,"description":{"content":"Query text to search for the taxonomy nodes.
\n","type":"text/plain"},"key":"query","value":"France"},{"disabled":true,"description":{"content":"When set to true this provides the total number of nodes that matched the query. \nThe response will compute counts of up to 10,000 elements. Defaults to false.
When set to true, this only returns valid selectable options for this template\ntaxonomy field. Otherwise, it returns all taxonomy nodes, whether or not they are selectable.\nDefaults to true.
Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[{"id":"490135a8-e174-4b58-9f35-cc41e7edb455","description":{"content":"The namespace of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"enterprise_123456","key":"namespace"},{"id":"5fb7021b-d6f5-4132-a450-6908871a6f55","description":{"content":"The name of the metadata template.
\n","type":"text/plain"},"type":"any","value":"properties","key":"template_key"},{"id":"830eaf2d-ffcc-4f6e-a37f-2728594d96ce","description":{"content":"The key of the metadata taxonomy field in the template.
\n","type":"text/plain"},"type":"any","value":"geography","key":"field_key"}]}},"response":[{"id":"5a3e1d7d-a7d2-4692-84e4-03db713188d0","name":"[200] Returns a list of the taxonomy nodes that match the specified parameters.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates/:namespace/:template_key/fields/:field_key/options","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates",":namespace",":template_key","fields",":field_key","options"],"query":[{"key":"level","value":"[1]","description":"Filters results by taxonomy level. Multiple values can be provided. \nResults include nodes that match any of the specified values.","disabled":true},{"key":"parent","value":"[\"c73a9bf3-f377-4210-9159-3df06a481905\"]","description":"Node identifier of a direct parent node. Multiple values can be provided. \nResults include nodes that match any of the specified values.","disabled":true},{"key":"ancestor","value":"[\"c73a9bf3-f377-4210-9159-3df06a481905\",\"bf8b8213-be1f-4011-bd45-533c0713fa0a\"]","description":"Node identifier of any ancestor node. Multiple values can be provided. \nResults include nodes that match any of the specified values.","disabled":true},{"key":"query","value":"France","description":"Query text to search for the taxonomy nodes.","disabled":true},{"key":"include-total-result-count","value":"true","description":"When set to `true` this provides the total number of nodes that matched the query. \nThe response will compute counts of up to 10,000 elements. Defaults to `false`.","disabled":true},{"key":"only-selectable-options","value":"true","description":"When set to `true`, this only returns valid selectable options for this template\ntaxonomy field. Otherwise, it returns all taxonomy nodes, whether or not they are selectable.\nDefaults to `true`.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"490135a8-e174-4b58-9f35-cc41e7edb455","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"5fb7021b-d6f5-4132-a450-6908871a6f55","key":"template_key","value":"properties","description":"The name of the metadata template."},{"id":"830eaf2d-ffcc-4f6e-a37f-2728594d96ce","key":"field_key","value":"geography","description":"The key of the metadata taxonomy field in the template."}]},"description":"Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based\n\nhttps://developer.box.com/reference/get-metadata-templates-id-id-fields-id-options"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"14d3d433-c77f-49c5-b146-9dea370f6e32\",\n \"displayName\": \"France\",\n \"level\": 2,\n \"parentId\": \"99df4513-7102-4896-8228-94635ee9d330\",\n \"nodePath\": [\n \"99df4513-7102-4896-8228-94635ee9d330\"\n ],\n \"ancestors\": [\n {\n \"id\": \"14d3d433-c77f-49c5-b146-9dea370f6e32\",\n \"displayName\": \"France\",\n \"level\": 2\n }\n ]\n }\n ]\n}"},{"id":"c60de325-ceeb-449b-89b0-1799b33bb14f","name":"[400] Returned when the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates/:namespace/:template_key/fields/:field_key/options","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates",":namespace",":template_key","fields",":field_key","options"],"query":[{"key":"level","value":"[1]","description":"Filters results by taxonomy level. Multiple values can be provided. \nResults include nodes that match any of the specified values.","disabled":true},{"key":"parent","value":"[\"c73a9bf3-f377-4210-9159-3df06a481905\"]","description":"Node identifier of a direct parent node. Multiple values can be provided. \nResults include nodes that match any of the specified values.","disabled":true},{"key":"ancestor","value":"[\"c73a9bf3-f377-4210-9159-3df06a481905\",\"bf8b8213-be1f-4011-bd45-533c0713fa0a\"]","description":"Node identifier of any ancestor node. Multiple values can be provided. \nResults include nodes that match any of the specified values.","disabled":true},{"key":"query","value":"France","description":"Query text to search for the taxonomy nodes.","disabled":true},{"key":"include-total-result-count","value":"true","description":"When set to `true` this provides the total number of nodes that matched the query. \nThe response will compute counts of up to 10,000 elements. Defaults to `false`.","disabled":true},{"key":"only-selectable-options","value":"true","description":"When set to `true`, this only returns valid selectable options for this template\ntaxonomy field. Otherwise, it returns all taxonomy nodes, whether or not they are selectable.\nDefaults to `true`.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"490135a8-e174-4b58-9f35-cc41e7edb455","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"5fb7021b-d6f5-4132-a450-6908871a6f55","key":"template_key","value":"properties","description":"The name of the metadata template."},{"id":"830eaf2d-ffcc-4f6e-a37f-2728594d96ce","key":"field_key","value":"geography","description":"The key of the metadata taxonomy field in the template."}]},"description":"Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based\n\nhttps://developer.box.com/reference/get-metadata-templates-id-id-fields-id-options"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"87b4ceab-ddd1-471e-a0a0-69f3bfcab4b6"},{"name":"Create metadata taxonomy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"2affd501-4e48-4f3d-abe7-33a7ed4aae7e","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates a new metadata taxonomy that can be used in
\nhttps://developer.box.com/reference/post-metadata-taxonomies
\n","urlObject":{"protocol":"https","path":["2.0","metadata_taxonomies"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"2e97600c-3732-4b5f-bcd5-ea48dcb79035","name":"[201] The schema representing the metadata taxonomy created.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"key\": \"geography\",\n \"displayName\": \"Geography\",\n \"namespace\": \"enterprise_123456\"\n}"},"url":"https://api.box.com/2.0/metadata_taxonomies","description":"Creates a new metadata taxonomy that can be used in\n\nhttps://developer.box.com/reference/post-metadata-taxonomies"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\",\n \"key\": \"geography\",\n \"displayName\": \"Geography\",\n \"namespace\": \"enterprise_123456\",\n \"levels\": [\n {\n \"displayName\": \"Continent\",\n \"description\": \"Continent\",\n \"level\": 1\n }\n ]\n}"},{"id":"efbed906-98ad-49e5-bc2b-d43edc9be82e","name":"[400] Returned if the request parameters or body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"key\": \"geography\",\n \"displayName\": \"Geography\",\n \"namespace\": \"enterprise_123456\"\n}"},"url":"https://api.box.com/2.0/metadata_taxonomies","description":"Creates a new metadata taxonomy that can be used in\n\nhttps://developer.box.com/reference/post-metadata-taxonomies"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"ec3da03c-d624-4de1-8cb2-a025ff954e15","name":"[403] Returned when the user does not have the permission to create the metadata","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"key\": \"geography\",\n \"displayName\": \"Geography\",\n \"namespace\": \"enterprise_123456\"\n}"},"url":"https://api.box.com/2.0/metadata_taxonomies","description":"Creates a new metadata taxonomy that can be used in\n\nhttps://developer.box.com/reference/post-metadata-taxonomies"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"2affd501-4e48-4f3d-abe7-33a7ed4aae7e"},{"name":"Create metadata taxonomy levels","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"31b1ed57-dd86-422a-bec0-5603a2f556a4","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates new metadata taxonomy levels.
\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-levels
\n","urlObject":{"protocol":"https","path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels"],"host":["api.box.com"],"query":[],"variable":[{"id":"7ee8b2bd-4f2a-4741-8299-d3fa3fd53f06","description":{"content":"The namespace of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"enterprise_123456","key":"namespace"},{"id":"7396265d-9e56-4849-bf64-58f616b4409d","description":{"content":"The key of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"geography","key":"taxonomy_key"}]}},"response":[{"id":"2b9ea534-0fb3-4d58-9122-37bb0782deff","name":"[201] Returns an array of all taxonomy levels.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/levels","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels"],"variable":[{"id":"7ee8b2bd-4f2a-4741-8299-d3fa3fd53f06","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"7396265d-9e56-4849-bf64-58f616b4409d","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Creates new metadata taxonomy levels.\n\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-levels"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"displayName\": \"Continent\",\n \"description\": \"Continent\",\n \"level\": 1\n }\n ]\n}"},{"id":"1a29d4dd-245a-4d78-873c-d809ef5b3d8c","name":"[400] Returned if the request parameters or body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/levels","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels"],"variable":[{"id":"7ee8b2bd-4f2a-4741-8299-d3fa3fd53f06","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"7396265d-9e56-4849-bf64-58f616b4409d","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Creates new metadata taxonomy levels.\n\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-levels"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"bb8345e2-0701-49cc-b811-18c184623b85","name":"[403] Returned when the user does not have the permission to modify the metadata","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/levels","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels"],"variable":[{"id":"7ee8b2bd-4f2a-4741-8299-d3fa3fd53f06","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"7396265d-9e56-4849-bf64-58f616b4409d","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Creates new metadata taxonomy levels.\n\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-levels"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"31b1ed57-dd86-422a-bec0-5603a2f556a4"},{"name":"Add metadata taxonomy level","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"6505379b-199c-4fe5-9bd5-ce1874b64b28","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates a new metadata taxonomy level and appends it to the existing levels.
\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-levels:append
\n","urlObject":{"protocol":"https","path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels:append"],"host":["api.box.com"],"query":[],"variable":[{"id":"75880d8e-146b-4cb1-8da4-5d06529ab50f","description":{"content":"The namespace of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"enterprise_123456","key":"namespace"},{"id":"bf33ae90-070e-40c3-ae7f-e783f5eb2d36","description":{"content":"The key of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"geography","key":"taxonomy_key"}]}},"response":[{"id":"94119acf-3bf8-4cc9-95b0-743316f39b1e","name":"[201] Returns an array of all taxonomy levels.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"France\",\n \"description\": \"French Republic\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/levels:append","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels:append"],"variable":[{"id":"75880d8e-146b-4cb1-8da4-5d06529ab50f","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"bf33ae90-070e-40c3-ae7f-e783f5eb2d36","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Creates a new metadata taxonomy level and appends it to the existing levels.\n\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-levels:append"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"displayName\": \"Continent\",\n \"description\": \"Continent\",\n \"level\": 1\n }\n ]\n}"},{"id":"b3d2da65-00a0-462f-9429-871c5aeb5705","name":"[400] Returned if the request parameters or body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"France\",\n \"description\": \"French Republic\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/levels:append","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels:append"],"variable":[{"id":"75880d8e-146b-4cb1-8da4-5d06529ab50f","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"bf33ae90-070e-40c3-ae7f-e783f5eb2d36","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Creates a new metadata taxonomy level and appends it to the existing levels.\n\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-levels:append"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"37889d61-7925-4b60-97e7-f2bb096370c7","name":"[403] Returned when the user does not have the permission to modify the metadata","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"France\",\n \"description\": \"French Republic\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/levels:append","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels:append"],"variable":[{"id":"75880d8e-146b-4cb1-8da4-5d06529ab50f","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"bf33ae90-070e-40c3-ae7f-e783f5eb2d36","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Creates a new metadata taxonomy level and appends it to the existing levels.\n\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-levels:append"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"6505379b-199c-4fe5-9bd5-ce1874b64b28"},{"name":"Delete metadata taxonomy level","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"a9fbd1c5-6ec6-49d7-93b3-5ceaed41baa3","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Deletes the last level of the metadata taxonomy.
\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-levels:trim
\n","urlObject":{"protocol":"https","path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels:trim"],"host":["api.box.com"],"query":[],"variable":[{"id":"c2926c5f-1c92-4f58-8610-15da593e3e2e","description":{"content":"The namespace of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"enterprise_123456","key":"namespace"},{"id":"8b69106c-7cfd-415b-9f8e-10fea75849e5","description":{"content":"The key of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"geography","key":"taxonomy_key"}]}},"response":[{"id":"f6f4b025-be5f-4af7-b609-8bdbeaf6ef94","name":"[200] Returns an array of all taxonomy levels.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/levels:trim","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels:trim"],"variable":[{"id":"c2926c5f-1c92-4f58-8610-15da593e3e2e","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"8b69106c-7cfd-415b-9f8e-10fea75849e5","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Deletes the last level of the metadata taxonomy.\n\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-levels:trim"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"displayName\": \"Continent\",\n \"description\": \"Continent\",\n \"level\": 1\n }\n ]\n}"},{"id":"278f2956-57fc-49c0-9b1a-ff2c442c0dbd","name":"[400] Returned if the request parameters or body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/levels:trim","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels:trim"],"variable":[{"id":"c2926c5f-1c92-4f58-8610-15da593e3e2e","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"8b69106c-7cfd-415b-9f8e-10fea75849e5","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Deletes the last level of the metadata taxonomy.\n\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-levels:trim"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"3d516fdc-1a01-475b-b75d-610d85f0cec5","name":"[403] Returned when the user does not have the permission to modify the metadata","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/levels:trim","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels:trim"],"variable":[{"id":"c2926c5f-1c92-4f58-8610-15da593e3e2e","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"8b69106c-7cfd-415b-9f8e-10fea75849e5","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Deletes the last level of the metadata taxonomy.\n\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-levels:trim"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"a9fbd1c5-6ec6-49d7-93b3-5ceaed41baa3"},{"name":"Create metadata taxonomy node","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"16873d38-e3ea-4ce2-bb7f-bbf5d6bf1edb","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates a new metadata taxonomy node.
\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-nodes
\n","urlObject":{"protocol":"https","path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes"],"host":["api.box.com"],"query":[],"variable":[{"id":"525e1baf-c6d6-4f10-a0f4-6e9304c3e2b4","description":{"content":"The namespace of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"enterprise_123456","key":"namespace"},{"id":"37bbc3f3-0437-4d57-b617-ca039abd3fc5","description":{"content":"The key of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"geography","key":"taxonomy_key"}]}},"response":[{"id":"073027e5-4f62-42f8-837d-a6abaffc9c87","name":"[201] The schema representing the taxonomy node created.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"France\",\n \"level\": 1,\n \"parentId\": \"99df4513-7102-4896-8228-94635ee9d330\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/nodes","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes"],"variable":[{"id":"525e1baf-c6d6-4f10-a0f4-6e9304c3e2b4","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"37bbc3f3-0437-4d57-b617-ca039abd3fc5","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Creates a new metadata taxonomy node.\n\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-nodes"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"14d3d433-c77f-49c5-b146-9dea370f6e32\",\n \"displayName\": \"France\",\n \"level\": 2,\n \"parentId\": \"99df4513-7102-4896-8228-94635ee9d330\",\n \"nodePath\": [\n \"99df4513-7102-4896-8228-94635ee9d330\"\n ],\n \"ancestors\": [\n {\n \"id\": \"14d3d433-c77f-49c5-b146-9dea370f6e32\",\n \"displayName\": \"France\",\n \"level\": 2\n }\n ]\n}"},{"id":"e75f24da-4e5f-466f-a259-5f6b2e055653","name":"[400] Returned if the request parameters or body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"France\",\n \"level\": 1,\n \"parentId\": \"99df4513-7102-4896-8228-94635ee9d330\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/nodes","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes"],"variable":[{"id":"525e1baf-c6d6-4f10-a0f4-6e9304c3e2b4","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"37bbc3f3-0437-4d57-b617-ca039abd3fc5","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Creates a new metadata taxonomy node.\n\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-nodes"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"c8eb1841-84d8-4023-910a-0af5bf6cf1c0","name":"[403] Returned when the user does not have the permission to modify the metadata","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"France\",\n \"level\": 1,\n \"parentId\": \"99df4513-7102-4896-8228-94635ee9d330\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/nodes","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes"],"variable":[{"id":"525e1baf-c6d6-4f10-a0f4-6e9304c3e2b4","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"37bbc3f3-0437-4d57-b617-ca039abd3fc5","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Creates a new metadata taxonomy node.\n\nhttps://developer.box.com/reference/post-metadata-taxonomies-id-id-nodes"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"16873d38-e3ea-4ce2-bb7f-bbf5d6bf1edb"},{"name":"Update metadata taxonomy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"2e1164c3-a711-4b56-9452-f2f96ef84933","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Updates an existing metadata taxonomy.
\nhttps://developer.box.com/reference/patch-metadata-taxonomies-id-id
\n","urlObject":{"protocol":"https","path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key"],"host":["api.box.com"],"query":[],"variable":[{"id":"717a7202-4c9e-4dd8-8592-d7e780460b67","description":{"content":"The namespace of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"enterprise_123456","key":"namespace"},{"id":"bae9a68c-7d53-4f83-b19e-db9d725868f3","description":{"content":"The key of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"geography","key":"taxonomy_key"}]}},"response":[{"id":"f41ae9f2-e2f6-4762-a5e6-aee62765c85c","name":"[200] The schema representing the updated metadata taxonomy.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"Geography\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key"],"variable":[{"id":"717a7202-4c9e-4dd8-8592-d7e780460b67","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"bae9a68c-7d53-4f83-b19e-db9d725868f3","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Updates an existing metadata taxonomy.\n\nhttps://developer.box.com/reference/patch-metadata-taxonomies-id-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\",\n \"key\": \"geography\",\n \"displayName\": \"Geography\",\n \"namespace\": \"enterprise_123456\",\n \"levels\": [\n {\n \"displayName\": \"Continent\",\n \"description\": \"Continent\",\n \"level\": 1\n }\n ]\n}"},{"id":"16b67673-29de-4cdd-bafa-8035d6aa80a5","name":"[400] Returned if the request parameters or body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"Geography\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key"],"variable":[{"id":"717a7202-4c9e-4dd8-8592-d7e780460b67","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"bae9a68c-7d53-4f83-b19e-db9d725868f3","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Updates an existing metadata taxonomy.\n\nhttps://developer.box.com/reference/patch-metadata-taxonomies-id-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"751d9a4e-1822-4912-9c84-65b8f11132f7","name":"[403] Returned when the user does not have the permission to modify the metadata","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"Geography\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key"],"variable":[{"id":"717a7202-4c9e-4dd8-8592-d7e780460b67","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"bae9a68c-7d53-4f83-b19e-db9d725868f3","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Updates an existing metadata taxonomy.\n\nhttps://developer.box.com/reference/patch-metadata-taxonomies-id-id"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"2e1164c3-a711-4b56-9452-f2f96ef84933"},{"name":"Update metadata taxonomy level","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"d2226790-4927-416c-a303-9fd3a8dd651f","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Updates an existing metadata taxonomy level.
\nhttps://developer.box.com/reference/patch-metadata-taxonomies-id-id-levels-id
\n","urlObject":{"protocol":"https","path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels",":level_index"],"host":["api.box.com"],"query":[],"variable":[{"id":"c8592cb9-8788-44b6-aa1f-c171b16db17d","description":{"content":"The namespace of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"enterprise_123456","key":"namespace"},{"id":"3de492fe-990f-496e-80a1-0bde1560fb83","description":{"content":"The key of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"geography","key":"taxonomy_key"},{"id":"6b3acd66-0630-45df-aeef-512aee66d0b5","description":{"content":"The index of the metadata taxonomy level.
\n","type":"text/plain"},"type":"any","value":"1","key":"level_index"}]}},"response":[{"id":"307b117b-dca9-4148-a371-90e67041e5bc","name":"[200] The updated taxonomy level.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"France\",\n \"description\": \"French Republic\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/levels/:level_index","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels",":level_index"],"variable":[{"id":"c8592cb9-8788-44b6-aa1f-c171b16db17d","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"3de492fe-990f-496e-80a1-0bde1560fb83","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."},{"id":"6b3acd66-0630-45df-aeef-512aee66d0b5","key":"level_index","value":"1","description":"The index of the metadata taxonomy level."}]},"description":"Updates an existing metadata taxonomy level.\n\nhttps://developer.box.com/reference/patch-metadata-taxonomies-id-id-levels-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"displayName\": \"Continent\",\n \"description\": \"Continent\",\n \"level\": 1\n}"},{"id":"a0b3a83a-2edc-47ea-a8e7-8fa95e9e1cff","name":"[400] Returned if the request parameters or body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"France\",\n \"description\": \"French Republic\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/levels/:level_index","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels",":level_index"],"variable":[{"id":"c8592cb9-8788-44b6-aa1f-c171b16db17d","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"3de492fe-990f-496e-80a1-0bde1560fb83","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."},{"id":"6b3acd66-0630-45df-aeef-512aee66d0b5","key":"level_index","value":"1","description":"The index of the metadata taxonomy level."}]},"description":"Updates an existing metadata taxonomy level.\n\nhttps://developer.box.com/reference/patch-metadata-taxonomies-id-id-levels-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"b1a79b8d-b4f5-4477-91f2-502f8c369094","name":"[403] Returned when the user does not have the permission to modify the metadata","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"France\",\n \"description\": \"French Republic\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/levels/:level_index","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","levels",":level_index"],"variable":[{"id":"c8592cb9-8788-44b6-aa1f-c171b16db17d","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"3de492fe-990f-496e-80a1-0bde1560fb83","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."},{"id":"6b3acd66-0630-45df-aeef-512aee66d0b5","key":"level_index","value":"1","description":"The index of the metadata taxonomy level."}]},"description":"Updates an existing metadata taxonomy level.\n\nhttps://developer.box.com/reference/patch-metadata-taxonomies-id-id-levels-id"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"d2226790-4927-416c-a303-9fd3a8dd651f"},{"name":"Update metadata taxonomy node","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"56cef814-8dfd-4db5-84eb-02b035b2ef78","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Updates an existing metadata taxonomy node.
\nhttps://developer.box.com/reference/patch-metadata-taxonomies-id-id-nodes-id
\n","urlObject":{"protocol":"https","path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes",":node_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"a26e9a49-2d1b-4039-829a-a398257bb221","description":{"content":"The namespace of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"enterprise_123456","key":"namespace"},{"id":"8f982e43-afab-417b-827c-ae00c45bdb72","description":{"content":"The key of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"geography","key":"taxonomy_key"},{"id":"c5e887ca-9a15-4631-b229-6c7dde7a8635","description":{"content":"The identifier of the metadata taxonomy node.
\n","type":"text/plain"},"type":"any","value":"14d3d433-c77f-49c5-b146-9dea370f6e32","key":"node_id"}]}},"response":[{"id":"146b96e8-aa20-4f4b-a11b-fc4a223da675","name":"[200] The schema representing the updated taxonomy node.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"France\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/nodes/:node_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes",":node_id"],"variable":[{"id":"a26e9a49-2d1b-4039-829a-a398257bb221","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"8f982e43-afab-417b-827c-ae00c45bdb72","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."},{"id":"c5e887ca-9a15-4631-b229-6c7dde7a8635","key":"node_id","value":"14d3d433-c77f-49c5-b146-9dea370f6e32","description":"The identifier of the metadata taxonomy node."}]},"description":"Updates an existing metadata taxonomy node.\n\nhttps://developer.box.com/reference/patch-metadata-taxonomies-id-id-nodes-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"14d3d433-c77f-49c5-b146-9dea370f6e32\",\n \"displayName\": \"France\",\n \"level\": 2,\n \"parentId\": \"99df4513-7102-4896-8228-94635ee9d330\",\n \"nodePath\": [\n \"99df4513-7102-4896-8228-94635ee9d330\"\n ],\n \"ancestors\": [\n {\n \"id\": \"14d3d433-c77f-49c5-b146-9dea370f6e32\",\n \"displayName\": \"France\",\n \"level\": 2\n }\n ]\n}"},{"id":"dfa87a6e-fcb5-411b-8b45-c2c70040af2b","name":"[400] Returned if the request parameters or body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"France\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/nodes/:node_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes",":node_id"],"variable":[{"id":"a26e9a49-2d1b-4039-829a-a398257bb221","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"8f982e43-afab-417b-827c-ae00c45bdb72","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."},{"id":"c5e887ca-9a15-4631-b229-6c7dde7a8635","key":"node_id","value":"14d3d433-c77f-49c5-b146-9dea370f6e32","description":"The identifier of the metadata taxonomy node."}]},"description":"Updates an existing metadata taxonomy node.\n\nhttps://developer.box.com/reference/patch-metadata-taxonomies-id-id-nodes-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"4b87d511-c2ff-4778-8c70-8657fc10c0b8","name":"[403] Returned when the user does not have the permission to modify the metadata","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"France\"\n}"},"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/nodes/:node_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes",":node_id"],"variable":[{"id":"a26e9a49-2d1b-4039-829a-a398257bb221","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"8f982e43-afab-417b-827c-ae00c45bdb72","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."},{"id":"c5e887ca-9a15-4631-b229-6c7dde7a8635","key":"node_id","value":"14d3d433-c77f-49c5-b146-9dea370f6e32","description":"The identifier of the metadata taxonomy node."}]},"description":"Updates an existing metadata taxonomy node.\n\nhttps://developer.box.com/reference/patch-metadata-taxonomies-id-id-nodes-id"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"56cef814-8dfd-4db5-84eb-02b035b2ef78"},{"name":"Remove metadata taxonomy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"f94cd6c5-b5bf-40c3-8866-6e9d984798cc","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Delete a metadata taxonomy.
\nhttps://developer.box.com/reference/delete-metadata-taxonomies-id-id
\n","urlObject":{"protocol":"https","path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key"],"host":["api.box.com"],"query":[],"variable":[{"id":"215cec2c-7cc9-425e-94c8-2b9c516f05f9","description":{"content":"The namespace of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"enterprise_123456","key":"namespace"},{"id":"c3717353-be10-48eb-bee6-5bfb0305d396","description":{"content":"The key of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"geography","key":"taxonomy_key"}]}},"response":[{"id":"fe13c996-14f3-4b43-ab84-2409279036d9","name":"[204] Returns an empty response when the metadata taxonomy is successfully deleted.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key"],"variable":[{"id":"215cec2c-7cc9-425e-94c8-2b9c516f05f9","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"c3717353-be10-48eb-bee6-5bfb0305d396","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Delete a metadata taxonomy.\n\nhttps://developer.box.com/reference/delete-metadata-taxonomies-id-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"bb1fbb38-31df-4b1d-8966-96e7a0a4ecec","name":"[400] Returned if the request parameters or body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key"],"variable":[{"id":"215cec2c-7cc9-425e-94c8-2b9c516f05f9","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"c3717353-be10-48eb-bee6-5bfb0305d396","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Delete a metadata taxonomy.\n\nhttps://developer.box.com/reference/delete-metadata-taxonomies-id-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"e265a337-6eba-4aa0-acb5-05ee05c7f8c8","name":"[403] Returned when the user does not have the permission to delete the metadata","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key"],"variable":[{"id":"215cec2c-7cc9-425e-94c8-2b9c516f05f9","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"c3717353-be10-48eb-bee6-5bfb0305d396","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Delete a metadata taxonomy.\n\nhttps://developer.box.com/reference/delete-metadata-taxonomies-id-id"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"5f54ea0d-44f6-4884-885b-358b3829e2fc","name":"[404] Returned if the metadata taxonomy does not exist.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key"],"variable":[{"id":"215cec2c-7cc9-425e-94c8-2b9c516f05f9","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"c3717353-be10-48eb-bee6-5bfb0305d396","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."}]},"description":"Delete a metadata taxonomy.\n\nhttps://developer.box.com/reference/delete-metadata-taxonomies-id-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"f94cd6c5-b5bf-40c3-8866-6e9d984798cc"},{"name":"Remove metadata taxonomy node","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"88de78ed-84c3-4b7a-8a05-4f0857fb5965","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Delete a metadata taxonomy node.
\nhttps://developer.box.com/reference/delete-metadata-taxonomies-id-id-nodes-id
\n","urlObject":{"protocol":"https","path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes",":node_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"76ce85ce-7147-4c23-9ec5-67214ffda5a4","description":{"content":"The namespace of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"enterprise_123456","key":"namespace"},{"id":"ccfc61e3-349f-441e-ad08-12f25291efac","description":{"content":"The key of the metadata taxonomy.
\n","type":"text/plain"},"type":"any","value":"geography","key":"taxonomy_key"},{"id":"5f4cf0f9-8c0f-4e10-9558-594eb6859ddc","description":{"content":"The identifier of the metadata taxonomy node.
\n","type":"text/plain"},"type":"any","value":"14d3d433-c77f-49c5-b146-9dea370f6e32","key":"node_id"}]}},"response":[{"id":"c4ff6719-1996-47e0-ac5b-f40566de3aaf","name":"[204] Returns an empty response when the metadata taxonomy node is successfully deleted.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/nodes/:node_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes",":node_id"],"variable":[{"id":"76ce85ce-7147-4c23-9ec5-67214ffda5a4","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"ccfc61e3-349f-441e-ad08-12f25291efac","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."},{"id":"5f4cf0f9-8c0f-4e10-9558-594eb6859ddc","key":"node_id","value":"14d3d433-c77f-49c5-b146-9dea370f6e32","description":"The identifier of the metadata taxonomy node."}]},"description":"Delete a metadata taxonomy node.\n\nhttps://developer.box.com/reference/delete-metadata-taxonomies-id-id-nodes-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"239b00bf-ec59-4070-ba88-6b59528b47a7","name":"[400] Returned if the request parameters or body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/nodes/:node_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes",":node_id"],"variable":[{"id":"76ce85ce-7147-4c23-9ec5-67214ffda5a4","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"ccfc61e3-349f-441e-ad08-12f25291efac","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."},{"id":"5f4cf0f9-8c0f-4e10-9558-594eb6859ddc","key":"node_id","value":"14d3d433-c77f-49c5-b146-9dea370f6e32","description":"The identifier of the metadata taxonomy node."}]},"description":"Delete a metadata taxonomy node.\n\nhttps://developer.box.com/reference/delete-metadata-taxonomies-id-id-nodes-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"2e32704c-9332-4e78-8a14-a6acaa99dfc5","name":"[403] Returned when the user does not have the permission to delete the metadata","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/nodes/:node_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes",":node_id"],"variable":[{"id":"76ce85ce-7147-4c23-9ec5-67214ffda5a4","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"ccfc61e3-349f-441e-ad08-12f25291efac","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."},{"id":"5f4cf0f9-8c0f-4e10-9558-594eb6859ddc","key":"node_id","value":"14d3d433-c77f-49c5-b146-9dea370f6e32","description":"The identifier of the metadata taxonomy node."}]},"description":"Delete a metadata taxonomy node.\n\nhttps://developer.box.com/reference/delete-metadata-taxonomies-id-id-nodes-id"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"0e72530a-01ea-4002-b274-d200abc11e83","name":"[404] Returned if the metadata taxonomy node does not exist.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_taxonomies/:namespace/:taxonomy_key/nodes/:node_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_taxonomies",":namespace",":taxonomy_key","nodes",":node_id"],"variable":[{"id":"76ce85ce-7147-4c23-9ec5-67214ffda5a4","key":"namespace","value":"enterprise_123456","description":"The namespace of the metadata taxonomy."},{"id":"ccfc61e3-349f-441e-ad08-12f25291efac","key":"taxonomy_key","value":"geography","description":"The key of the metadata taxonomy."},{"id":"5f4cf0f9-8c0f-4e10-9558-594eb6859ddc","key":"node_id","value":"14d3d433-c77f-49c5-b146-9dea370f6e32","description":"The identifier of the metadata taxonomy node."}]},"description":"Delete a metadata taxonomy node.\n\nhttps://developer.box.com/reference/delete-metadata-taxonomies-id-id-nodes-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"88de78ed-84c3-4b7a-8a05-4f0857fb5965"}],"id":"aacbf6e7-c65b-439e-ae53-ceffc8d9f1fa","_postman_id":"aacbf6e7-c65b-439e-ae53-ceffc8d9f1fa","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Finds a metadata template by searching for the ID of an instance of the
\nhttps://developer.box.com/reference/get-metadata-templates
\n","urlObject":{"protocol":"https","path":["2.0","metadata_templates"],"host":["api.box.com"],"query":[{"description":{"content":"The ID of an instance of the metadata template to find.
\n","type":"text/plain"},"key":"metadata_instance_id","value":"01234500-12f1-1234-aa12-b1d234cb567e"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"1d7e089d-2978-4b08-9777-7b7521a8c829","name":"[200] Returns a list containing the 1 metadata template that matches the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates?metadata_instance_id=01234500-12f1-1234-aa12-b1d234cb567e","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates"],"query":[{"key":"metadata_instance_id","value":"01234500-12f1-1234-aa12-b1d234cb567e","description":"The ID of an instance of the metadata template to find."},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Finds a metadata template by searching for the ID of an instance of the\n\nhttps://developer.box.com/reference/get-metadata-templates"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"type\": \"metadata_template\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\",\n \"displayName\": \"Product Info\",\n \"hidden\": true,\n \"fields\": [\n {\n \"type\": \"string\",\n \"key\": \"category\",\n \"displayName\": \"Category\",\n \"description\": \"The category\",\n \"hidden\": true,\n \"options\": [\n {\n \"key\": \"Category 1\",\n \"id\": \"45dc2849-a4a7-40a9-a751-4a699a589190\"\n }\n ],\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\"\n }\n ],\n \"copyInstanceOnItemCopy\": true\n }\n ]\n}"},{"id":"047b987d-22e5-4454-9267-45ff7327e180","name":"[400] Returned when the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates?metadata_instance_id=01234500-12f1-1234-aa12-b1d234cb567e","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates"],"query":[{"key":"metadata_instance_id","value":"01234500-12f1-1234-aa12-b1d234cb567e","description":"The ID of an instance of the metadata template to find."},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Finds a metadata template by searching for the ID of an instance of the\n\nhttps://developer.box.com/reference/get-metadata-templates"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"26eb4cc7-8311-4142-bd80-07a234add339"},{"name":"Get metadata template by name","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"01c2ba5b-beb7-461c-a715-64e0797d2b8b","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves a metadata template by its scope and templateKey values.
\nhttps://developer.box.com/reference/get-metadata-templates-id-id-schema
\n","urlObject":{"protocol":"https","path":["2.0","metadata_templates",":scope",":template_key","schema"],"host":["api.box.com"],"query":[],"variable":[{"id":"e6c90834-791d-43e6-ae62-06d76bca28b8","description":{"content":"The scope of the metadata template.
\n","type":"text/plain"},"type":"any","value":"global","key":"scope"},{"id":"41204829-6271-479c-b53d-b4cff1813ce0","description":{"content":"The name of the metadata template.
\n","type":"text/plain"},"type":"any","value":"properties","key":"template_key"}]}},"response":[{"id":"c3d823e4-7cdf-4e17-a418-8cd657200e2f","name":"[200] Returns the metadata template matching the `scope`","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates/:scope/:template_key/schema","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates",":scope",":template_key","schema"],"variable":[{"id":"e6c90834-791d-43e6-ae62-06d76bca28b8","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"41204829-6271-479c-b53d-b4cff1813ce0","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Retrieves a metadata template by its scope and templateKey values.\n\nhttps://developer.box.com/reference/get-metadata-templates-id-id-schema"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"type\": \"metadata_template\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\",\n \"displayName\": \"Product Info\",\n \"hidden\": true,\n \"fields\": [\n {\n \"type\": \"string\",\n \"key\": \"category\",\n \"displayName\": \"Category\",\n \"description\": \"The category\",\n \"hidden\": true,\n \"options\": [\n {\n \"key\": \"Category 1\",\n \"id\": \"45dc2849-a4a7-40a9-a751-4a699a589190\"\n }\n ],\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\"\n }\n ],\n \"copyInstanceOnItemCopy\": true\n}"},{"id":"53b2cef5-72ac-4f8b-ac39-7fa527d09d11","name":"[400] Returned if any of the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates/:scope/:template_key/schema","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates",":scope",":template_key","schema"],"variable":[{"id":"e6c90834-791d-43e6-ae62-06d76bca28b8","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"41204829-6271-479c-b53d-b4cff1813ce0","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Retrieves a metadata template by its scope and templateKey values.\n\nhttps://developer.box.com/reference/get-metadata-templates-id-id-schema"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"9328df21-cce0-47e9-a804-e0e36936259b","name":"[404] Returned when a template with the given `scope` and `template_key` can not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates/:scope/:template_key/schema","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates",":scope",":template_key","schema"],"variable":[{"id":"e6c90834-791d-43e6-ae62-06d76bca28b8","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"41204829-6271-479c-b53d-b4cff1813ce0","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Retrieves a metadata template by its scope and templateKey values.\n\nhttps://developer.box.com/reference/get-metadata-templates-id-id-schema"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"01c2ba5b-beb7-461c-a715-64e0797d2b8b"},{"name":"Get metadata template by ID","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"f8489fb3-aa22-4203-98a0-5a5897426ff6","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves a metadata template by its ID.
\nhttps://developer.box.com/reference/get-metadata-templates-id
\n","urlObject":{"protocol":"https","path":["2.0","metadata_templates",":template_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"b233e5a9-f8fa-4428-a476-9393d2296471","description":{"content":"The ID of the template.
\n","type":"text/plain"},"type":"any","value":"f7a9891f","key":"template_id"}]}},"response":[{"id":"59c5a1f1-b753-4e69-88f8-f017cf43fc2d","name":"[200] Returns the metadata template that matches the ID.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates",":template_id"],"variable":[{"id":"b233e5a9-f8fa-4428-a476-9393d2296471","key":"template_id","value":"f7a9891f","description":"The ID of the template."}]},"description":"Retrieves a metadata template by its ID.\n\nhttps://developer.box.com/reference/get-metadata-templates-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"type\": \"metadata_template\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\",\n \"displayName\": \"Product Info\",\n \"hidden\": true,\n \"fields\": [\n {\n \"type\": \"string\",\n \"key\": \"category\",\n \"displayName\": \"Category\",\n \"description\": \"The category\",\n \"hidden\": true,\n \"options\": [\n {\n \"key\": \"Category 1\",\n \"id\": \"45dc2849-a4a7-40a9-a751-4a699a589190\"\n }\n ],\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\"\n }\n ],\n \"copyInstanceOnItemCopy\": true\n}"},{"id":"6db5e1ab-2249-4d4e-a325-2918871f52ed","name":"[400] Returned if any of the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates/:template_id","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates",":template_id"],"variable":[{"id":"b233e5a9-f8fa-4428-a476-9393d2296471","key":"template_id","value":"f7a9891f","description":"The ID of the template."}]},"description":"Retrieves a metadata template by its ID.\n\nhttps://developer.box.com/reference/get-metadata-templates-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"type\": \"metadata_template\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\",\n \"displayName\": \"Product Info\",\n \"hidden\": true,\n \"fields\": [\n {\n \"type\": \"string\",\n \"key\": \"category\",\n \"displayName\": \"Category\",\n \"description\": \"The category\",\n \"hidden\": true,\n \"options\": [\n {\n \"key\": \"Category 1\",\n \"id\": \"45dc2849-a4a7-40a9-a751-4a699a589190\"\n }\n ],\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\"\n }\n ],\n \"copyInstanceOnItemCopy\": true\n}"}],"_postman_id":"f8489fb3-aa22-4203-98a0-5a5897426ff6"},{"name":"List all global metadata templates","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"770e9d3b-2f9f-4ee1-a553-e0796a95d9a1","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Used to retrieve all generic, global metadata templates available to all
\nhttps://developer.box.com/reference/get-metadata-templates-global
\n","urlObject":{"protocol":"https","path":["2.0","metadata_templates","global"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"4da0a530-9368-4e76-9606-8ee4f67a7b6f","name":"[200] Returns all of the metadata templates available to all enterprises","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates/global","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates","global"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Used to retrieve all generic, global metadata templates available to all\n\nhttps://developer.box.com/reference/get-metadata-templates-global"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"type\": \"metadata_template\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\",\n \"displayName\": \"Product Info\",\n \"hidden\": true,\n \"fields\": [\n {\n \"type\": \"string\",\n \"key\": \"category\",\n \"displayName\": \"Category\",\n \"description\": \"The category\",\n \"hidden\": true,\n \"options\": [\n {\n \"key\": \"Category 1\",\n \"id\": \"45dc2849-a4a7-40a9-a751-4a699a589190\"\n }\n ],\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\"\n }\n ],\n \"copyInstanceOnItemCopy\": true\n }\n ]\n}"},{"id":"13ed9c0b-6374-409d-b5f3-60c78b527031","name":"[400] Returned when the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates/global","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates","global"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Used to retrieve all generic, global metadata templates available to all\n\nhttps://developer.box.com/reference/get-metadata-templates-global"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"770e9d3b-2f9f-4ee1-a553-e0796a95d9a1"},{"name":"List all metadata templates for enterprise","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"58cc1d5a-3b0a-4453-a914-bdb081ce5493","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Used to retrieve all metadata templates created to be used specifically within
\nhttps://developer.box.com/reference/get-metadata-templates-enterprise
\n","urlObject":{"protocol":"https","path":["2.0","metadata_templates","enterprise"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"0101491a-9bf8-4df8-a3d5-19b10b9d4099","name":"[200] Returns all of the metadata templates within an enterprise","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates/enterprise","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates","enterprise"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Used to retrieve all metadata templates created to be used specifically within\n\nhttps://developer.box.com/reference/get-metadata-templates-enterprise"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"type\": \"metadata_template\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\",\n \"displayName\": \"Product Info\",\n \"hidden\": true,\n \"fields\": [\n {\n \"type\": \"string\",\n \"key\": \"category\",\n \"displayName\": \"Category\",\n \"description\": \"The category\",\n \"hidden\": true,\n \"options\": [\n {\n \"key\": \"Category 1\",\n \"id\": \"45dc2849-a4a7-40a9-a751-4a699a589190\"\n }\n ],\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\"\n }\n ],\n \"copyInstanceOnItemCopy\": true\n }\n ]\n}"},{"id":"71ccc05c-b657-476c-8229-6768d4613982","name":"[400] Returned when the request parameters are not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates/enterprise","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates","enterprise"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}]},"description":"Used to retrieve all metadata templates created to be used specifically within\n\nhttps://developer.box.com/reference/get-metadata-templates-enterprise"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"58cc1d5a-3b0a-4453-a914-bdb081ce5493"},{"name":"Create metadata template","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"2f539993-7974-417a-ba96-333e2f74f3e9","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates a new metadata template that can be applied to
\nhttps://developer.box.com/reference/post-metadata-templates-schema
\n","urlObject":{"protocol":"https","path":["2.0","metadata_templates","schema"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"464ffba3-8512-4dac-99a5-ba429d8c827b","name":"[201] The schema representing the metadata template created.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scope\": \"enterprise\",\n \"templateKey\": \"productInfo\",\n \"displayName\": \"Product Info\",\n \"hidden\": true,\n \"fields\": [\n {\n \"type\": \"string\",\n \"key\": \"category\",\n \"displayName\": \"Category\",\n \"description\": \"The category\",\n \"hidden\": true,\n \"options\": [\n {\n \"key\": \"Category 1\"\n }\n ],\n \"taxonomyKey\": \"locationTaxonomy\",\n \"namespace\": \"enterprise_123456\",\n \"optionsRules\": {\n \"multiSelect\": true,\n \"selectableLevels\": [\n 1,\n 2\n ]\n }\n }\n ],\n \"copyInstanceOnItemCopy\": true\n}"},"url":"https://api.box.com/2.0/metadata_templates/schema","description":"Creates a new metadata template that can be applied to\n\nhttps://developer.box.com/reference/post-metadata-templates-schema"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"type\": \"metadata_template\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\",\n \"displayName\": \"Product Info\",\n \"hidden\": true,\n \"fields\": [\n {\n \"type\": \"string\",\n \"key\": \"category\",\n \"displayName\": \"Category\",\n \"description\": \"The category\",\n \"hidden\": true,\n \"options\": [\n {\n \"key\": \"Category 1\",\n \"id\": \"45dc2849-a4a7-40a9-a751-4a699a589190\"\n }\n ],\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\"\n }\n ],\n \"copyInstanceOnItemCopy\": true\n}"},{"id":"b4aa3af1-0081-48cc-8890-f3d76208ff3b","name":"[400] Returned if the request parameters or body is not valid.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scope\": \"enterprise\",\n \"templateKey\": \"productInfo\",\n \"displayName\": \"Product Info\",\n \"hidden\": true,\n \"fields\": [\n {\n \"type\": \"string\",\n \"key\": \"category\",\n \"displayName\": \"Category\",\n \"description\": \"The category\",\n \"hidden\": true,\n \"options\": [\n {\n \"key\": \"Category 1\"\n }\n ],\n \"taxonomyKey\": \"locationTaxonomy\",\n \"namespace\": \"enterprise_123456\",\n \"optionsRules\": {\n \"multiSelect\": true,\n \"selectableLevels\": [\n 1,\n 2\n ]\n }\n }\n ],\n \"copyInstanceOnItemCopy\": true\n}"},"url":"https://api.box.com/2.0/metadata_templates/schema","description":"Creates a new metadata template that can be applied to\n\nhttps://developer.box.com/reference/post-metadata-templates-schema"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"2dbb5168-3a0a-4d96-bb69-4bb49750e793","name":"[403] Returned when the user does not have the permission to create the metadata","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scope\": \"enterprise\",\n \"templateKey\": \"productInfo\",\n \"displayName\": \"Product Info\",\n \"hidden\": true,\n \"fields\": [\n {\n \"type\": \"string\",\n \"key\": \"category\",\n \"displayName\": \"Category\",\n \"description\": \"The category\",\n \"hidden\": true,\n \"options\": [\n {\n \"key\": \"Category 1\"\n }\n ],\n \"taxonomyKey\": \"locationTaxonomy\",\n \"namespace\": \"enterprise_123456\",\n \"optionsRules\": {\n \"multiSelect\": true,\n \"selectableLevels\": [\n 1,\n 2\n ]\n }\n }\n ],\n \"copyInstanceOnItemCopy\": true\n}"},"url":"https://api.box.com/2.0/metadata_templates/schema","description":"Creates a new metadata template that can be applied to\n\nhttps://developer.box.com/reference/post-metadata-templates-schema"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"2f539993-7974-417a-ba96-333e2f74f3e9"},{"name":"Update metadata template","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"777efbfd-f88d-4c94-878e-f2ee0da89253","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Updates a metadata template.
\nhttps://developer.box.com/reference/put-metadata-templates-id-id-schema
\n","urlObject":{"protocol":"https","path":["2.0","metadata_templates",":scope",":template_key","schema"],"host":["api.box.com"],"query":[],"variable":[{"id":"92d8c490-cbf1-4c54-9f05-4c1267230266","description":{"content":"The scope of the metadata template.
\n","type":"text/plain"},"type":"any","value":"global","key":"scope"},{"id":"e6cf9a89-71f0-44e2-83e4-f2bd00d3128c","description":{"content":"The name of the metadata template.
\n","type":"text/plain"},"type":"any","value":"properties","key":"template_key"}]}},"response":[{"id":"0435bc31-ac71-40fc-83e4-2c4e9234a3e1","name":"[200] Returns the updated metadata template, with the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/metadata_templates/:scope/:template_key/schema","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates",":scope",":template_key","schema"],"variable":[{"id":"92d8c490-cbf1-4c54-9f05-4c1267230266","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"e6cf9a89-71f0-44e2-83e4-f2bd00d3128c","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Updates a metadata template.\n\nhttps://developer.box.com/reference/put-metadata-templates-id-id-schema"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"type\": \"metadata_template\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\",\n \"displayName\": \"Product Info\",\n \"hidden\": true,\n \"fields\": [\n {\n \"type\": \"string\",\n \"key\": \"category\",\n \"displayName\": \"Category\",\n \"description\": \"The category\",\n \"hidden\": true,\n \"options\": [\n {\n \"key\": \"Category 1\",\n \"id\": \"45dc2849-a4a7-40a9-a751-4a699a589190\"\n }\n ],\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\"\n }\n ],\n \"copyInstanceOnItemCopy\": true\n}"},{"id":"653f59fb-dfae-49fc-b294-a919d9d1985f","name":"[400] The request body does not contain a valid metadata schema.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/metadata_templates/:scope/:template_key/schema","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates",":scope",":template_key","schema"],"variable":[{"id":"92d8c490-cbf1-4c54-9f05-4c1267230266","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"e6cf9a89-71f0-44e2-83e4-f2bd00d3128c","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Updates a metadata template.\n\nhttps://developer.box.com/reference/put-metadata-templates-id-id-schema"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"b3d99446-aafb-41b5-beaf-5890c241e2ac","name":"[403] The request body contains a scope that the user is not","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/metadata_templates/:scope/:template_key/schema","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates",":scope",":template_key","schema"],"variable":[{"id":"92d8c490-cbf1-4c54-9f05-4c1267230266","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"e6cf9a89-71f0-44e2-83e4-f2bd00d3128c","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Updates a metadata template.\n\nhttps://developer.box.com/reference/put-metadata-templates-id-id-schema"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"f018f00d-de86-4928-86a0-2c29b7c79527","name":"[404] The requested template could not be found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.box.com/2.0/metadata_templates/:scope/:template_key/schema","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates",":scope",":template_key","schema"],"variable":[{"id":"92d8c490-cbf1-4c54-9f05-4c1267230266","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"e6cf9a89-71f0-44e2-83e4-f2bd00d3128c","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Updates a metadata template.\n\nhttps://developer.box.com/reference/put-metadata-templates-id-id-schema"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"777efbfd-f88d-4c94-878e-f2ee0da89253"},{"name":"Remove metadata template","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"cacf8252-380a-4bab-8974-56a6401d30fe","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Delete a metadata template and its instances.
\nhttps://developer.box.com/reference/delete-metadata-templates-id-id-schema
\n","urlObject":{"protocol":"https","path":["2.0","metadata_templates",":scope",":template_key","schema"],"host":["api.box.com"],"query":[],"variable":[{"id":"3aaae342-78df-46d9-8fc2-2389b763965e","description":{"content":"The scope of the metadata template.
\n","type":"text/plain"},"type":"any","value":"global","key":"scope"},{"id":"2d96aba9-b694-4af3-b5f0-9b23735b3718","description":{"content":"The name of the metadata template.
\n","type":"text/plain"},"type":"any","value":"properties","key":"template_key"}]}},"response":[{"id":"3b56a7fd-1313-419c-a2f6-5ef24efbfb03","name":"[204] Returns an empty response when the metadata","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates/:scope/:template_key/schema","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates",":scope",":template_key","schema"],"variable":[{"id":"3aaae342-78df-46d9-8fc2-2389b763965e","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"2d96aba9-b694-4af3-b5f0-9b23735b3718","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Delete a metadata template and its instances.\n\nhttps://developer.box.com/reference/delete-metadata-templates-id-id-schema"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"b076a879-da6f-4b4e-90ea-b41b55b817be","name":"[400] Request body does not contain a valid metadata schema.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates/:scope/:template_key/schema","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates",":scope",":template_key","schema"],"variable":[{"id":"3aaae342-78df-46d9-8fc2-2389b763965e","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"2d96aba9-b694-4af3-b5f0-9b23735b3718","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Delete a metadata template and its instances.\n\nhttps://developer.box.com/reference/delete-metadata-templates-id-id-schema"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"def91b67-09c9-47a0-ab4e-69ef99e10633","name":"[403] Request body contains a scope that the user is not allowed to","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/metadata_templates/:scope/:template_key/schema","protocol":"https","host":["api.box.com"],"path":["2.0","metadata_templates",":scope",":template_key","schema"],"variable":[{"id":"3aaae342-78df-46d9-8fc2-2389b763965e","key":"scope","value":"global","description":"The scope of the metadata template."},{"id":"2d96aba9-b694-4af3-b5f0-9b23735b3718","key":"template_key","value":"properties","description":"The name of the metadata template."}]},"description":"Delete a metadata template and its instances.\n\nhttps://developer.box.com/reference/delete-metadata-templates-id-id-schema"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"cacf8252-380a-4bab-8974-56a6401d30fe"}],"id":"03afa603-bb46-4ec3-a261-fe62c1ab7833","_postman_id":"03afa603-bb46-4ec3-a261-fe62c1ab7833","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Returns information about the recent items accessed
\nhttps://developer.box.com/reference/get-recent-items
\n","urlObject":{"protocol":"https","path":["2.0","recent_items"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
Retrieves all of the retention policies for an enterprise.
\nhttps://developer.box.com/reference/get-retention-policies
\n","urlObject":{"protocol":"https","path":["2.0","retention_policies"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Filters results by a case sensitive prefix of the name of\nretention policies.
\n","type":"text/plain"},"key":"policy_name","value":"Sales Policy"},{"disabled":true,"description":{"content":"Filters results by the type of retention policy.
\n","type":"text/plain"},"key":"policy_type","value":"finite"},{"disabled":true,"description":{"content":"Filters results by the ID of the user who created policy.
\n","type":"text/plain"},"key":"created_by_user_id","value":"21312321"},{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\n","type":"text/plain"},"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"}],"variable":[]}},"response":[{"id":"23f59e02-2389-433d-8e28-f5d3c2165430","name":"[200] Returns a list retention policies in the enterprise.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/retention_policies","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policies"],"query":[{"key":"policy_name","value":"Sales Policy","description":"Filters results by a case sensitive prefix of the name of\nretention policies.","disabled":true},{"key":"policy_type","value":"finite","description":"Filters results by the type of retention policy.","disabled":true},{"key":"created_by_user_id","value":"21312321","description":"Filters results by the ID of the user who created policy.","disabled":true},{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true}]},"description":"Retrieves all of the retention policies for an enterprise.\n\nhttps://developer.box.com/reference/get-retention-policies"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"id\": \"12345\",\n \"type\": \"retention_policy\",\n \"policy_name\": \"Some Policy Name\",\n \"retention_length\": \"365\",\n \"disposition_action\": \"permanently_delete\",\n \"description\": \"Policy to retain all reports for at least one month\",\n \"policy_type\": \"finite\",\n \"retention_type\": \"non_modifiable\",\n \"status\": \"active\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"can_owner_extend_retention\": false,\n \"are_owners_notified\": false,\n \"custom_notification_recipients\": [\n {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n }\n ],\n \"assignment_counts\": {\n \"enterprise\": 1,\n \"folder\": 1,\n \"metadata_template\": 1\n }\n }\n ],\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\"\n}"},{"id":"2614a4f5-3a28-4984-af50-67b949f33ddc","name":"[400] Returns a `bad_request` if a non existent `policy_type` was specified.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/retention_policies","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policies"],"query":[{"key":"policy_name","value":"Sales Policy","description":"Filters results by a case sensitive prefix of the name of\nretention policies.","disabled":true},{"key":"policy_type","value":"finite","description":"Filters results by the type of retention policy.","disabled":true},{"key":"created_by_user_id","value":"21312321","description":"Filters results by the ID of the user who created policy.","disabled":true},{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true}]},"description":"Retrieves all of the retention policies for an enterprise.\n\nhttps://developer.box.com/reference/get-retention-policies"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"01dd642b-c500-4b70-8548-0f055c5253a9","name":"[404] Returns a `not_found` error if the user specified in `created_by_user_id`","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/retention_policies","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policies"],"query":[{"key":"policy_name","value":"Sales Policy","description":"Filters results by a case sensitive prefix of the name of\nretention policies.","disabled":true},{"key":"policy_type","value":"finite","description":"Filters results by the type of retention policy.","disabled":true},{"key":"created_by_user_id","value":"21312321","description":"Filters results by the ID of the user who created policy.","disabled":true},{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true}]},"description":"Retrieves all of the retention policies for an enterprise.\n\nhttps://developer.box.com/reference/get-retention-policies"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"4ceeab09-c832-4425-84dc-a601d528b740"},{"name":"Get retention policy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"aaa56ba0-bc48-4fab-b2fa-5c71fe1f2a58","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves a retention policy.
\nhttps://developer.box.com/reference/get-retention-policies-id
\n","urlObject":{"protocol":"https","path":["2.0","retention_policies",":retention_policy_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"aa2130cb-4135-494e-9d81-08479d1415e4","description":{"content":"The ID of the retention policy.
\n","type":"text/plain"},"type":"any","value":"982312","key":"retention_policy_id"}]}},"response":[{"id":"a02fef70-7582-4696-a164-228e3de38349","name":"[200] Returns the retention policy object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/retention_policies/:retention_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policies",":retention_policy_id"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}],"variable":[{"id":"aa2130cb-4135-494e-9d81-08479d1415e4","key":"retention_policy_id","value":"982312","description":"The ID of the retention policy."}]},"description":"Retrieves a retention policy.\n\nhttps://developer.box.com/reference/get-retention-policies-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"type\": \"retention_policy\",\n \"policy_name\": \"Some Policy Name\",\n \"retention_length\": \"365\",\n \"disposition_action\": \"permanently_delete\",\n \"description\": \"Policy to retain all reports for at least one month\",\n \"policy_type\": \"finite\",\n \"retention_type\": \"non_modifiable\",\n \"status\": \"active\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"can_owner_extend_retention\": false,\n \"are_owners_notified\": false,\n \"custom_notification_recipients\": [\n {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n }\n ],\n \"assignment_counts\": {\n \"enterprise\": 1,\n \"folder\": 1,\n \"metadata_template\": 1\n }\n}"}],"_postman_id":"aaa56ba0-bc48-4fab-b2fa-5c71fe1f2a58"},{"name":"Create retention policy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"3338a389-6861-44fe-a717-79cc82874ad3","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Creates a retention policy.
\nhttps://developer.box.com/reference/post-retention-policies
\n","urlObject":{"protocol":"https","path":["2.0","retention_policies"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"46dd0225-bd91-4605-9c59-3ec4dda881bc","name":"[201] Returns a new retention policy object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_name\": \"Some Policy Name\",\n \"description\": \"Policy to retain all reports for at least one month\",\n \"policy_type\": \"finite\",\n \"disposition_action\": \"permanently_delete\",\n \"retention_length\": \"365\",\n \"retention_type\": \"modifiable\",\n \"can_owner_extend_retention\": true,\n \"are_owners_notified\": true,\n \"custom_notification_recipients\": [\n {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n }\n ]\n}"},"url":"https://api.box.com/2.0/retention_policies","description":"Creates a retention policy.\n\nhttps://developer.box.com/reference/post-retention-policies"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"type\": \"retention_policy\",\n \"policy_name\": \"Some Policy Name\",\n \"retention_length\": \"365\",\n \"disposition_action\": \"permanently_delete\",\n \"description\": \"Policy to retain all reports for at least one month\",\n \"policy_type\": \"finite\",\n \"retention_type\": \"non_modifiable\",\n \"status\": \"active\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"can_owner_extend_retention\": false,\n \"are_owners_notified\": false,\n \"custom_notification_recipients\": [\n {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n }\n ],\n \"assignment_counts\": {\n \"enterprise\": 1,\n \"folder\": 1,\n \"metadata_template\": 1\n }\n}"},{"id":"719182c6-cc55-4cd8-a6d3-9aeab6578460","name":"[400] Returns a `bad_request` error with the `retention_length` was","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_name\": \"Some Policy Name\",\n \"description\": \"Policy to retain all reports for at least one month\",\n \"policy_type\": \"finite\",\n \"disposition_action\": \"permanently_delete\",\n \"retention_length\": \"365\",\n \"retention_type\": \"modifiable\",\n \"can_owner_extend_retention\": true,\n \"are_owners_notified\": true,\n \"custom_notification_recipients\": [\n {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n }\n ]\n}"},"url":"https://api.box.com/2.0/retention_policies","description":"Creates a retention policy.\n\nhttps://developer.box.com/reference/post-retention-policies"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"03fdd2da-e241-4012-b732-22feaafd78fe","name":"[409] Returns an error if a retention policy with the given name already exists.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_name\": \"Some Policy Name\",\n \"description\": \"Policy to retain all reports for at least one month\",\n \"policy_type\": \"finite\",\n \"disposition_action\": \"permanently_delete\",\n \"retention_length\": \"365\",\n \"retention_type\": \"modifiable\",\n \"can_owner_extend_retention\": true,\n \"are_owners_notified\": true,\n \"custom_notification_recipients\": [\n {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n }\n ]\n}"},"url":"https://api.box.com/2.0/retention_policies","description":"Creates a retention policy.\n\nhttps://developer.box.com/reference/post-retention-policies"},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"3338a389-6861-44fe-a717-79cc82874ad3"},{"name":"Update retention policy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"310b5349-912d-4967-bbed-4526614d582c","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Updates a retention policy.
\nhttps://developer.box.com/reference/put-retention-policies-id
\n","urlObject":{"protocol":"https","path":["2.0","retention_policies",":retention_policy_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"03b1a560-5757-4f6f-8ff7-83b1ddb00942","description":{"content":"The ID of the retention policy.
\n","type":"text/plain"},"type":"any","value":"982312","key":"retention_policy_id"}]}},"response":[{"id":"ae5b6ece-1467-4954-a570-665bcbfff7cc","name":"[200] Returns the updated retention policy object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_name\": \"Some Policy Name\",\n \"description\": \"Policy to retain all reports for at least one month\",\n \"disposition_action\": \"permanently_delete\",\n \"retention_type\": \"non-modifiable\",\n \"retention_length\": \"365\",\n \"status\": \"retired\",\n \"can_owner_extend_retention\": false,\n \"are_owners_notified\": false,\n \"custom_notification_recipients\": [\n {\n \"id\": \"11446498\",\n \"type\": \"user\"\n }\n ]\n}"},"url":{"raw":"https://api.box.com/2.0/retention_policies/:retention_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policies",":retention_policy_id"],"variable":[{"id":"03b1a560-5757-4f6f-8ff7-83b1ddb00942","key":"retention_policy_id","value":"982312","description":"The ID of the retention policy."}]},"description":"Updates a retention policy.\n\nhttps://developer.box.com/reference/put-retention-policies-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"type\": \"retention_policy\",\n \"policy_name\": \"Some Policy Name\",\n \"retention_length\": \"365\",\n \"disposition_action\": \"permanently_delete\",\n \"description\": \"Policy to retain all reports for at least one month\",\n \"policy_type\": \"finite\",\n \"retention_type\": \"non_modifiable\",\n \"status\": \"active\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"can_owner_extend_retention\": false,\n \"are_owners_notified\": false,\n \"custom_notification_recipients\": [\n {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n }\n ],\n \"assignment_counts\": {\n \"enterprise\": 1,\n \"folder\": 1,\n \"metadata_template\": 1\n }\n}"},{"id":"5b8575b2-e124-44ca-9cf6-840e9d57e030","name":"[400] Returns a `bad_request` if an incorrect","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_name\": \"Some Policy Name\",\n \"description\": \"Policy to retain all reports for at least one month\",\n \"disposition_action\": \"permanently_delete\",\n \"retention_type\": \"non-modifiable\",\n \"retention_length\": \"365\",\n \"status\": \"retired\",\n \"can_owner_extend_retention\": false,\n \"are_owners_notified\": false,\n \"custom_notification_recipients\": [\n {\n \"id\": \"11446498\",\n \"type\": \"user\"\n }\n ]\n}"},"url":{"raw":"https://api.box.com/2.0/retention_policies/:retention_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policies",":retention_policy_id"],"variable":[{"id":"03b1a560-5757-4f6f-8ff7-83b1ddb00942","key":"retention_policy_id","value":"982312","description":"The ID of the retention policy."}]},"description":"Updates a retention policy.\n\nhttps://developer.box.com/reference/put-retention-policies-id"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"d2fc8583-6972-4be3-b38a-f3e76f6689c3","name":"[403] Returns an error when a user wants to","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_name\": \"Some Policy Name\",\n \"description\": \"Policy to retain all reports for at least one month\",\n \"disposition_action\": \"permanently_delete\",\n \"retention_type\": \"non-modifiable\",\n \"retention_length\": \"365\",\n \"status\": \"retired\",\n \"can_owner_extend_retention\": false,\n \"are_owners_notified\": false,\n \"custom_notification_recipients\": [\n {\n \"id\": \"11446498\",\n \"type\": \"user\"\n }\n ]\n}"},"url":{"raw":"https://api.box.com/2.0/retention_policies/:retention_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policies",":retention_policy_id"],"variable":[{"id":"03b1a560-5757-4f6f-8ff7-83b1ddb00942","key":"retention_policy_id","value":"982312","description":"The ID of the retention policy."}]},"description":"Updates a retention policy.\n\nhttps://developer.box.com/reference/put-retention-policies-id"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"0e205a62-25c0-4ade-a9bd-3fe4450d7e71","name":"[409] Returns an error if a retention policy with the given name already exists.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_name\": \"Some Policy Name\",\n \"description\": \"Policy to retain all reports for at least one month\",\n \"disposition_action\": \"permanently_delete\",\n \"retention_type\": \"non-modifiable\",\n \"retention_length\": \"365\",\n \"status\": \"retired\",\n \"can_owner_extend_retention\": false,\n \"are_owners_notified\": false,\n \"custom_notification_recipients\": [\n {\n \"id\": \"11446498\",\n \"type\": \"user\"\n }\n ]\n}"},"url":{"raw":"https://api.box.com/2.0/retention_policies/:retention_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policies",":retention_policy_id"],"variable":[{"id":"03b1a560-5757-4f6f-8ff7-83b1ddb00942","key":"retention_policy_id","value":"982312","description":"The ID of the retention policy."}]},"description":"Updates a retention policy.\n\nhttps://developer.box.com/reference/put-retention-policies-id"},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"310b5349-912d-4967-bbed-4526614d582c"},{"name":"Delete retention policy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"5a9c8719-79de-40d3-b3ae-564a31b479e1","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Permanently deletes a retention policy.
\nhttps://developer.box.com/reference/delete-retention-policies-id
\n","urlObject":{"protocol":"https","path":["2.0","retention_policies",":retention_policy_id"],"host":["api.box.com"],"query":[],"variable":[{"id":"fb3c92e6-bda0-4741-a35e-bad409f29923","description":{"content":"The ID of the retention policy.
\n","type":"text/plain"},"type":"any","value":"982312","key":"retention_policy_id"}]}},"response":[{"id":"ea7b1539-748f-405b-820f-643c168d9d06","name":"[204] Returns an empty response when the policy has been deleted.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/retention_policies/:retention_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policies",":retention_policy_id"],"variable":[{"id":"fb3c92e6-bda0-4741-a35e-bad409f29923","key":"retention_policy_id","value":"982312","description":"The ID of the retention policy."}]},"description":"Permanently deletes a retention policy.\n\nhttps://developer.box.com/reference/delete-retention-policies-id"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"fb0d56bf-f866-4d57-ab45-4b70b578a37b","name":"[403] Returns an error if the policy is non-modifiable or the user does","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/retention_policies/:retention_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policies",":retention_policy_id"],"variable":[{"id":"fb3c92e6-bda0-4741-a35e-bad409f29923","key":"retention_policy_id","value":"982312","description":"The ID of the retention policy."}]},"description":"Permanently deletes a retention policy.\n\nhttps://developer.box.com/reference/delete-retention-policies-id"},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"145781d5-cb30-4d6e-866e-7750c4989b84","name":"[404] Returns an error if the policy is not found.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"DELETE","header":[],"url":{"raw":"https://api.box.com/2.0/retention_policies/:retention_policy_id","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policies",":retention_policy_id"],"variable":[{"id":"fb3c92e6-bda0-4741-a35e-bad409f29923","key":"retention_policy_id","value":"982312","description":"The ID of the retention policy."}]},"description":"Permanently deletes a retention policy.\n\nhttps://developer.box.com/reference/delete-retention-policies-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"5a9c8719-79de-40d3-b3ae-564a31b479e1"}],"id":"8e264fc5-f599-4fae-ad8b-4604d554a250","_postman_id":"8e264fc5-f599-4fae-ad8b-4604d554a250","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Returns a list of all retention policy assignments associated with a specified
\nhttps://developer.box.com/reference/get-retention-policies-id-assignments
\n","urlObject":{"protocol":"https","path":["2.0","retention_policies",":retention_policy_id","assignments"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"The type of the retention policy assignment to retrieve.
\n","type":"text/plain"},"key":"type","value":"metadata_template"},{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"},{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\n","type":"text/plain"},"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"disabled":true,"description":{"content":"The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[{"id":"ee0a9212-8902-476a-9e2a-aef559229526","description":{"content":"The ID of the retention policy.
\n","type":"text/plain"},"type":"any","value":"982312","key":"retention_policy_id"}]}},"response":[{"id":"d6c09c4e-21d6-4a6a-94de-4c84b85145f5","name":"[200] Returns a list of the retention policy assignments associated with the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/retention_policies/:retention_policy_id/assignments","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policies",":retention_policy_id","assignments"],"query":[{"key":"type","value":"metadata_template","description":"The type of the retention policy assignment to retrieve.","disabled":true},{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"ee0a9212-8902-476a-9e2a-aef559229526","key":"retention_policy_id","value":"982312","description":"The ID of the retention policy."}]},"description":"Returns a list of all retention policy assignments associated with a specified\n\nhttps://developer.box.com/reference/get-retention-policies-id-assignments"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"id\": \"11446498\",\n \"type\": \"retention_policy_assignment\",\n \"retention_policy\": {\n \"id\": \"12345\",\n \"type\": \"retention_policy\",\n \"policy_name\": \"Some Policy Name\",\n \"retention_length\": \"365\",\n \"disposition_action\": \"permanently_delete\"\n },\n \"assigned_to\": {\n \"id\": \"a983f69f-e85f-4ph4-9f46-4afdf9c1af65\",\n \"type\": \"metadata_template\"\n },\n \"filter_fields\": [\n {\n \"field\": \"a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4\",\n \"value\": \"0c27b756-0p87-4fe0-a43a-59fb661ccc4e\"\n }\n ],\n \"assigned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"start_date_field\": \"upload_date\"\n }\n ],\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\"\n}"},{"id":"aba44f2c-9548-4586-94c0-764c43ff65bd","name":"[400] Returns an error if an unknown `type` is specified.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/retention_policies/:retention_policy_id/assignments","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policies",":retention_policy_id","assignments"],"query":[{"key":"type","value":"metadata_template","description":"The type of the retention policy assignment to retrieve.","disabled":true},{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true},{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"ee0a9212-8902-476a-9e2a-aef559229526","key":"retention_policy_id","value":"982312","description":"The ID of the retention policy."}]},"description":"Returns a list of all retention policy assignments associated with a specified\n\nhttps://developer.box.com/reference/get-retention-policies-id-assignments"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"04d62f40-ab1a-4281-a05d-8a22b8bbc5bf"},{"name":"Get retention policy assignment","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"8f98b84a-09c1-404d-8e73-67544018138f","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves a retention policy assignment.
\nhttps://developer.box.com/reference/get-retention-policy-assignments-id
\n","urlObject":{"protocol":"https","path":["2.0","retention_policy_assignments",":retention_policy_assignment_id"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.
\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.
\n","type":"text/plain"},"key":"fields","value":"id,type,name"}],"variable":[{"id":"cd15ef8b-028c-4ecd-be5f-4771d60f51e6","description":{"content":"The ID of the retention policy assignment.
\n","type":"text/plain"},"type":"any","value":"1233123","key":"retention_policy_assignment_id"}]}},"response":[{"id":"7a4ea965-373e-4f2a-adbd-aa4ddb987e92","name":"[200] Returns the retention policy assignment object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/retention_policy_assignments/:retention_policy_assignment_id","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policy_assignments",":retention_policy_assignment_id"],"query":[{"key":"fields","value":"id,type,name","description":"A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.","disabled":true}],"variable":[{"id":"cd15ef8b-028c-4ecd-be5f-4771d60f51e6","key":"retention_policy_assignment_id","value":"1233123","description":"The ID of the retention policy assignment."}]},"description":"Retrieves a retention policy assignment.\n\nhttps://developer.box.com/reference/get-retention-policy-assignments-id"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"retention_policy_assignment\",\n \"retention_policy\": {\n \"id\": \"12345\",\n \"type\": \"retention_policy\",\n \"policy_name\": \"Some Policy Name\",\n \"retention_length\": \"365\",\n \"disposition_action\": \"permanently_delete\"\n },\n \"assigned_to\": {\n \"id\": \"a983f69f-e85f-4ph4-9f46-4afdf9c1af65\",\n \"type\": \"metadata_template\"\n },\n \"filter_fields\": [\n {\n \"field\": \"a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4\",\n \"value\": \"0c27b756-0p87-4fe0-a43a-59fb661ccc4e\"\n }\n ],\n \"assigned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"start_date_field\": \"upload_date\"\n}"}],"_postman_id":"8f98b84a-09c1-404d-8e73-67544018138f"},{"name":"Get files under retention","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"dfaf7cf7-7298-49f3-a0d4-913b9d4d3002","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Returns a list of files under retention for a retention policy assignment.
\nhttps://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention
\n","urlObject":{"protocol":"https","path":["2.0","retention_policy_assignments",":retention_policy_assignment_id","files_under_retention"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[{"id":"4a535a37-56b2-4d9b-8b3d-d84e094b21f9","description":{"content":"The ID of the retention policy assignment.
\n","type":"text/plain"},"type":"any","value":"1233123","key":"retention_policy_assignment_id"}]}},"response":[{"id":"f4f0f8be-e3b9-47dc-8926-df1d2143f570","name":"[200] Returns a list of files under retention that are associated with the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policy_assignments",":retention_policy_assignment_id","files_under_retention"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"4a535a37-56b2-4d9b-8b3d-d84e094b21f9","key":"retention_policy_assignment_id","value":"1233123","description":"The ID of the retention policy assignment."}]},"description":"Returns a list of files under retention for a retention policy assignment.\n\nhttps://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n }\n }\n ]\n}"},{"id":"a79ecec8-b45c-4083-9284-b2d12df73dd3","name":"[400] Returns an error if `retention_policy_assignment_id` is not specified.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policy_assignments",":retention_policy_assignment_id","files_under_retention"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"4a535a37-56b2-4d9b-8b3d-d84e094b21f9","key":"retention_policy_assignment_id","value":"1233123","description":"The ID of the retention policy assignment."}]},"description":"Returns a list of files under retention for a retention policy assignment.\n\nhttps://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"dfaf7cf7-7298-49f3-a0d4-913b9d4d3002"},{"name":"Get file versions under retention","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"54526677-7b6b-4bff-8450-93b719278535","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Returns a list of file versions under retention for a retention policy
\n\n","urlObject":{"protocol":"https","path":["2.0","retention_policy_assignments",":retention_policy_assignment_id","file_versions_under_retention"],"host":["api.box.com"],"query":[{"disabled":true,"description":{"content":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.
\nThis requires usemarker to be set to true.
The maximum number of items to return per page.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[{"id":"e4663a49-ef49-4226-b136-414b00407219","description":{"content":"The ID of the retention policy assignment.
\n","type":"text/plain"},"type":"any","value":"1233123","key":"retention_policy_assignment_id"}]}},"response":[{"id":"ba43a9d8-42af-45fb-bb49-5da35b64cf6b","name":"[200] Returns a list of file versions under retention that are associated with","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policy_assignments",":retention_policy_assignment_id","file_versions_under_retention"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"e4663a49-ef49-4226-b136-414b00407219","key":"retention_policy_assignment_id","value":"1233123","description":"The ID of the retention policy assignment."}]},"description":"Returns a list of file versions under retention for a retention policy\n\nhttps://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 1000,\n \"next_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii\",\n \"prev_marker\": \"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih\",\n \"entries\": [\n {\n \"id\": \"12345\",\n \"etag\": \"1\",\n \"type\": \"file\",\n \"sequence_id\": \"3\",\n \"name\": \"Contract.pdf\",\n \"sha1\": \"85136C79CBF9FE36BB9D05D0639C70C265C18D37\",\n \"file_version\": {\n \"id\": \"12345\",\n \"type\": \"file_version\",\n \"sha1\": \"134b65991ed521fcfe4724b7d814ab8ded5185dc\"\n }\n }\n ]\n}"},{"id":"b05288a1-aeb6-4157-9546-9e89607bb5f6","name":"[400] Returns an error if `retention_policy_assignment_id` is not specified.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"GET","header":[],"url":{"raw":"https://api.box.com/2.0/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention","protocol":"https","host":["api.box.com"],"path":["2.0","retention_policy_assignments",":retention_policy_assignment_id","file_versions_under_retention"],"query":[{"key":"marker","value":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","description":"Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","disabled":true},{"key":"limit","value":"1000","description":"The maximum number of items to return per page.","disabled":true}],"variable":[{"id":"e4663a49-ef49-4226-b136-414b00407219","key":"retention_policy_assignment_id","value":"1233123","description":"The ID of the retention policy assignment."}]},"description":"Returns a list of file versions under retention for a retention policy\n\nhttps://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"54526677-7b6b-4bff-8450-93b719278535"},{"name":"Assign retention policy","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"abc05aed-a9cf-437f-bd17-a88a439928d2","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Assigns a retention policy to an item.
\nhttps://developer.box.com/reference/post-retention-policy-assignments
\n","urlObject":{"protocol":"https","path":["2.0","retention_policy_assignments"],"host":["api.box.com"],"query":[],"variable":[]}},"response":[{"id":"828304a6-c9a7-49de-9505-330303c66ef2","name":"[201] Returns a new retention policy assignment object.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_id\": \"173463\",\n \"assign_to\": {\n \"type\": \"metadata_template\",\n \"id\": \"6564564\"\n },\n \"filter_fields\": [\n {\n \"field\": \"a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4\",\n \"value\": \"0c27b756-0p87-4fe0-a43a-59fb661ccc4e\"\n }\n ],\n \"start_date_field\": \"upload_date\"\n}"},"url":"https://api.box.com/2.0/retention_policy_assignments","description":"Assigns a retention policy to an item.\n\nhttps://developer.box.com/reference/post-retention-policy-assignments"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"11446498\",\n \"type\": \"retention_policy_assignment\",\n \"retention_policy\": {\n \"id\": \"12345\",\n \"type\": \"retention_policy\",\n \"policy_name\": \"Some Policy Name\",\n \"retention_length\": \"365\",\n \"disposition_action\": \"permanently_delete\"\n },\n \"assigned_to\": {\n \"id\": \"a983f69f-e85f-4ph4-9f46-4afdf9c1af65\",\n \"type\": \"metadata_template\"\n },\n \"filter_fields\": [\n {\n \"field\": \"a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4\",\n \"value\": \"0c27b756-0p87-4fe0-a43a-59fb661ccc4e\"\n }\n ],\n \"assigned_by\": {\n \"id\": \"11446498\",\n \"type\": \"user\",\n \"name\": \"Aaron Levie\",\n \"login\": \"ceo@example.com\"\n },\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"start_date_field\": \"upload_date\"\n}"},{"id":"4196a078-fca9-4d67-b523-ac3ea82aa786","name":"[400] Returns an error if an `id` is specified while assigning the","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_id\": \"173463\",\n \"assign_to\": {\n \"type\": \"metadata_template\",\n \"id\": \"6564564\"\n },\n \"filter_fields\": [\n {\n \"field\": \"a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4\",\n \"value\": \"0c27b756-0p87-4fe0-a43a-59fb661ccc4e\"\n }\n ],\n \"start_date_field\": \"upload_date\"\n}"},"url":"https://api.box.com/2.0/retention_policy_assignments","description":"Assigns a retention policy to an item.\n\nhttps://developer.box.com/reference/post-retention-policy-assignments"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"51f22ffa-7d0a-43f3-819f-2e4c98e997bc","name":"[404] Returns an error if no retention policy with the given `policy_id` exists.","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_id\": \"173463\",\n \"assign_to\": {\n \"type\": \"metadata_template\",\n \"id\": \"6564564\"\n },\n \"filter_fields\": [\n {\n \"field\": \"a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4\",\n \"value\": \"0c27b756-0p87-4fe0-a43a-59fb661ccc4e\"\n }\n ],\n \"start_date_field\": \"upload_date\"\n}"},"url":"https://api.box.com/2.0/retention_policy_assignments","description":"Assigns a retention policy to an item.\n\nhttps://developer.box.com/reference/post-retention-policy-assignments"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"},{"id":"4187ce94-27e6-4916-9b3d-bc1dbf16ff87","name":"[409] Returns an error if a retention policy of equal or greater length has","originalRequest":{"auth":{"type":"oauth2","oauth2":{"accessToken":"{{access_token}}","tokenType":"bearer","addTokenTo":"header"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"policy_id\": \"173463\",\n \"assign_to\": {\n \"type\": \"metadata_template\",\n \"id\": \"6564564\"\n },\n \"filter_fields\": [\n {\n \"field\": \"a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4\",\n \"value\": \"0c27b756-0p87-4fe0-a43a-59fb661ccc4e\"\n }\n ],\n \"start_date_field\": \"upload_date\"\n}"},"url":"https://api.box.com/2.0/retention_policy_assignments","description":"Assigns a retention policy to an item.\n\nhttps://developer.box.com/reference/post-retention-policy-assignments"},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"error\",\n \"status\": 400,\n \"code\": \"item_name_invalid\",\n \"message\": \"Method Not Allowed\",\n \"context_info\": {\n \"message\": \"Something went wrong\"\n },\n \"help_url\": \"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/\",\n \"request_id\": \"abcdef123456\"\n}"}],"_postman_id":"abc05aed-a9cf-437f-bd17-a88a439928d2"},{"name":"Remove retention policy assignment","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["/* global pm */\n\n/**\n * Pre-request script ran before every API request.\n *\n * Used to notify users that their access token has expired\n */\n\n// determine if the Access Token has expired\nconst expiresAt = pm.environment.get('expires_at')\nconst expired = Date.now() > Number(expiresAt)\n\n// determine if the user has auto-refresh enabled\nconst autoRefresh = String(pm.environment.get('enable_auto_refresh_access_token')) === 'true'\n\n// determine if we have all the client credentials needed in the environment\nconst hasClientId = String(pm.environment.get('client_id')).length === 32\nconst hasClientSecret = String(pm.environment.get('client_secret')).length === 32\nconst hasRefreshToken = String(pm.environment.get('refresh_token')).length === 64\nconst hasAllCredentials = hasClientId && hasClientSecret && hasRefreshToken\n\n// if the access token expired and auto refresh has been set, use the refresh\n// token to create a new access token\nif (expired && autoRefresh && hasAllCredentials) {\n // send a new API request to refresh the access token\n pm.sendRequest({\n url: 'https://api.box.com/oauth2/token',\n method: 'POST',\n headers: { 'Content-Type': 'Content-Type: application/x-www-form-urlencoded' },\n body: {\n mode: 'urlencoded',\n urlencoded: [\n { key: 'client_id', value: pm.environment.get('client_id'), disabled: false },\n { key: 'client_secret', value: pm.environment.get('client_secret'), disabled: false },\n { key: 'refresh_token', value: pm.environment.get('refresh_token'), disabled: false },\n { key: 'grant_type', value: 'refresh_token', disabled: false }\n ]\n }\n }, function (error, response) {\n if (error || response.json().error) {\n // if an error occured, log the error and raise a message to the user.\n console.log('Could not refresh the access token')\n console.log(error)\n console.log(response.json())\n throw new Error('Could not refresh the access token. Check the console for more details.')\n } else {\n // otherwise, fetch the new access token and store it\n const data = response.json()\n\n // determine when this token is set to expire at\n const newExpiresAt = Date.now() + data.expires_in * 1000\n // store the new variables in the environment\n pm.environment.set('access_token', data.access_token)\n pm.environment.set('refresh_token', data.refresh_token)\n pm.environment.set('expires_at', newExpiresAt)\n }\n })\n} else if (expired) {\n // otherwise, throw a message to the user if the access token expired.\n throw new Error('Access token expired. Please use the \"Authorization => Refresh access token\" API to request a new token.')\n}\n"],"id":"94eed9ee-5109-553f-a4a6-4c7ea7125f5e"}}],"id":"4dc3b727-1caa-49d5-9690-232e21097e1f","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{access_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Removes a retention policy assignment
\n