PropertyRadar

Remove Properties from Portfolio

Removes properties from a portfolio by property id's and/or gnaf id's, returning any id's that did not exist within the portfolio

post/v1/propertyradar/portfolio/{PortfolioId}/property/delete

Request

Base URL
https://api.domain.com.au
Auth
- API key in header x-api-key
- or OAuth 2
  Authorization codehttps://auth.domain.com.au/v1/connect/authorize
  Client credentials
  Token URLhttps://auth.domain.com.au/v1/connect/token
  Scopesapi_propertyportfolio_write
TypeScript
https://skmtc.dev/domain/apis/domain-public-api/docs/v1/propertyradar/portfolio/:PortfolioId/property/delete/post.ts
A function with typed inputs. Its response is checked against the schema.

PortfolioIdstring required

{
  "PropertyIds": [
    "AB-2872-NY",
    "RF-8884-AK"
  ],
  "GnafIds": [
    "GAVIC419677979",
    "GANSW710292212"
  ]
}

Existing properties removed successfully, properties not in portfolio returned in response

MissingPropertyIdsstring[]

MissingGnafIdsstring[]

{
  "MissingPropertyIds": [
    "AA-0000-AA",
    "BB-000-BB"
  ],
  "MissingGnafIds": [
    "AAAA000000000",
    "BBBB000000000"
  ]
}