DownloadRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zywave/main/json-schema/zywave-download-request-schema.json",
  "title": "DownloadRequest",
  "description": "The request that contains options for configuring the download of content",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/zywave-content-v2-openapi.json#/components/schemas/DownloadRequest",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "contentId": {
      "type": "integer",
      "description": "The unique Zywave identifier for the content.",
      "format": "int32"
    },
    "fileId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The unique Zywave identifier for the file under the content.",
      "format": "int32"
    },
    "convertToPDF": {
      "type": "boolean",
      "description": "The flag that will convert the file from its native format to a PDF, ignored for inapplicable filetypes"
    },
    "mergeFields": {
      "type": [
        "object",
        "null"
      ],
      "description": "The merge fields the download will attempt to find and replace in the body of the content, ignored for inapplicable filetypes",
      "additionalProperties": {
        "type": "string"
      }
    },
    "brandId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The brand for merge fields to apply to the content when downloading, ignored for inapplicable filetypes",
      "format": "int32"
    },
    "themeId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The theme to apply to the content when downloading, ignored for inapplicable filetypes",
      "format": "int32"
    },
    "skipApplyingTheme": {
      "type": "boolean",
      "description": "Whether to skip applying the theme for this download, ignored for inapplicable filetypes"
    },
    "origin": {
      "type": [
        "string",
        "null"
      ],
      "description": "The origin of the request, used for logging and analytics"
    }
  }
}