Apply watermark to folder
put
https://api.box.com/2.0
/folders/:folder_id/watermark
Applies or update a watermark on a folder.
Request
application/json
Path Parameters
stringin pathrequired
0The unique identifier that represent a folder.
The ID for any folder can be determined
by visiting this folder in the web application
and copying the ID from the URL. For example,
for the URL https://*.app.box.com/folder/123
the folder_id is 123.
The root folder of a Box account is
always represented by the ID 0.
Request Body
objectin body
The watermark to imprint on the folder
stringnulloptional
defaultValue is always default
Response
application/jsonWatermark
Returns an updated watermark if a watermark already existed on this folder.
application/jsonWatermark
Returns a new watermark if no watermark existed on this folder yet.
application/jsonClient error
An unexpected client error.
Request Example
cURL
curl -X PUT https://api.box.com/2.0/folders/4353455/watermark \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
-H 'Content-Type: application/json" '
-d '{
"watermark": {
"imprint": "default"
}
}'.NET
BoxWatermark watermark = await client.FoldersManager.ApplyWatermarkAsync("22222");Java
BoxFolder folder = new BoxFolder(api, id);
fodler.applyWatermark();Python
watermark = client.folder(folder_id='11111').apply_watermark()
print('Watermark created at {0} and modified at {1}'.format(watermark.created_at, watermark.modified_at))Node
client.folders.applyWatermark('22222')
.then(watermark => {
/* watermark -> {
watermark:
{ created_at: '2016-10-31T15:33:33-07:00',
modified_at: '2016-10-31T15:33:33-07:00' } }
*/
});