Sample - Box Platform API
POST/web_links

Create a web link

Creates a web link object within a folder. Supply a URL beginning with http:// or https:// and the destination folder's parent.id; name defaults to the URL when omitted. You can also provide a display name and description for the web link.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

4 body fields

Web link details to create within a folder.

urlstringrequired
The URL that this web link links to. Must start with `"http://"` or `"https://"`.
parentobjectrequired
The parent folder to create the web link within.
namestringoptional
Name of the web link. Defaults to the URL if not set.
descriptionstringoptional
Description of the web link.

2 status codes
200Returns the newly created web link object.
idstringrequired
The unique identifier for this web link.
typestringrequired
The value will always be `web_link`.
Allowed:web_link
etagstringoptional
The entity tag of this web link. Used with `If-Match` headers.
urlstringoptional
The URL this web link points to.
sequence_idobjectoptional
namestringoptional
The name of the web link.
parentobjectoptional
descriptionstringoptional
The description accompanying the web link. This is visible within the Box web application.
path_collectionobjectoptional
created_atstringoptional
When this file was created on Box’s servers.
modified_atstringoptional
When this file was last updated on the Box servers.
trashed_atstringoptional
When this file was moved to the trash.
purged_atstringoptional
When this file will be permanently deleted.
created_byobjectoptional
modified_byobjectoptional
owned_byobjectoptional
shared_linkobjectoptional
item_statusstringoptional
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.
Allowed:activetrasheddeleted
collectionsarray<Collection>optional
The collections that this web link belongs to. For more information, see the [collections guide](https://developer.box.com/guides/collections).
allowed_shared_link_access_levelsarray<SharedLinkAccessLevel>optional
The shared link access levels the authenticated user is allowed to use when creating or updating a shared link for this web link. The list depends on item policy and user authorization, so it may be narrower than the levels available to the owner. An empty array means no access level is available to this user.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
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.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

url and parent are required, and parent.id must identify the destination folder. url must start with http:// or https://; name defaults to the URL when omitted.