Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!Applies or update a watermark on a folder.
12345
The 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
.
The watermark to imprint on the folder
"default"
The type of watermark to apply.
Currently only supports one option.
Value is always default
Returns an updated watermark if a watermark already existed on this folder.
Returns a new watermark if no watermark existed on this folder yet.
An unexpected client error.
curl -i -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"
}
}'
await client.folderWatermarks.updateFolderWatermark(folder.id, {
watermark: new UpdateFolderWatermarkRequestBodyWatermarkField({
imprint: 'default' as UpdateFolderWatermarkRequestBodyWatermarkImprintField,
}),
} satisfies UpdateFolderWatermarkRequestBody);
client.folder_watermarks.update_folder_watermark(
folder.id,
UpdateFolderWatermarkWatermark(
imprint=UpdateFolderWatermarkWatermarkImprintField.DEFAULT.value
),
)
await client.FolderWatermarks.UpdateFolderWatermarkAsync(folderId: folder.Id, requestBody: new UpdateFolderWatermarkRequestBody(watermark: new UpdateFolderWatermarkRequestBodyWatermarkField(imprint: UpdateFolderWatermarkRequestBodyWatermarkImprintField.Default)));
try await client.folderWatermarks.updateFolderWatermark(folderId: folder.id, requestBody: UpdateFolderWatermarkRequestBody(watermark: UpdateFolderWatermarkRequestBodyWatermarkField(imprint: UpdateFolderWatermarkRequestBodyWatermarkImprintField.default_)))
BoxFolder folder = new BoxFolder(api, id);
fodler.applyWatermark();
watermark = client.folder(folder_id='11111').apply_watermark()
print(f'Watermark created at {watermark.created_at} and modified at {watermark.modified_at}')
BoxWatermark watermark = await client.FoldersManager.ApplyWatermarkAsync("22222");
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' } }
*/
});
{
"watermark": {
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00"
}
}