Edit Public Link
/documents/api/1.1/publiclinks/{linkId}
Edit the available public link parameters.
Request
- application/json
- application/xml
- linkId
-
Type:
string
Required:true
Globally unique identifier (GUID) for the public link.
- assignedUsers
-
Type:
string
The group of users who can use the link.
- Comma-separated list of users (any of user ID, login name, or email address).
- @serviceinstance: Users with an account can access the resource with the privileges specified by the role.
- @everybody: Any user can access the resource with the privileges specified by the role
- expirationTime
-
Type:
string
Date and time when the public link expires, in the form
yyyy-mm-ddThh:mm:ss
.For example, 2017-01-01T00:00:01.
If you do not specify an expiration time, the link is valid until you delete the link. - password
-
Type:
string
Password for the public link. Use a minimum of 8 characters and a maximum of 50 characters. If you do not specify a password, no password is required to use the link. - role
-
Type:
string
Allowed Values:[ "viewer", "downloader", "contributor" ]
Access level for the shared item.
Note:
Although the default role is viewer, the API user's preference setting for the default role for public links can override this default with a different value. It is best practice to explicitly set the role with the service call.
You can grant the specified user any standard role except manager or owner:
- Viewer: Viewers can look at files and folders, but can't change things.
- Downloader: Downloaders can also download files and save them to their own computer.
- Contributor: Contributors can also modify files, update files, upload new files, and delete files.
Example application/json
{
"assignedUsers":"@everybody",
"expirationTime":"2016-02-15T01:02:03",
"password":"password2",
"role":"viewer"
}
Response
- application/json
- application/xml
The request was fulfilled.
object
- errorCode
-
Type:
string
An error code of zero (0) indicates no errors.
-
Type:
object
PublicLinkDefinitionAdditional Properties Allowed:Public link information.
- assignedUsers
-
Type:
string
The group of users who can use the link. - createdTime
-
Type:
string
Date and time when the public link was created. - expirationTime
-
Type:
string
Date and time when the public link expires. - lastModifiedTime
-
Type:
string
Date and time when the public link was last modified. - linkID
-
Type:
string
Globally unique identifier (GUID) for the public link. - linkName
-
Type:
string
Name of the public link. - ownedBy
-
Type:
object
UserAdditional Properties Allowed:User information - password
-
Type:
string
Password for the public link. Use a minimum of 8 characters and a maximum of 50 characters. Passwords are case-sensitive. - role
-
Type:
string
Allowed Values:[ "viewer", "downloader", "contributor" ]
Access level for the shared item. - type
-
Type:
string
Item typepubliclink
.
- displayName
-
Type:
string
The display name for the user. - id
-
Type:
string
Globally unique identifier (GUID) for the user. - type
-
Type:
string
Item typeuser
.
Example application/json
{
"linkID":"LFCE8A35C88A6A96FD39B621T0000000000100000001",
"linkName":"pub-test-158",
"assignedUsers":"@everybody",
"role":"viewer",
"type":"publiclink",
"createdTime":"2015-06-05T21:04:56Z",
"expirationTime":"2016-02-15T01:02:03Z",
"lastModifiedTime":"2015-06-10T22:01:08Z",
"ownedBy":{
"id":"U0EAA20910FAF3052ACB79E4T00000000001",
"displayName":"User AA",
"type":"user"
},
"errorCode":"0"
}
Request parameters are not formatted correctly.
Forbidden if the user does not have read permission.
Link ID is not found.
Examples
Request Header
The following example assigns values for all of the available parameters of the specified public link.
PUT .../publiclinks/LFCE8A35C88A6A96FD39B621T0000000000100000001
None.
Request Body
{ "assignedUsers": "@everybody", "expirationTime": "2016-02-15T01:02:03", "password": "password2", "role": "viewer" }
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{ "assignedUsers": "@everybody", "createdTime": "2015-06-05T21:04:56Z", "errorCode": "0", "expirationTime": "2016-02-15T01:02:03Z", "lastModifiedTime": "2015-06-10T22:01:08Z", "linkID": "LFCE8A35C88A6A96FD39B621T0000000000100000001", "linkName": "pub-test-158", "ownedBy": { "displayName": "User AA", "id": "U0EAA20910FAF3052ACB79E4T00000000001", "type": "user" }, "role": "viewer", "type": "publiclink" }