ProductLinkSanitizer

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hint-health/main/json-schema/hint-health-product-link-sanitizer-schema.json",
  "title": "ProductLinkSanitizer",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/hint-health-partnerproductlink-api-openapi.yml#/components/schemas/ProductLinkSanitizer",
  "type": "object",
  "properties": {
    "link_type": {
      "type": "string",
      "description": "Kind of link. `product_cta` is reserved for the in-app install CTA and is managed via the main product endpoint — not partner-settable here.",
      "enum": [
        "url",
        "phone",
        "email"
      ]
    },
    "value": {
      "type": "string",
      "description": "Target of the link: a URL (for `url`), a phone number (for `phone`), or an email address (for `email`)."
    },
    "title": {
      "type": "string",
      "description": "Display label for the link in the marketplace."
    },
    "utm_campaign": {
      "type": "string",
      "description": "Optional UTM campaign appended to the URL when rendered in the marketplace. Defaults to `hint_marketplace` when omitted."
    },
    "utm_content": {
      "type": "string",
      "description": "Optional UTM content appended to the URL when rendered in the marketplace."
    },
    "position": {
      "type": "integer",
      "format": "int32",
      "description": "Display order. Optional — defaults to the next position via `acts_as_list`."
    }
  },
  "required": [
    "link_type",
    "value"
  ]
}