Remove shared link from file

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

file_id

string

required

The unique identifier that represents a file.

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

Query Parameters

fields

string

required

Explicitly request the shared_link fields to be returned for this item.

Body

application/json

shared_link

object

By setting this value to null, the shared link is removed from the file.

Example:

null

Response

Returns a basic representation of a file, with the shared link removed.

A full representation of a file, as can be returned from any file API endpoints by default. A standard representation of a file, as returned from any file API endpoints by default. A mini representation of a file, used when nested under another resource. The bare basic representation of a file, the minimal amount of fields returned when using the fields query parameter.

string

required

The unique identifier that represent a file.

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

Example:

"12345"

type

enum<string>

required

The value will always be file.

Available options:

file

Example:

"file"

etag

string | null

The HTTP etag of this file. This can be used within some API endpoints in the If-Match and If-None-Match headers to only perform changes on the file if (no) changes have happened.

Example:

"1"

sequence_id

string | null

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.

Example:

"3"

name

string

The name of the file.

Example:

"Contract.pdf"

sha1

string<digest>

The SHA1 hash of the file. This can be used to compare the contents of a file on Box with a local file.

Example:

"85136C79CBF9FE36BB9D05D0639C70C265C18D37"

file_version

File version (Mini) · object

The information about the current version of the file.

Show child attributes

description

string

The optional description of this file. If the description exceeds 255 characters, the first 255 characters are set as a file description and the rest of it is ignored.

Maximum string length: 255

Example:

"Contract for Q1 renewal"

size

integer

The file size in bytes. Be careful parsing this integer as it can get very large and cause an integer overflow.

Example:

629644

path_collection

Path collection · object

The tree of folders that this file is contained in, starting at the root.

Show child attributes

created_at

string<date-time>

The date and time when the file was created on Box.

Example:

"2012-12-12T10:53:43-08:00"

modified_at

string<date-time>

The date and time when the file was last updated on Box.

Example:

"2012-12-12T10:53:43-08:00"

trashed_at

string<date-time> | null

The time at which this file was put in the trash.

Example:

"2012-12-12T10:53:43-08:00"

purged_at

string<date-time> | null

The time at which this file is expected to be purged from the trash.

Example:

"2012-12-12T10:53:43-08:00"

content_created_at

string<date-time> | null

The date and time at which this file was originally created, which might be before it was uploaded to Box.

Example:

"2012-12-12T10:53:43-08:00"

content_modified_at

string<date-time> | null

The date and time at which this file was last updated, which might be before it was uploaded to Box.

Example:

"2012-12-12T10:53:43-08:00"

created_by

User (Mini) · object

The user who created this file.

Show child attributes

modified_by

User (Mini) · object

The user who last modified this file.

Show child attributes

owned_by

User (Mini) · object

The user who owns this file.

Show child attributes

shared_link

Shared link · object

The shared link for this file. This value will be null if no shared link has been created for this file.

Show child attributes

parent

Folder (Mini) · object

The folder that this file is located within. This value may be null for some folders such as the root folder or the trash folder.

Show child attributes

item_status

enum<string>

Defines if this item has been deleted or not.

active when the item has is not in the trash
trashed when the item has been moved to the trash but not deleted
deleted when the item has been permanently deleted.

Available options:

active,

trashed,

deleted

Example:

"active"

version_number

string

The version number of this file.

Example:

"1"

comment_count

integer

The number of comments on this file.

Example:

10

permissions

object

Describes the permissions that the current user has for this file.

Show child attributes

tags

string[]

The tags for this item. These tags are shown in the Box web app and mobile apps next to an item.

To add or remove a tag, retrieve the item's current tags, modify them, and then update this field.

There is a limit of 100 tags per item, and 10,000 unique tags per enterprise.

Required array length: 1 - 100 elements

Example:

["approved"]

lock

Lock · object

The lock held on this file. If there is no lock, this can either be null or have a timestamp in the past.

Show child attributes

extension

string

Indicates the (optional) file extension for this file. By default, this is set to an empty string.

Example:

"pdf"

is_package

boolean

Indicates if the file is a package. Packages are commonly used by Mac Applications and can include iWork files.

Example:

true

expiring_embed_link

Expiring embed link · object

Requesting this field creates an expiring Box Embed URL for an embedded preview session in an iframe.

This URL will expire after 60 seconds and the session will expire after 60 minutes.

Not all file types are supported for these embed URLs. Box Embed is not optimized for mobile browsers and should not be used in web experiences designed for mobile devices. Many UI elements, like the download and print options might not show in mobile browsers.

Show child attributes

watermark_info

object

Details about the watermark applied to this file.

Show child attributes

is_accessible_via_shared_link

boolean

Specifies if the file can be accessed via the direct shared link or a shared link to a parent folder.

Example:

true

allowed_invitee_roles

enum<string>[]

A list of the types of roles that user can be invited at when sharing this file.

Available options:

editor,

viewer,

previewer,

uploader,

previewer uploader,

viewer uploader,

co-owner

Example:

["editor"]

is_externally_owned

boolean

Specifies if this file is owned by a user outside of the authenticated enterprise.

Example:

true

has_collaborations

boolean

Specifies if this file has any other collaborators.

Example:

true

metadata

Item metadata instances · object

An object containing the metadata instances that have been attached to this file.

Each metadata instance is uniquely identified by its scope and templateKey. There can only be one instance of any metadata template attached to each file. Each metadata instance is nested within an object with the templateKey as the key, which again itself is nested in an object with the scope as the key.

Show child attributes

Example:

{
  "enterprise_27335": {
    "marketingCollateral": {
      "$canEdit": true,
      "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
      "$parent": "folder_59449484661",
      "$scope": "enterprise_27335",
      "$template": "marketingCollateral",
      "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
      "$typeVersion": 2,
      "$version": 1
    }
  }
}

expires_at

string<date-time> | null

When the file will automatically be deleted.

Example:

"2012-12-12T10:53:43-08:00"

representations

Representations · object

A list of representations for a file that can be used to display a placeholder of the file in your application. By default this returns all representations and we recommend using the x-rep-hints header to further customize the desired representations.

Show child attributes

classification

object

Details about the classification applied to this file.

Show child attributes

uploader_display_name

string

The display name of the user that uploaded the file. In most cases this is the name of the user logged in at the time of the upload.

If the file was uploaded using a File Request form that requires the user to provide an email address, this field is populated with that email address. If an email address was not required in the File Request form, this field is set to return a value of File Request.

In all other anonymous cases where no email was provided this field will default to a value of Someone.

Example:

"Ellis Wiggins"

disposition_at

string<date-time> | null

The retention expiration timestamp for the given file.

Example:

"2012-12-12T10:53:43-08:00"

shared_link_permission_options

enum<string>[] | null

A list of the types of roles that user can be invited at when sharing this file.

Available options:

can_preview,

can_download,

can_edit

Example:

["can_preview"]

is_associated_with_app_item

boolean

This field will return true if the file or any ancestor of the file is associated with at least one app item. Note that this will return true even if the context user does not have access to the app item(s) associated with the file.

Example:

true