Download the watermarked content.

Returns download URL of watermarked content or download with the returned URL directly.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Redirect user to download the watermarked content with returned download URL if it's true. Default is true. Set to false to receive a 200 response whose body contains the download URL instead of a 302 redirect.

Body Params

The content item to watermark and the watermark to apply. For example, to stamp a centered confidentiality notice on a Library file, send content with repository library, type file, teamsiteId, id, and versionId, and send watermarkConfiguration with position center and textContent set to the notice text.

content
required

The content item to watermark and download, described with the common content model; set repository to library, workspace, or generatedlivedocs to indicate which content shape is supplied.

watermarkConfiguration
required

The watermark to apply to the content, either a text watermark using textContent or an image watermark using imageContent, placed at the chosen position.

Responses

400

Bad Request - the request body is missing required fields or contains values that do not match the schema, such as an unknown repository or position.

401

Unauthorized - the bearer token is missing, expired, or invalid.

403

Forbidden - the token lacks the required scopes or the caller does not have permission to view the content item or the watermark image.

422

Unprocessable entity - the request is well formed but the watermark cannot be applied, for example because the content or image format is not supported.

429

Too many requests - the client exceeded its rate limit; wait before retrying the request.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*