NewMarketingAppeal

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blackbaud/main/json-schema/blackbaud-new-marketing-appeal-schema.json",
  "title": "NewMarketingAppeal",
  "description": "CreateMarketingAppeal",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/blackbaud-altru-marketing-api-openapi.yml#/components/schemas/NewMarketingAppeal",
  "required": [
    "name",
    "description"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string",
      "description": "The name."
    },
    "description": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "The description."
    },
    "appeal_category": {
      "type": "string",
      "description": "The category. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/appealcategorycode/entries"
    },
    "business_unit": {
      "type": "string",
      "description": "The business unit. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/businessunitcode/entries"
    },
    "business_units": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewMarketingAppealBusinessUnits"
      },
      "description": "Business units."
    },
    "start_date": {
      "type": "string",
      "description": "The start date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "end_date": {
      "type": "string",
      "description": "The end date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "goal": {
      "type": "number",
      "description": "The goal.",
      "format": "double"
    },
    "appeal_report_1": {
      "type": "string",
      "description": "The report code. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/appealreport1code/entries"
    },
    "site_id": {
      "type": "string",
      "description": "The site."
    },
    "membership_program": {
      "type": "string",
      "description": "The membership. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/c5d11ce5-e9df-4aff-b45c-e5fb99ba6bb7?parameters=site_id,{site_id}."
    },
    "site_required": {
      "type": "boolean",
      "description": "Indicates whether site required. Read-only in the SOAP API."
    },
    "base_currency_id": {
      "type": "string",
      "description": "The base currency. Read-only in the SOAP API."
    }
  },
  "additionalProperties": false,
  "x-display-name": "Appeal Add Form",
  "x-display-id": "Appeal Add Form",
  "$defs": {
    "NewMarketingAppealBusinessUnits": {
      "required": [
        "business_unit",
        "percent_value"
      ],
      "type": "object",
      "properties": {
        "business_unit": {
          "type": "string",
          "description": "The business unit. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/businessunitcode/entries"
        },
        "percent_value": {
          "type": "number",
          "description": "% credit for revenue"
        }
      },
      "description": "NewMarketingAppealBusinessUnits",
      "x-display-name": "business_units",
      "x-display-id": "business_units"
    }
  }
}