---
title: "Get updated pricing information for a hypothetical listing"
method: POST
path: "/v1/products/ratefornewsocialboost"
tags: ["Products"]
---

# Get updated pricing information for a hypothetical listing

`POST /v1/products/ratefornewsocialboost`

## Request

- Base URL: `https://api.domain.com.au`
- URL: `https://api.domain.com.au/v1/products/ratefornewsocialboost`
- Auth: one of:
  - API key in header `x-api-key`
  - OAuth 2
    - Authorization code: `https://auth.domain.com.au/v1/connect/authorize`
    - Client credentials
    - Token URL: `https://auth.domain.com.au/v1/connect/token` scopes: `api_agencies_read`
- TypeScript: <https://skmtc.dev/domain/apis/domain-public-api/docs/v1/products/ratefornewsocialboost/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- SocialBoostV1RateForNewSocialBoostRequestModel
  - `agencyId` integer, required: Id of the agency for whom rates are to be calculated.
  - `agentFirstName` string, required: The first name of the primary agent associated with the listing.
  - `agentLastName` string, required: The last name of the primary agent associated with the listing
  - `agentEmail` string, required: The email of the primary agent associated with the listing.
  - `suburb` string, required: Suburb for which rates are to be calculated.
  - `postcode` string, required: Postcode for which rates are to be calculated.
  - `state` string, required: State for which rates are to be calculated
  - `propertyType` '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', required: The property type of the listing e.g. House
  - `isRural` boolean, required: Whether to return the normal or rural rates
  - `listingType` 'Sale' | 'Rent' | 'None', required: Type of the listing whether sale or rent
  - `price` number, double, required: The value of the listing
  - `channel` 'Residential' | 'Commercial' | 'Business', required: The intended channel of the listing.
  - `bookingStartDate` string, date-time, nullable: Date at which the booking will start. Defaults to today. Allows for returning future contracts/price changes.

## Response `200`

Pricing information for the given listing details

- SocialBoostV1RateForNewSocialBoost: GetRatesForNewSocialBoostResponse
  - `reason` 'BasedOnContract' | 'NoContractFound' | 'NoRateFound' | 'PropertyTypeExcluded', nullable: Gets or Sets Reason
  - `contract` SocialBoostV1ContractInfo: ContractInfo
    - `id` integer, nullable: Gets or Sets Id
    - `bookingProductId` integer, nullable: Gets or Sets BookingProductId
    - `agencyId` integer, nullable: Gets or Sets AgencyId
    - `startDate` string, date-time, nullable: Gets or Sets StartDate
    - `endDate` string, date-time, nullable: Gets or Sets EndDate
    - `finishedDate` string, date-time, nullable: Gets or Sets FinishedDate
    - `attributes` string, nullable: Gets or Sets Attributes
    - `agentId` string, nullable: Gets or Sets AgentId
    - `isAgentContract` boolean, nullable: Gets or Sets IsAgentContract
  - `rate` SocialBoostV1ListingRateInfo: ListingRateInfo
    - `productListingLevel` 'None' | 'PlatinumExtend' | 'Platinum' | 'Gold' | 'Silver' | 'Branded' | 'Tier1' | 'Tier2' | 'Tier3', nullable: Gets or Sets ProductListingLevel
    - `productListingRule` 'None' | 'EarlyAccess' | 'SocialBoostAll' | 'SocialBoostCasual' | 'SocialBoostRuralAll' | 'SocialBoostRuralCasual' | 'SocialBoostAgent' | 'SocialBoostRuralAgent', nullable: Gets or Sets ProductListingRule
    - `bookingProductId` integer, nullable: Gets or Sets BookingProductId
    - `bookingProductRateId` integer, nullable: Gets or Sets BookingProductRateId
    - `bookingProductName` string, nullable: Gets or Sets BookingProductName
    - `durationInDays` integer, nullable: Gets or Sets DurationInDays
    - `costExGst` number, double, nullable: Gets or Sets CostExGst
    - `costIncGst` number, double, nullable: Gets or Sets CostIncGst
    - `zoneId` integer, nullable: Gets or Sets ZoneId
    - `productAttributes` string, nullable: Gets or Sets ProductAttributes
    - `rateAttributes` string, nullable: Gets or Sets RateAttributes
    - `bookingMethod` string, nullable: Gets or Sets BookingMethod
    - `productForRural` boolean, nullable: Gets or Sets ProductForRural

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/domain/apis/domain-public-api.md) - [All operations](https://skmtc.dev/domain/apis/domain-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/domain/apis/domain-public-api/revisions/133015c6842c?raw)