View as Markdown
Domain Group icon

Domain Group ACTION

Create Residential Listing

Creates a new residential listing. See the documentation
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Domain Group account once, then configure and run Create Residential Listing from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "domain_group-create-residential-listing",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    domain_group: { authProvisionId: "apn_xxxxxxx" },
    agencyId: "Agency ID",
    providerAdId: "Provider Ad ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Residential Listing inputs
Property Type Description
agencyId Agency ID string
The identifier of an agency
Required Dynamic
providerAdId Provider Ad ID string
Must be unique. If Provider Ad ID supplied already exists, the listing will be updated. External Advertisement Id of up to 50 characters will be stored.<br /> This value is used to identify an Advertisement for updates and should be unique for listing provider.<br /> This value is case-insensitive (meaning AAAA will update aaaa).
Required
propertyType Property Type string
The type of property
Required
listingAction Listing Action string
The type of listing action
Required
underOfferOrContract Under Offer or Contract boolean
Set for Sale listings only
Optional
fromPrice From Price integer
Lowest price the property is expected to sell/rent for to set search price. For a fixed price, set this value the same as To Price
Required
toPrice To Price integer
Highest price the property is expected to sell/rent for to set search price. For a fixed price, set this value the same as From Price
Required
description Description string
Description of the property
Optional
features Features string
Comma-separated list of features
Optional
streetNumber Street Number string
Street number of the listing address
Required
unitNumber Unit Number string
Unit number of the listing address
Optional
street Street string
Street of the listing address
Required
state State string
State of the listing address
Required
suburb Suburb string
Suburb of the listing address
Required
postcode Postcode string
Post code of the listing address
Required
receiveEmailsToDefaultAddress Receive Emails to Default Address boolean
Send email enquiries to the default address for this listing type
Optional
isRural Is Rural? boolean
True if the property is rural
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
domain_group-create-residential-listing
Version
0.0.2
App
Domain Group
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes