Box Watermarks (Files) API

openapi: 3.2.0
info:
  title: Box Platform Watermarks (Files) API
  description: Box Platform provides functionality to provide access to content stored within Box. It provides endpoints for basic manipulation of files and folders, management of users within an enterprise, as well as more complex topics such as legal holds and retention policies.
  termsOfService: https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9
  contact:
    name: Box, Inc
    url: https://developer.box.com
    email: devrel@box.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: '2024.0'
  x-box-commit-hash: 53bdced3cd
servers:
- url: https://api.box.com/2.0
  description: Box Platform API server.
security:
- OAuth2Security: []
tags:
- name: Watermarks (Files)
  description: A watermark is a semi-transparent overlay on an embedded file preview that displays a viewer's email address or user ID and the time of access over the file.
  x-box-tag: file_watermarks
paths:
  /files/{file_id}/watermark:
    get:
      operationId: get_files_id_watermark
      summary: Get watermark on file
      description: Retrieve the watermark for a file.
      parameters:
      - name: file_id
        in: path
        description: 'The unique identifier that represents 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`.'
        required: true
        schema:
          type: string
        example: '12345'
      responses:
        '200':
          description: Returns an object containing information about the watermark associated for to this file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Watermark'
        '404':
          description: Returns an error if the file does not have a watermark applied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: file_watermarks
      tags:
      - Watermarks (Files)
      x-codeSamples:
      - lang: curl
        label: Get watermark on file
        source: "curl -i -X GET \"https://api.box.com/2.0/files/12345/watermark\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: Get watermark on file
        source: 'await client.FileWatermarks.GetFileWatermarkAsync(fileId: file.Id);'
      - lang: swift
        label: Get watermark on file
        source: 'try await client.fileWatermarks.getFileWatermark(fileId: file.id)'
      - lang: java
        label: Get watermark on file
        source: client.getFileWatermarks().getFileWatermark(file.getId())
      - lang: node
        label: Get watermark on file
        source: await client.fileWatermarks.getFileWatermark(file.id);
      - lang: python
        label: Get watermark on file
        source: client.file_watermarks.get_file_watermark(file.id)
    put:
      operationId: put_files_id_watermark
      summary: Apply watermark to file
      description: Applies or update a watermark on a file.
      parameters:
      - name: file_id
        in: path
        description: 'The unique identifier that represents 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`.'
        required: true
        schema:
          type: string
        example: '12345'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                watermark:
                  description: The watermark to imprint on the file.
                  type: object
                  properties:
                    imprint:
                      description: 'The type of watermark to apply.


                        Currently only supports one option.'
                      type: string
                      example: default
                      enum:
                      - default
                  required:
                  - imprint
              required:
              - watermark
      responses:
        '200':
          description: Returns an updated watermark if a watermark already existed on this file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Watermark'
        '201':
          description: Returns a new watermark if no watermark existed on this file yet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Watermark'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: file_watermarks
      tags:
      - Watermarks (Files)
      x-codeSamples:
      - lang: curl
        label: Apply watermark to file
        source: "curl -i -X PUT \"https://api.box.com/2.0/files/12345/watermark\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -d '{\n       \"watermark\": {\n         \"imprint\": \"default\"\n       }\n     }'"
      - lang: dotnet
        label: Apply watermark to file
        source: 'await client.FileWatermarks.UpdateFileWatermarkAsync(fileId: file.Id, requestBody: new UpdateFileWatermarkRequestBody(watermark: new UpdateFileWatermarkRequestBodyWatermarkField(imprint: UpdateFileWatermarkRequestBodyWatermarkImprintField.Default)));'
      - lang: swift
        label: Apply watermark to file
        source: 'try await client.fileWatermarks.updateFileWatermark(fileId: file.id, requestBody: UpdateFileWatermarkRequestBody(watermark: UpdateFileWatermarkRequestBodyWatermarkField(imprint: UpdateFileWatermarkRequestBodyWatermarkImprintField.default_)))'
      - lang: java
        label: Apply watermark to file
        source: client.getFileWatermarks().updateFileWatermark(file.getId(), new UpdateFileWatermarkRequestBody(new UpdateFileWatermarkRequestBodyWatermarkField.Builder().imprint(UpdateFileWatermarkRequestBodyWatermarkImprintField.DEFAULT).build()))
      - lang: node
        label: Apply watermark to file
        source: "await client.fileWatermarks.updateFileWatermark(file.id, {\n  watermark: new UpdateFileWatermarkRequestBodyWatermarkField({\n    imprint: 'default' as UpdateFileWatermarkRequestBodyWatermarkImprintField,\n  }),\n} satisfies UpdateFileWatermarkRequestBody);"
      - lang: python
        label: Apply watermark to file
        source: "client.file_watermarks.update_file_watermark(\n    file.id,\n    UpdateFileWatermarkWatermark(\n        imprint=UpdateFileWatermarkWatermarkImprintField.DEFAULT\n    ),\n)"
    delete:
      operationId: delete_files_id_watermark
      summary: Remove watermark from file
      description: Removes the watermark from a file.
      parameters:
      - name: file_id
        in: path
        description: 'The unique identifier that represents 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`.'
        required: true
        schema:
          type: string
        example: '12345'
      responses:
        '204':
          description: Removes the watermark and returns an empty response.
        '404':
          description: Returns an error if the file did not have a watermark applied to it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: file_watermarks
      tags:
      - Watermarks (Files)
      x-codeSamples:
      - lang: curl
        label: Remove watermark from file
        source: "curl -i -X DELETE \"https://api.box.com/2.0/files/12345/watermark\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: Remove watermark from file
        source: 'await client.FileWatermarks.DeleteFileWatermarkAsync(fileId: file.Id);'
      - lang: swift
        label: Remove watermark from file
        source: 'try await client.fileWatermarks.deleteFileWatermark(fileId: file.id)'
      - lang: java
        label: Remove watermark from file
        source: client.getFileWatermarks().deleteFileWatermark(file.getId())
      - lang: node
        label: Remove watermark from file
        source: await client.fileWatermarks.deleteFileWatermark(file.id);
      - lang: python
        label: Remove watermark from file
        source: client.file_watermarks.delete_file_watermark(file.id)
components:
  schemas:
    Watermark:
      description: A watermark is a semi-transparent overlay on an embedded file preview that displays a viewer's email address or user ID and the time of access over a file's content.
      type: object
      properties:
        watermark:
          type: object
          properties:
            created_at:
              description: When this watermark was created.
              type: string
              format: date-time
              example: '2012-12-12T10:53:43-08:00'
            modified_at:
              description: When this task was modified.
              type: string
              format: date-time
              example: '2012-12-12T10:53:43-08:00'
      title: Watermark
      x-box-resource-id: watermark
      x-box-tag: file_watermarks
    ClientError:
      description: A generic error.
      type: object
      properties:
        type:
          description: The value will always be `error`.
          type: string
          example: error
          enum:
          - error
        status:
          description: The HTTP status of the response.
          type: integer
          format: int32
          example: 400
        code:
          description: A Box-specific error code.
          type: string
          example: item_name_invalid
          enum:
          - created
          - accepted
          - no_content
          - redirect
          - not_modified
          - bad_request
          - unauthorized
          - forbidden
          - not_found
          - method_not_allowed
          - conflict
          - precondition_failed
          - unprocessable_entity
          - too_many_requests
          - internal_server_error
          - unavailable
          - item_name_invalid
          - insufficient_scope
        message:
          description: A short message describing the error.
          type: string
          example: Method Not Allowed
        context_info:
          description: 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.
          type:
          - object
          - 'null'
          example:
            message: Something went wrong
          additionalProperties: {}
        help_url:
          description: A URL that links to more information about why this error occurred.
          type: string
          example: https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
        request_id:
          description: A unique identifier for this response, which can be used when contacting Box support.
          type: string
          example: abcdef123456
      title: Client error
      x-box-resource-id: client_error
  securitySchemes:
    OAuth2Security:
      type: oauth2
      description: The access token received from the authorization server in the OAuth 2.0 flow.
      flows:
        authorizationCode:
          authorizationUrl: https://account.box.com/api/oauth2/authorize
          tokenUrl: https://api.box.com/oauth2/token
          scopes:
            root_readonly: Read all files and folders stored in Box
            root_readwrite: Read and write all files and folders stored in Box
            manage_app_users: Provision and manage app users
            manage_managed_users: Provision and manage managed users
            manage_groups: Manage an enterprise's groups
            manage_webhook: Create webhooks programmatically through the API
            manage_enterprise_properties: Manage enterprise properties
            manage_data_retention: Manage data retention polices
            manage_legal_hold: Manage Legal Holds
externalDocs:
  description: Box Developer Documentation.
  url: https://developer.box.com
x-mint:
  mcp:
    enabled: true
x-provenance:
  method: harvested
  publisher: Box
  source: https://developer.box.com/box-openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)