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