Skip to main content
POST
Send a listing

Authorizations

Authorization
string
header
required

The agency's secret key, sent as Authorization: Bearer <key>. One key per agency.

Body

application/json

One resale or letting listing, as your system holds it. Send the whole record each time: a field you leave out is cleared.

ref
string
required

Your own id. Stored and echoed back as sent, without surrounding spaces.

Required string length: 1 - 128
transaction_type
enum<string>
required

sale or letting: whether it's for sale or to let.

Available options:
sale,
letting
status
enum<string>
required

available: on the market. sale_agreed / let_agreed: agreed but not completed. sold / let: completed. withdrawn: taken off the market. Anything but available stops Signal starting new conversations about it. Sales use sale_agreed / sold; lettings use let_agreed / let.

Available options:
available,
sale_agreed,
sold,
let_agreed,
let,
withdrawn
address
string
required

The full address, as you'd show it to a buyer.

Required string length: 1 - 500
updated_at
string<date-time>
required

When it last changed in your system (if you don't track that, send the time of the call). An update older than the one we hold is ignored; the same time again is applied, so retries are safe.

postcode
string | null

The Eircode in Ireland, or the postcode. Treated as absent if it isn't 2 to 10 characters.

branch_code
string | null

Which of the agency's branches it belongs to. The codes are agreed with the agency when they join. An unknown code is a 422.

Required string length: 1 - 32
details
ListingDetails · object | null

What you know about the listing.

portal_ids
PortalIds · object | null

Lets Signal match a portal enquiry to your listing, so events carry your ref.

Response

Updated, or ignored because we already held a newer version (see applied).

What Signal did with a listing you sent.

ref
string
required

Your listing reference.

status
enum<string>
required

The listing's status as recorded.

Available options:
available,
sale_agreed,
sold,
let_agreed,
let,
withdrawn
applied
boolean
required

False when we already held a newer version (by updated_at), so this one was ignored.