Skip to main content
POST
Send a development

Authorizations

Authorization
string
header
required

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

Body

application/json

A new-homes development and its house types. 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
name
string
required

The development's marketing name.

Required string length: 1 - 200
address
string
required

Where it is, as you'd show it to a buyer.

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

pre_launch: not yet selling. on_sale: selling. final_phase: last units. sold_out: nothing left. completing: sales closing out.

Available options:
pre_launch,
on_sale,
final_phase,
sold_out,
completing
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.

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
house_types
HouseType · object[]

The full list each time. A house type you leave out is removed. Types are matched by name, so renaming one is a removal plus an addition.

Maximum array length: 100
portal_ids
PortalIds · object | null

The development's ids on the portals.

Response

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

What Signal did with a development you sent.

ref
string
required

Your development reference.

applied
boolean
required

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