UpdateTeaserRequest

Request body for PATCH on the V1 teaser routes (PATCH /api/v1/projects/{id}/teaser, PATCH /api/v1/properties/{id}/teaser, PATCH /api/v1/projects/{id}/rooms/{roomId}/teaser). Each property is independently optional — present means "write this", absent means "no change".

  • options
    Type: object · UpdateTeaserOptionsRequest nullable

    Sparse partial update of the per-field display map. Each property is independently optional — present means "write this display", absent means "no change to this field's display".

    • avgContractLength
      Type: object · TeaserDisplayPatchRequest nullable
    • categories
      Type: object · TeaserDisplayPatchRequest nullable
    • conversions
      Type: object · TeaserDisplayPatchRequest nullable
    • country
      Type: object · TeaserDisplayPatchRequest nullable
    • investmentSize
      Type: object · TeaserDisplayPatchRequest nullable
    • leasableUnits
      Type: object · TeaserDisplayPatchRequest nullable
    • locality
      Type: object · TeaserDisplayPatchRequest nullable
    • locationClasses
      Type: object · TeaserDisplayPatchRequest nullable
    • noi
      Type: object · TeaserDisplayPatchRequest nullable
    • parcelArea
      Type: object · TeaserDisplayPatchRequest nullable
    • propertyCount
      Type: object · TeaserDisplayPatchRequest nullable
    • rentalIncome
      Type: object · TeaserDisplayPatchRequest nullable
    • rentedPercent
      Type: object · TeaserDisplayPatchRequest nullable
    • tenure
      Type: object · TeaserDisplayPatchRequest nullable
    • totalCosts
      Type: object · TeaserDisplayPatchRequest nullable
    • yearBuilt
      Type: object · TeaserDisplayPatchRequest nullable
    • yield
      Type: object · TeaserDisplayPatchRequest nullable
    • zoningCategory
      Type: object · TeaserDisplayPatchRequest nullable
    • zoningGfa
      Type: object · TeaserDisplayPatchRequest nullable
  • tags
    Type: array string[] | null

    Tag snapshot for the teaser. Three forms: omitted = no change; a list = write this exact snapshot (subset of template.tags); null = reset to the property's current template pool, snapshotted server-side at write time.