> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Update web link
> Updates a web link object.
This endpoint is in the version **2024.0**. No changes are required to continue using it. For more details, see **[Box API versioning](/guides/api-calls/api-versioning-strategy)**.
Learn more about [Box SDK versioning strategy](/guides/tooling/sdks/sdk-versioning/).
## OpenAPI
````yaml /box-openapi.json PUT /web_links/{web_link_id}
openapi: 3.0.2
info:
title: Box Platform API
description: >-
[Box Platform](https://developer.box.com) provides functionality to provide
access to content stored within [Box](https://box.com). 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.
termsOfService: https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9
contact:
name: Box, Inc
url: https://developer.box.com
email: devrel@box.com
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '2024.0'
x-box-commit-hash: 95117b97f9
servers:
- url: https://api.box.com/2.0
description: Box Platform API server.
security:
- OAuth2Security: []
tags:
- name: AI
description: A set of endpoints used to interact with supported LLMs.
x-box-tag: ai
- name: AI Studio
description: A set of endpoints used to interact with AI Studio.
x-box-tag: ai_studio
- name: App item associations
x-box-tag: app_item_associations
- name: Authorization
description: A set of endpoints used to manage user authorization process.
x-box-tag: authorization
x-box-priority: true
- name: Box Sign requests
description: Box Sign requests are used to submit a file for signature.
x-box-tag: sign_requests
- name: Classifications
description: >-
Classification labels are used for content that is sensitive or under
security restrictions.
x-box-tag: classifications
- name: Classifications on files
description: >-
Classification labels are used for files that are sensitive or under
security restrictions.
x-box-tag: file_classifications
- name: Classifications on folders
description: >-
Classification labels are used for folders that are sensitive or under
security restrictions.
x-box-tag: folder_classifications
- name: Collaborations
description: >-
Collaborations define access permissions for users and groups to files and
folders, similar to access control lists.
x-box-tag: user_collaborations
- name: Collaborations (List)
description: >-
A set of endpoints used to retrieve file, folder, pending, and group
collaborations.
x-box-tag: list_collaborations
- name: Collections
description: >-
Collections are a way to group files, folders, and web links without
putting them all into a folder.
x-box-tag: collections
- name: Comments
description: >-
Comments are messages generated users on files, allowing users to
collaborate on a file, discussing any feedback they might have on the
content.
x-box-tag: comments
- name: Device pinners
description: >-
Device pinners allow enterprises to control what devices can use native
Box applications.
x-box-tag: device_pinners
- name: Domain restrictions (User exemptions)
description: >-
A set of endpoints that allow exempting users from restrictions imposed by
the list of allowed collaboration domains for a specific enterprise.
x-box-tag: collaboration_allowlist_exempt_targets
- name: Domain restrictions for collaborations
description: >-
A set of endpoints that manage domains for which users can collaborate
with files and folders in an enterprise.
x-box-tag: collaboration_allowlist_entries
- name: Downloads
description: >-
Downloads allow saving files to the application's server, or directly by
the end user in a browser.
x-box-tag: downloads
- name: Email aliases
description: >-
Email aliases provide a list of emails additional to the user's primary
login email.
x-box-tag: email_aliases
- name: Events
description: >-
Events provide a way for an application to subscribe to any actions
performed by any user, users, or service in an enterprise.
x-box-tag: events
- name: File requests
description: >-
File Requests provide a fast and secure way to request files and
associated metadata from anyone. Users can create new file requests based
on an existing file request, update file request settings, activate,
deactivate, and delete file requests programmatically.
x-box-tag: file_requests
- name: File version legal holds
description: >-
A legal hold is a process that an enterprise can use to preserve all forms
of potentially relevant information when litigation is pending or
reasonably anticipated. A File Version Legal Hold represents all the
policies that are assigned to a specific file version.
x-box-tag: file_version_legal_holds
- name: File version retentions
description: >-
A retention policy blocks permanent deletion of content for a specified
amount of time. A file version retention is a record for a retained file.
x-box-tag: file_version_retentions
- name: File versions
description: A set of endpoints used to manage specific versions of a file.
x-box-tag: file_versions
- name: Files
description: >-
Files, together with Folders, are at the core of the Box API. Files can be
uploaded and downloaded, as well as hold important metadata information
about the content.
x-box-tag: files
- name: Folder Locks
description: >-
Folder locks define access restrictions placed by folder owners to prevent
specific folders from being moved or deleted.
x-box-tag: folder_locks
- name: Folders
description: >-
Folders, together with Files, are at the core of the Box API. Folders can
be uploaded and downloaded, as well as hold important metadata information
about the content.
x-box-tag: folders
- name: Integration mappings
description: >-
Integration Mappings allow the users to manage where content from partner
apps is stored in Box.
x-box-tag: integration_mappings
- name: Group memberships
description: Group memberships signify that a user is a part of the group.
x-box-tag: memberships
- name: Groups
description: Groups created in an enterprise.
x-box-tag: groups
- name: Invites
description: Invites are used to invite the user to an enterprise.
x-box-tag: invites
- name: Legal hold policies
description: >-
A legal hold is a process that an enterprise can use to preserve all forms
of potentially relevant information when litigation is pending or
reasonably anticipated.
x-box-tag: legal_hold_policies
- name: Legal hold policy assignments
description: >-
A Legal Hold Policy Assignment is a relation between a policy and
custodian. In this case, as custodian can be a user, folder, file, or file
version.
x-box-tag: legal_hold_policy_assignments
- name: Metadata cascade policies
description: >-
A metadata cascade policy describes how metadata instances applied to a
folder should be applied to any item within that folder.
x-box-tag: metadata_cascade_policies
- name: Metadata instances (Files)
description: >-
A metadata instance describes the relation between a template and a file,
including the values that are assigned for every field.
x-box-tag: file_metadata
- name: Metadata instances (Folders)
description: >-
A metadata instance describes the relation between a template and a
folder, including the values that are assigned for every field.
x-box-tag: folder_metadata
- name: Metadata taxonomies
description: >-
A metadata taxonomy is a hierarchical classification system that helps
organize and manage metadata within an enterprise.
x-box-tag: metadata_taxonomies
- name: Metadata templates
description: >-
A metadata template describes a reusable set of key/value pairs that can
be assigned to a file.
x-box-tag: metadata_templates
- name: Recent items
description: >-
Recent items represent items such as files or folders that the user
accessed recently.
x-box-tag: recent_items
- name: Retention policies
description: >-
A retention policy blocks permanent deletion of content for a specified
amount of time. Admins can create retention policies and then assign them
to specific folders or their entire enterprise.
x-box-tag: retention_policies
- name: Retention policy assignments
description: >-
A Retention Policy Assignment is a relation between a policy and folder or
enterprise. Creating an assignment puts a retention on all the file
versions that belong to that folder or enterprise.
x-box-tag: retention_policy_assignments
- name: Search
description: >-
The Box API provides a way to find content in Box using full-text search
queries.
x-box-tag: search
- name: Session termination
description: >-
Session termination API is used to validate the roles and permissions of
the group, and creates asynchronous jobs to terminate the group's
sessions.
x-box-tag: session_termination
- name: Shared links (Files)
description: >-
Files shared links are URLs that are generated for files stored in Box,
which provide direct, read-only access to the resource.
x-box-tag: shared_links_files
- name: Shared links (Folders)
description: >-
Folders shared links are URLs that are generated for folders stored in
Box, which provide direct, read-only access to the resource.
x-box-tag: shared_links_folders
- name: Shared links (Web Links)
description: >-
Web links for files are URLs that are generated for web links in Box,
which provide direct, read-only access to the resource.
x-box-tag: shared_links_web_links
- name: Shared links (App Items)
description: >-
URLs generated for app items stored in Box, which provide direct,
read-only access to the resource.
x-box-tag: shared_links_app_items
- name: Shield information barriers
description: >-
Shield information barrier in Box defines an ethical wall. An ethical wall
is a mechanism that prevents exchanges or communication that could lead to
conflicts of interest and therefore result in business activities
ethically or legally questionable.
x-box-tag: shield_information_barriers
- name: Shield information barrier segments
description: >-
Shield information barrier segment represents a defined group of users. A
user can be a member of only one segment, which makes segments different
from groups.
x-box-tag: shield_information_barrier_segments
- name: Shield information barrier segment members
description: >-
Shield information barrier segment member represents a user that is
assigned to a specific segment.
x-box-tag: shield_information_barrier_segment_members
- name: Shield information barrier reports
description: >-
Shield information barrier reports contain information on what existing
collaborations will be removed permanently when the information barrier is
enabled.
x-box-tag: shield_information_barrier_reports
- name: Shield information barrier segment restrictions
description: >-
Shield information barrier segment restriction is an access restriction
based on the content (file or folder) owner.
x-box-tag: shield_information_barrier_segment_restrictions
- name: Box Sign templates
description: >-
Sign templates allow you to use a predefined Box Sign template when
creating a signature request. The template includes placeholders that are
automatically populated with data when creating the request.
x-box-tag: sign_templates
- name: Skills
description: >-
Box Skills are designed to allow custom processing of files uploaded to
Box, with the intent of enhancing the underlying metadata of the file.
x-box-tag: skills
- name: Standard and Zones Storage Policies
description: >-
Storage policy assignment represents the storage zone for items in a given
enterprise.
x-box-tag: storage_policies
- name: Standard and Zones Storage Policy Assignments
description: >-
Storage policy assignment represents the relation between storage zone and
the assigned item (for example a file stored in a specific zone).
x-box-tag: storage_policy_assignments
- name: Task assignments
description: >-
A task assignment defines which task is assigned to which user to
complete.
x-box-tag: task_assignments
- name: Tasks
description: >-
Tasks allow users to request collaborators on a file to review a file or
complete a piece of work. Tasks can be used by developers to create
file-centric workflows.
x-box-tag: tasks
- name: Terms of service
description: A set of endpoints used to manage terms of service agreements.
x-box-tag: terms_of_services
- name: Terms of service user statuses
description: >-
A set of endpoints used to manage the status of terms of service for a
particular user.
x-box-tag: terms_of_service_user_statuses
- name: Transfer folders
description: >-
API designed to move all of the items (files, folders and workflows) owned
by a user into another user's account.
x-box-tag: transfer
- name: Trashed files
description: Files that were deleted and are in trash.
x-box-tag: trashed_files
- name: Trashed folders
description: Folders that were deleted and are in trash.
x-box-tag: trashed_folders
- name: Trashed items
description: Items that were deleted and are in trash.
x-box-tag: trashed_items
- name: Trashed web links
description: Web links that were deleted and are in trash.
x-box-tag: trashed_web_links
- name: Uploads
description: >-
The direct file upload API supports files up to 50MB in size and sends all
the binary data to the Box API in 1 API request.
x-box-tag: uploads
- name: Uploads (Chunked)
description: >-
The chunked upload endpoints support files from 20MB in size and allow an
application to upload the file in parts, allowing for more control to
catch any errors and retry parts individually.
x-box-tag: chunked_uploads
- name: User avatars
description: >-
User avatars are JPG or PNG files uploaded to Box to represent the user
image. They are then displayed in the user account.
x-box-tag: avatars
- name: Users
description: >-
Box API supports a variety of users, ranging from real employees logging
in with their Managed User account, to applications using App Users to
drive powerful automation workflows.
x-box-tag: users
- name: Watermarks (Files)
description: >-
A watermark is a semi-transparent overlay on an embedded file preview that
displays a viewer's email address or user ID and the time of access over
the file.
x-box-tag: file_watermarks
- name: Watermarks (Folders)
description: >-
A watermark is a semi-transparent overlay on an embedded folder preview
that displays a viewer's email address or user ID and the time of access
over the folder content.
x-box-tag: folder_watermarks
- name: Web links
description: >-
Web links are objects that point to URLs. These objects are also known as
bookmarks within the Box web application.
x-box-tag: web_links
- name: Webhooks
description: >-
Webhooks allow you to monitor Box content for events, and receive
notifications to a URL of your choice when they occur. For example, a
workflow may include waiting for a file to be downloaded to delete a
shared link.
x-box-tag: webhooks
- name: Workflows
description: >-
Box Relay Workflows are objects that represent a named collection of
flows.
x-box-tag: workflows
- name: Zip Downloads
description: >-
Zip downloads represent a successful request to create a ZIP archive with
files and folders.
x-box-tag: zip_downloads
externalDocs:
description: Box Developer Documentation.
url: https://developer.box.com
paths:
/web_links/{web_link_id}:
put:
tags:
- Web links
summary: Update web link
description: Updates a web link object.
operationId: put_web_links_id
parameters:
- name: web_link_id
in: path
description: The ID of the web link.
required: true
schema:
type: string
example: '12345'
requestBody:
content:
application/json:
schema:
type: object
properties:
url:
description: >-
The new URL that the web link links to. Must start with
`"http://"` or `"https://"`.
type: string
example: https://box.com
parent:
allOf:
- type: object
description: The parent for this item.
properties:
id:
description: The ID of parent item.
type: string
example: '123'
user_id:
description: >-
The input for `user_id` is optional. Moving to
non-root folder is not allowed when `user_id` is
present. Parent folder id should be zero when
`user_id` is provided.
type: string
example: '12346930'
- description: >-
The new parent folder to put the web link in. Use this
to move the web link to a different folder.
name:
description: A new name for the web link. Defaults to the URL if not set.
type: string
example: Box Website
description:
description: A new description of the web link.
type: string
example: Cloud Content Management
shared_link:
description: The settings for the shared link to update.
type: object
properties:
access:
description: >-
The level of access for the shared link. This can be
restricted to anyone with the link (`open`), only people
within the company (`company`) and only those who have
been invited to the folder (`collaborators`).
If not set, this field defaults to the access level
specified by the enterprise admin. To create a shared
link with this default setting pass the `shared_link`
object with no `access` field, for example `{
"shared_link": {} }`.
The `company` access level is only available to paid
accounts.
type: string
example: open
enum:
- open
- company
- collaborators
password:
description: >-
The password required to access the shared link. Set the
password to `null` to remove it. Passwords must now be
at least eight characters long and include a number,
upper case letter, or a non-numeric or non-alphabetic
character. A password can only be set when `access` is
set to `open`.
type: string
example: do-not-use-this-password
nullable: true
vanity_name:
description: >-
Defines a custom vanity name to use in the shared link
URL, for example `https://app.box.com/v/my-shared-link`.
Custom URLs should not be used when sharing sensitive
content as vanity URLs are a lot easier to guess than
regular shared links.
type: string
example: my-shared-link
minLength: 12
unshared_at:
description: >-
The timestamp at which this shared link will expire.
This field can only be set by users with paid accounts.
The value must be greater than the current date and
time.
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
responses:
'200':
description: Returns the updated web link object.
content:
application/json:
schema:
$ref: '#/components/schemas/WebLink'
default:
description: An unexpected client error.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
x-codeSamples:
- lang: curl
label: Update web link
source: |-
curl -i -X PUT "https://api.box.com/2.0/web_links/12345" \
-H "authorization: Bearer " \
-H "content-type: application/json" \
-d '{
"name": "Cloud Content Management"
}'
- lang: dotnet
label: Update web link
source: >-
await client.WebLinks.UpdateWebLinkByIdAsync(webLinkId: weblink.Id,
requestBody: new UpdateWebLinkByIdRequestBody() { Name =
updatedName, SharedLink = new
UpdateWebLinkByIdRequestBodySharedLinkField() { Access =
UpdateWebLinkByIdRequestBodySharedLinkAccessField.Open, Password =
password } });
- lang: swift
label: Update web link
source: >-
try await client.webLinks.updateWebLinkById(webLinkId: weblink.id,
requestBody: UpdateWebLinkByIdRequestBody(name: updatedName,
sharedLink: UpdateWebLinkByIdRequestBodySharedLinkField(access:
UpdateWebLinkByIdRequestBodySharedLinkAccessField.open, password:
password)))
- lang: java
label: Update web link
source: >-
client.getWebLinks().updateWebLinkById(weblink.getId(), new
UpdateWebLinkByIdRequestBody.Builder().name(updatedName).sharedLink(new
UpdateWebLinkByIdRequestBodySharedLinkField.Builder().access(UpdateWebLinkByIdRequestBodySharedLinkAccessField.OPEN).password(password).build()).build())
- lang: node
label: Update web link
source: |-
await client.webLinks.updateWebLinkById(weblink.id, {
requestBody: {
name: updatedName,
sharedLink: {
access: 'open' as UpdateWebLinkByIdRequestBodySharedLinkAccessField,
password: password,
} satisfies UpdateWebLinkByIdRequestBodySharedLinkField,
} satisfies UpdateWebLinkByIdRequestBody,
} satisfies UpdateWebLinkByIdOptionalsInput);
- lang: python
label: Update web link
source: |-
client.web_links.update_web_link_by_id(
weblink.id,
name=updated_name,
shared_link=UpdateWebLinkByIdSharedLink(
access=UpdateWebLinkByIdSharedLinkAccessField.OPEN, password=password
),
)
components:
schemas:
WebLink:
description: >-
Web links are objects that point to URLs. These objects are also known
as bookmarks within the Box web application.
Web link objects are treated similarly to file objects, they will also
support most actions that apply to regular files.
type: object
allOf:
- $ref: '#/components/schemas/WebLink--Mini'
- properties:
parent:
allOf:
- $ref: '#/components/schemas/Folder--Mini'
- description: The parent object the web link belongs to.
description:
description: >-
The description accompanying the web link. This is visible
within the Box web application.
type: string
example: Example page
path_collection:
allOf:
- title: Path collection
description: A list of parent folders for an item.
type: object
required:
- total_count
- entries
properties:
total_count:
description: The number of folders in this list.
type: integer
format: int64
example: 1
nullable: false
entries:
description: The parent folders for this item.
type: array
items:
$ref: '#/components/schemas/Folder--Mini'
nullable: false
- description: >-
The tree of folders that this web link is contained in,
starting at the root.
- nullable: false
created_at:
description: When this file was created on Box’s servers.
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
modified_at:
description: When this file was last updated on the Box servers.
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
trashed_at:
description: When this file was moved to the trash.
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
nullable: true
purged_at:
description: When this file will be permanently deleted.
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
nullable: true
created_by:
allOf:
- $ref: '#/components/schemas/User--Mini'
- description: The user who created this web link.
modified_by:
allOf:
- $ref: '#/components/schemas/User--Mini'
- description: The user who last modified this web link.
owned_by:
allOf:
- $ref: '#/components/schemas/User--Mini'
- description: The user who owns this web link.
shared_link:
allOf:
- title: Shared link
description: >-
Shared links provide direct, read-only access to files or
folder on Box.
Shared links with open access level allow anyone with the
URL to access the item, while shared links with company or
collaborators access levels can only be accessed by
appropriately authenticated Box users.
type: object
required:
- url
- accessed
- effective_access
- effective_permission
- is_password_enabled
- download_count
- preview_count
properties:
url:
description: >-
The URL that can be used to access the item on Box.
This URL will display the item in Box's preview UI where
the file can be downloaded if allowed.
This URL will continue to work even when a custom
`vanity_url` has been set for this shared link.
type: string
format: url
example: https://www.box.com/s/vspke7y05sb214wjokpk
nullable: false
download_url:
description: >-
A URL that can be used to download the file. This URL
can be used in a browser to download the file. This URL
includes the file extension so that the file will be
saved with the right file type.
This property will be `null` for folders.
type: string
format: url
example: >-
https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg
nullable: true
x-box-premium-feature: true
vanity_url:
description: >-
The "Custom URL" that can also be used to preview the
item on Box. Custom URLs can only be created or modified
in the Box Web application.
type: string
format: url
example: https://acme.app.box.com/v/my_url/
nullable: true
vanity_name:
description: >-
The custom name of a shared link, as used in the
`vanity_url` field.
type: string
example: my_url
nullable: true
access:
description: >-
The access level for this shared link.
- `open` - provides access to this item to anyone with
this link
- `company` - only provides access to this item to
people the same company
- `collaborators` - only provides access to this item to
people who are collaborators on this item
If this field is omitted when creating the shared link,
the access level will be set to the default access level
specified by the enterprise admin.
type: string
example: open
enum:
- open
- company
- collaborators
nullable: false
effective_access:
description: >-
The effective access level for the shared link. This can
be a more restrictive access level than the value in the
`access` field when the enterprise settings restrict the
allowed access levels.
type: string
example: company
enum:
- open
- company
- collaborators
nullable: false
effective_permission:
description: >-
The effective permissions for this shared link. These
result in the more restrictive combination of the share
link permissions and the item permissions set by the
administrator, the owner, and any ancestor item such as
a folder.
type: string
example: can_download
enum:
- can_edit
- can_download
- can_preview
- no_access
nullable: false
unshared_at:
description: >-
The date and time when this link will be unshared. This
field can only be set by users with paid accounts.
type: string
format: date-time
example: '2018-04-13T13:53:23-07:00'
nullable: true
is_password_enabled:
description: >-
Defines if the shared link requires a password to access
the item.
type: boolean
example: true
nullable: false
permissions:
description: >-
Defines if this link allows a user to preview, edit, and
download an item. These permissions refer to the shared
link only and do not supersede permissions applied to
the item itself.
type: object
properties:
can_download:
description: >-
Defines if the shared link allows for the item to be
downloaded. For shared links on folders, this also
applies to any items in the folder.
This value can be set to `true` when the effective
access level is set to `open` or `company`, not
`collaborators`.
type: boolean
example: true
nullable: false
can_preview:
description: >-
Defines if the shared link allows for the item to be
previewed.
This value is always `true`. For shared links on
folders this also applies to any items in the
folder.
type: boolean
example: true
nullable: false
can_edit:
description: >-
Defines if the shared link allows for the item to be
edited.
This value can only be `true` if `can_download` is
also `true` and if the item has a type of `file`.
type: boolean
example: false
nullable: false
required:
- can_download
- can_preview
- can_edit
download_count:
description: The number of times this item has been downloaded.
type: integer
example: 3
nullable: false
preview_count:
description: The number of times this item has been previewed.
type: integer
example: 3
nullable: false
- description: >-
The shared link object for this item. Will be `null` if no
shared link has been created.
- nullable: true
item_status:
description: >-
Whether this item is deleted or not. Values include `active`,
`trashed` if the file has been moved to the trash, and `deleted`
if the file has been permanently deleted.
type: string
example: active
enum:
- active
- trashed
- deleted
title: Web link
x-box-resource-id: web_link
x-box-tag: web_links
x-box-variant: standard
ClientError:
description: A generic error.
type: object
properties:
type:
description: The value will always be `error`.
type: string
example: error
enum:
- error
nullable: false
status:
description: The HTTP status of the response.
type: integer
format: int32
example: 400
nullable: false
code:
description: A Box-specific error code.
type: string
example: item_name_invalid
enum:
- created
- accepted
- no_content
- redirect
- not_modified
- bad_request
- unauthorized
- forbidden
- not_found
- method_not_allowed
- conflict
- precondition_failed
- too_many_requests
- internal_server_error
- unavailable
- item_name_invalid
- insufficient_scope
message:
description: A short message describing the error.
type: string
example: Method Not Allowed
nullable: false
context_info:
description: >-
A free-form object that contains additional context about the error.
The possible fields are defined on a per-endpoint basis. `message`
is only one example.
type: object
example:
message: Something went wrong
additionalProperties: {}
nullable: true
help_url:
description: A URL that links to more information about why this error occurred.
type: string
example: >-
https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
nullable: false
request_id:
description: >-
A unique identifier for this response, which can be used when
contacting Box support.
type: string
example: abcdef123456
nullable: false
title: Client error
x-box-resource-id: client_error
WebLink--Mini:
description: >-
Web links are objects that point to URLs. These objects are also known
as bookmarks within the Box web application.
Web link objects are treated similarly to file objects, they will also
support most actions that apply to regular files.
type: object
allOf:
- $ref: '#/components/schemas/WebLink--Base'
- properties:
url:
description: The URL this web link points to.
type: string
example: https://www.example.com/example/1234
sequence_id:
allOf:
- type: string
example: '3'
nullable: true
description: >-
A numeric identifier that represents the most recent user
event that has been applied to this item.
This can be used in combination with the `GET
/events`-endpoint to filter out user events that would have
occurred before this identifier was read.
An example would be where a Box Drive-like application would
fetch an item via the API, and then listen to incoming user
events for changes to the item. The application would ignore
any user events where the `sequence_id` in the event is
smaller than or equal to the `sequence_id` in the originally
fetched resource.
- nullable: false
name:
description: The name of the web link.
type: string
example: My Bookmark
title: Web link (Mini)
x-box-resource-id: web_link--mini
x-box-tag: web_links
x-box-variant: mini
Folder--Mini:
description: >-
A mini representation of a file version, used when nested under another
resource.
type: object
allOf:
- $ref: '#/components/schemas/Folder--Base'
- properties:
sequence_id:
allOf:
- type: string
example: '3'
nullable: true
description: >-
A numeric identifier that represents the most recent user
event that has been applied to this item.
This can be used in combination with the `GET
/events`-endpoint to filter out user events that would have
occurred before this identifier was read.
An example would be where a Box Drive-like application would
fetch an item via the API, and then listen to incoming user
events for changes to the item. The application would ignore
any user events where the `sequence_id` in the event is
smaller than or equal to the `sequence_id` in the originally
fetched resource.
- nullable: false
name:
description: The name of the folder.
type: string
example: Contracts
nullable: false
title: Folder (Mini)
x-box-resource-id: folder--mini
x-box-tag: folders
x-box-variant: mini
User--Mini:
description: >-
A mini representation of a user, as can be returned when nested within
other resources.
type: object
allOf:
- $ref: '#/components/schemas/User--Base'
- properties:
name:
description: The display name of this user.
type: string
example: Aaron Levie
maxLength: 50
nullable: false
login:
description: The primary email address of this user.
type: string
format: email
example: ceo@example.com
nullable: false
title: User (Mini)
x-box-resource-id: user--mini
x-box-tag: users
x-box-variant: mini
WebLink--Base:
description: >-
Web links are objects that point to URLs. These objects are also known
as bookmarks within the Box web application.
Web link objects are treated similarly to file objects, they will also
support most actions that apply to regular files.
type: object
properties:
id:
description: The unique identifier for this web link.
type: string
example: '11446498'
type:
description: The value will always be `web_link`.
type: string
example: web_link
enum:
- web_link
etag:
description: The entity tag of this web link. Used with `If-Match` headers.
type: string
example: '1'
required:
- id
- type
title: Web link (Base)
x-box-resource-id: web_link--base
x-box-tag: web_links
x-box-variant: base
x-box-variants:
- base
- mini
- standard
Folder--Base:
description: >-
The bare basic representation of a folder, the minimal amount of fields
returned when using the `fields` query parameter.
type: object
properties:
id:
description: >-
The unique identifier that represent a folder.
The ID for any folder can be determined by visiting a folder in the
web application and copying the ID from the URL. For example, for
the URL `https://*.app.box.com/folders/123` the `folder_id` is
`123`.
type: string
example: '12345'
nullable: false
etag:
description: >-
The HTTP `etag` of this folder. This can be used within some API
endpoints in the `If-Match` and `If-None-Match` headers to only
perform changes on the folder if (no) changes have happened.
type: string
example: '1'
nullable: true
type:
description: The value will always be `folder`.
type: string
example: folder
enum:
- folder
nullable: false
required:
- id
- type
title: Folder (Base)
x-box-resource-id: folder--base
x-box-tag: folders
x-box-variant: base
x-box-variants:
- base
- mini
- standard
- full
User--Base:
description: >-
A mini representation of a user, used when nested within another
resource.
type: object
properties:
id:
description: The unique identifier for this user.
type: string
example: '11446498'
type:
description: The value will always be `user`.
type: string
example: user
enum:
- user
nullable: false
required:
- type
- id
title: User (Base)
x-box-resource-id: user--base
x-box-tag: users
x-box-variant: base
x-box-variants:
- base
- mini
- standard
- full
securitySchemes:
OAuth2Security:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://account.box.com/api/oauth2/authorize
tokenUrl: https://api.box.com/oauth2/token
scopes:
root_readonly: Read all files and folders stored in Box
root_readwrite: Read and write all files and folders stored in Box
manage_app_users: Provision and manage app users
manage_managed_users: Provision and manage managed users
manage_groups: Manage an enterprise's groups
manage_webhook: Create webhooks programmatically through the API
manage_enterprise_properties: Manage enterprise properties
manage_data_retention: Manage data retention polices
manage_legal_hold: Manage Legal Holds
````