Sample - Box Platform API
PUT/folders/{folder_id}/watermark

Apply a watermark to a folder

Updates the watermark applied to a folder, creating one when the folder does not already have one. Supply the required watermark.imprint value to specify the watermark type; the currently supported value is default. A 200 response indicates an existing watermark was updated, while a 201 response indicates a new watermark was created.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 1 body field
folder_idstringrequired
The unique identifier of the folder to apply or update the watermark on.

Watermark configuration for the folder.

watermarkobjectrequired
The watermark to imprint on the folder.

3 status codes
200Returns the updated watermark when the folder already has a watermark.
watermarkobjectoptional
201Returns the newly created watermark when the folder did not previously have one.
watermarkobjectoptional
defaultReturned for an unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

watermark and its imprint field are required, and imprint must be default. folder_id must identify the folder whose watermark you want to apply or update.