Skip to main content
POST
Send a unit

Authorizations

Authorization
string
header
required

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

Body

application/json

One plot or unit in a development. Send the whole record each time: a field you leave out is cleared.

development_ref
string
required

Send the development first. An unknown one is a 422.

Required string length: 1 - 128
ref
string
required

Your id for the unit. How later calls find it.

Required string length: 1 - 128
plot_number
string
required

What buyers see, e.g. 7 for Plot 7. Unique within the development: a clash is a 422.

Required string length: 1 - 32
status
enum<string>
required

available: Signal's new-homes conversation can offer it. unreleased: not yet for sale. reserved / exchanged / completed: taken, so it's never offered. To take a unit off sale, send unreleased.

Available options:
available,
unreleased,
reserved,
exchanged,
completed
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.

house_type
string | null

A house type's name.

Required string length: 1 - 100
bedrooms
integer | null

Number of bedrooms.

Required range: 0 <= x <= 50
bathrooms
integer | null

Number of bathrooms.

Required range: 0 <= x <= 50
floor_area_sqm
number | null

Floor area in square metres.

Required range: 0 < x <= 100000
price
Money · object | null

The asking price.

features
string[]

Short feature phrases, e.g. Solar panels. Each is cut at 200 characters.

image_url
string | null

Treated as absent, not refused, if we can't read it as a web address. Use https: an http image may not display.

portal_ids
PortalIds · object | null

The unit's ids on the portals.

Response

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

What Signal did with a unit you sent.

development_ref
string
required

Your development reference.

ref
string
required

Your unit reference.

status
enum<string>
required

The unit's status as recorded.

Available options:
available,
unreleased,
reserved,
exchanged,
completed
applied
boolean
required

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