Modify a share.
Try it now
Test
RAM authorization
Request syntax
POST /v2/share_link/update HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
No |
The request parameters. |
|
| share_id |
string |
Yes |
The share ID. |
7JQX1FswpQ8 |
| share_pwd |
string |
No |
The access code. The access code can be up to 64 characters in length. A value of 0 specifies an empty string. |
abcF123x |
| expiration |
string |
No |
The time when the share link expires. The time follows the RFC 3339 standard. Example: 2020-06-28T11:33:00.000+08:00. If you leave this parameter empty, the share link never expires. |
2020-06-28T11:33:00.000+08:00 |
| description |
string |
No |
The description of the share link. The description can be up to 1,024 characters in length. |
Complete Lecture Room collection |
| share_name |
string |
No |
The name of the share link. By default, the name of the first file is used. The name can be up to 128 characters in length. |
Lecture Room-1.mp4 |
| status |
string |
No |
The state of the share link. Valid values:
Valid values:
|
enabled |
| preview_count |
integer |
No |
The number of times that the shared files are previewed. The value must be greater than or equal to 0. |
3 |
| save_count |
integer |
No |
The number of times that the shared files are saved. The value must be greater than or equal to 0. |
5 |
| download_count |
integer |
No |
The number of times that the shared files are downloaded. The value must be greater than or equal to 0. |
30 |
| report_count |
integer |
No |
The number of times that the shared files are reported. The value must be greater than or equal to 0. |
1 |
| video_preview_count |
integer |
No |
The number of times that the videos are previewed in the shared files. The value must be greater than or equal to 0. |
100 |
| disable_preview |
boolean |
No |
Specifies whether to prohibit the previews of the shared files. |
false |
| disable_save |
boolean |
No |
Specifies whether to prohibit the saves of the shared files. |
false |
| disable_download |
boolean |
No |
Specifies whether to prohibit the downloads of the shared files. |
false |
| preview_limit |
integer |
No |
The maximum number of times that the shared files can be previewed. The value must be greater than or equal to 0. A value of 0 specifies that the number is unlimited. |
100 |
| save_limit |
integer |
No |
The maximum number of times that the shared files can be saved. The value must be greater than or equal to 0. A value of 0 specifies that the number is unlimited. |
100 |
| download_limit |
integer |
No |
The maximum number of times that the shared files can be downloaded. The value must be greater than or equal to 0. A value of 0 specifies that the number is unlimited. |
100 |
| office_editable |
boolean |
No |
Allow online editing of the shared document. |
true |
Response elements
|
Element |
Type |
Description |
Example |
| ShareLink |
The response parameters. |
Examples
Success response
JSON format
{
"share_id": "7JQX1FswpQ8",
"share_pwd": "abcF123x",
"drive_id": "1",
"file_id_list": [
"[\"xx\"]"
],
"expiration": "2020-06-28T11:33:00.000+08:00",
"expired": false,
"created_at": "2019-08-20T06:51:27.292Z",
"updated_at": "2019-08-20T06:51:27.292Z",
"description": "videos",
"share_name": "video-1.MP4",
"creator": "c9b7a5aa04d14ae3867fdc886fa01da4",
"status": "enabled",
"preview_count": 10,
"save_count": 2,
"download_count": 5,
"report_count": 0,
"video_preview_count": 1,
"access_count": 4,
"disable_preview": false,
"disable_save": false,
"disable_download": false,
"preview_limit": 100,
"save_limit": 100,
"download_limit": 100,
"require_login": false,
"share_all_files": true,
"share_msg": "pwd: 123",
"save_download_limit": 100,
"office_editable": true
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.