EditPackageCampaign

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/usps/json-schema/usps-edit-package-campaign-schema.json",
  "title": "EditPackageCampaign",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/usps-informed-delivery-package-campaigns-openapi.yml#/components/schemas/EditPackageCampaign",
  "type": "object",
  "properties": {
    "MID": {
      "type": "string",
      "description": "The Mailer ID associated with the campaign."
    },
    "mailOwnerCRID": {
      "type": "string",
      "description": "Customer Registration ID (CRID) of the Mail Owner associated with the Informed Delivery campaign."
    },
    "mailOwnerName": {
      "type": "string",
      "description": "Name of the Mail Owner associated with the Informed Delivery campaign."
    },
    "campaignCode": {
      "type": "string",
      "description": "User defined field that describes the campaign being created. This field is put into the campaign reports created for the campaign."
    },
    "campaignGroupingCode": {
      "type": "string",
      "description": "User defined field that describes the campaign being created. This field is put into the campaign reports created for the campaign."
    },
    "campaignTitle": {
      "type": "string",
      "description": "User defined field that describes the campaign being created. This field is put into the campaign reports created for the campaign."
    },
    "brandDisplayName": {
      "type": "string",
      "description": "User defined field that is placed on Informed Delivery's UIs when campaign is displayed."
    },
    "startDate": {
      "type": "string",
      "description": "First day campaign will be displayed",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "description": "Last day campaign will be displayed",
      "format": "date"
    },
    "targetUrl": {
      "type": "string",
      "description": "The URL that users are redirected to when clicking on the Ridealong image or Learn More link for a campaign. This field is required."
    },
    "rideAlong": {
      "type": "string",
      "description": "The image that is displayed for packages matched with a package campaign. When clicked, this image will take users to the Target URL of the campaign. This field is required."
    }
  }
}