Box Developer Documentation
Log in
Latest version

Apply watermark to folder

put
https://api.box.com/2.0
/folders/:folder_id/watermark

Applies or update a watermark on a folder.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
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.

Request Body

objectin body

The watermark to imprint on the folder

stringin bodyrequired
"default"

The type of watermark to apply.

Currently only supports one option.

Value 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.

put
Apply watermark to folder
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
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"
       }
     }'
TypeScript Gen
await client.folderWatermarks.updateFolderWatermark(folder.id, {
  watermark: new UpdateFolderWatermarkRequestBodyWatermarkField({
    imprint: 'default' as UpdateFolderWatermarkRequestBodyWatermarkImprintField,
  }),
} satisfies UpdateFolderWatermarkRequestBody);
Python Gen
client.folder_watermarks.update_folder_watermark(
    folder.id,
    UpdateFolderWatermarkWatermark(
        imprint=UpdateFolderWatermarkWatermarkImprintField.DEFAULT
    ),
)
.NET Gen
await client.FolderWatermarks.UpdateFolderWatermarkAsync(folderId: folder.Id, requestBody: new UpdateFolderWatermarkRequestBody(watermark: new UpdateFolderWatermarkRequestBodyWatermarkField(imprint: UpdateFolderWatermarkRequestBodyWatermarkImprintField.Default)));
Java
BoxFolder folder = new BoxFolder(api, id);
fodler.applyWatermark();
Python
watermark = client.folder(folder_id='11111').apply_watermark()
print(f'Watermark created at {watermark.created_at} and modified at {watermark.modified_at}')
.NET
BoxWatermark watermark = await client.FoldersManager.ApplyWatermarkAsync("22222");
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' } }
		*/
	});

Response Example

{
  "watermark": {
    "created_at": "2012-12-12T10:53:43-08:00",
    "modified_at": "2012-12-12T10:53:43-08:00"
  }
}