Download OpenAPI specification:Download
API endpoints for managing document share, bookmarks, and folders.
Get the folders of bookmark links with roles for the group
| groupId required | integer The group ID (Must be a positive unsigned integer) |
| site required | string The site is either in the 'staging' or 'production' environment |
[- {
- "id": 0,
- "directoryName": "string",
- "entries": [
- {
- "id": 0,
- "bookmarklink": "string",
- "roles": [
- 0
], - "title": "Example Bookmark Title",
- "modified": "2024-07-19T12:06:58.303"
}
]
}
]Create bookmark links with roles for the group
| groupId required | integer The group ID (Must be a positive unsigned integer) |
| site required | string The site is either in the 'staging' or 'production' environment |
| bookmarklink required | string The URL must be an absolute URL and must use a secure HTTPS connection |
| roles | Array of integers Role Ids to attach the bookmark to. |
| directoryId | integer A Bookmark directory to attach the bookmark to. |
| title | string A title for the bookmark. |
[- {
- "roles": [
- 100,
- 111,
- 112
], - "directoryId": 0,
- "title": "New Bookmark Title"
}
][- 0
]Update bookmark links (roles and folder based) for the group
| groupId required | integer The group ID (Must be a positive unsigned integer) |
| site required | string The site is either in the 'staging' or 'production' environment |
| id required | integer |
| bookmarklink | string The URL must be an absolute URL and must use a secure HTTPS connection |
| title | string A title for the bookmark. |
| roles | Array of integers |
| directoryId | integer |
[- {
- "id": 101,
- "title": "Updated Bookmark Title",
- "roles": [
- 515,
- 524,
- 652
], - "directoryId": 201
}
]{- "status": "ok"
}Delete Web Screenshare bookmark links in a group
| groupId required | integer The group ID (Must be a positive unsigned integer) |
| site required | string The site is either in the 'staging' or 'production' environment |
Array of BookmarkLink IDs
[- 100,
- 200,
- 300
]{- "status": "ok"
}Create folders for supported sections. Not all sections support folders.
Currently the sections that support folders include {"bookmarklinks", "docsharelinks"}
| groupId required | integer The group ID (Must be a positive unsigned integer) |
| site required | string The site is either in the 'staging' or 'production' environment |
| section required | string One of {"bookmarklinks", "docsharelinks"} |
| directoryName | string |
[- {
- "directoryName": "FOLDER 1"
}, - {
- "directoryName": "FOLDER 2"
}, - {
- "directoryName": "FOLDER 3"
}
][- 1,
- 2,
- 3
]Update folders for supported sections. Not all sections support folders.
Currently the sections that support folders include {"bookmarklinks", "docsharelinks"}
| groupId required | integer The group ID (Must be a positive unsigned integer) |
| site required | string The site is either in the 'staging' or 'production' environment |
| section required | string The setting section such as "bookmarklinks" |
| directoryId | integer |
| directoryName | string |
[- {
- "directoryId": 123,
- "directoryName": "Example Folder"
}
]{- "status": "ok"
}Delete folders for supported sections. Not all sections support folders.
Currently the sections that support folders include {"bookmarklinks", "docsharelinks"}
This action will also delete all entries within the folder.
| groupId required | integer The group ID (Must be a positive unsigned integer) |
| site required | string The site is either in the 'staging' or 'production' environment |
| section required | string One of {"bookmarklinks", "docsharelinks"} |
Array of Directory IDs
[- 100,
- 200,
- 300
]{- "status": "ok"
}Publish a given section of settings for the groupId provided. A publish operation clears the group's current production Settings, and then copies the group's current staging settings into the Production environment.
| groupId required | integer The group ID (Must be a positive unsigned integer) |
| section required | string The setting section to publish to production, choose from "allowedsites", "bookmarklinks", "docsharelinks", "maskingelements", "maskingpages" |
{- "status": "ok"
}