SocialBoost.v1.RateForNewSocialBoostRequestModel

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/domain-group/main/json-schema/domain-group-social-boost-v1-rate-for-new-social-boost-request-model-schema.json",
  "title": "SocialBoost.v1.RateForNewSocialBoostRequestModel",
  "x-generated": "2026-10-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/domain-group-products-api-openapi.yml#/components/schemas/SocialBoost.v1.RateForNewSocialBoostRequestModel",
  "required": [
    "agencyId",
    "agentEmail",
    "agentFirstName",
    "agentLastName",
    "channel",
    "isRural",
    "listingType",
    "postcode",
    "price",
    "propertyType",
    "state",
    "suburb"
  ],
  "type": "object",
  "properties": {
    "agencyId": {
      "type": "integer",
      "description": "Id of the agency for whom rates are to be calculated.",
      "format": "int32"
    },
    "agentFirstName": {
      "minLength": 1,
      "type": "string",
      "description": "The first name of the primary agent associated with the listing."
    },
    "agentLastName": {
      "minLength": 1,
      "type": "string",
      "description": "The last name of the primary agent associated with the listing"
    },
    "agentEmail": {
      "minLength": 1,
      "type": "string",
      "description": "The email of the primary agent associated with the listing."
    },
    "suburb": {
      "minLength": 1,
      "type": "string",
      "description": "Suburb for which rates are to be calculated."
    },
    "postcode": {
      "minLength": 1,
      "type": "string",
      "description": "Postcode for which rates are to be calculated."
    },
    "state": {
      "minLength": 1,
      "type": "string",
      "description": "State for which rates are to be calculated"
    },
    "propertyType": {
      "enum": [
        "Unknown",
        "AcreageSemiRural",
        "ApartmentUnitFlat",
        "Aquaculture",
        "BlockOfUnits",
        "Carspace",
        "DairyFarming",
        "DevelopmentSite",
        "Duplex",
        "Farm",
        "FishingForestry",
        "NewHomeDesigns",
        "House",
        "NewHouseLand",
        "IrrigationServices",
        "NewLand",
        "Livestock",
        "NewApartments",
        "Penthouse",
        "Retirement",
        "RetirementVillage",
        "Rural",
        "SemiDetached",
        "SpecialistFarm",
        "Studio",
        "Terrace",
        "Townhouse",
        "VacantLand",
        "Villa",
        "Cropping",
        "Viticulture",
        "MixedFarming",
        "Grazing",
        "Horticulture",
        "Equine",
        "Farmlet",
        "Orchard",
        "RuralLifestyle"
      ],
      "type": "string",
      "description": "The property type of the listing e.g. House"
    },
    "isRural": {
      "type": "boolean",
      "description": "Whether to return the normal or rural rates"
    },
    "listingType": {
      "enum": [
        "Sale",
        "Rent",
        "None"
      ],
      "type": "string",
      "description": "Type of the listing whether sale or rent"
    },
    "price": {
      "type": "number",
      "description": "The value of the listing",
      "format": "double"
    },
    "channel": {
      "enum": [
        "Residential",
        "Commercial",
        "Business"
      ],
      "type": "string",
      "description": "The intended channel of the listing."
    },
    "bookingStartDate": {
      "type": [
        "string",
        "null"
      ],
      "description": "Date at which the booking will start. Defaults to today. Allows for returning future contracts/price changes.",
      "format": "date-time"
    }
  },
  "additionalProperties": false,
  "x-data-access-level-info": {
    "Basic": [
      "*"
    ],
    "Detailed": [
      "*"
    ],
    "Full": [
      "*"
    ]
  }
}