Create a customer property

POST/api/v1/customers/{customer_id}/properties

Needs an API key, and runs with the access of the member who made the key.
Send an Idempotency-Key. The same key with the same request within 24 hours gives the first answer again and changes nothing.
A connected AI assistant can use it too, as createCustomerProperty.

Parameters

In the address

customer_idstring (uuid)required

Headers

Idempotency-Keystringrequired
Unique user-scoped key for safely retrying this mutation for 24 hours.
At least 1 character. Up to 200 characters.

Request body

Sent as application/json.

propertyobjectrequired
Fields(12)
- lock_versioninteger
  At least 0.
- namestring or null
- address_line_1stringrequired
- address_line_2string or null
- citystringrequired
- regionstring or null
- postal_codestringrequired
- country_codestring
  Defaults to GB.
  Default: "GB". At least 2 characters. Up to 2 characters.
- access_notesstring or null
- lawn_area_m2string or null
  The lawn at the property in square metres, with up to two decimal places, or null when it has not been measured. Use it as the quantity of lawn work priced per square metre, such as turfing. A patio or decking is priced the same way and is some other size.
  Matches ^\d{1,8}(\.\d{1,2})?$.
- billing_namestring or null
  Who quotes and invoices for work here are addressed to, such as a letting agent. Defaults to the customer.
- billing_addressobject or null
  Where quotes and invoices for work here are sent, before the customer's billing address. Omit to keep, null to clear.
  Fields(6)
  address_line_1stringrequired
  address_line_2string or null
  citystringrequired
  regionstring or null
  postal_codestringrequired
  country_codestringrequired
  At least 2 characters. Up to 2 characters.

Responses

201Property details.

dataobjectrequired
Fields(20)
- lock_versioninteger
  At least 0.
- created_atstring (date-time)required
- updated_atstring (date-time)required
- idstring (uuid)required
- account_idstring (uuid)required
- customer_idstring (uuid)required
- namestring or null
- address_line_1stringrequired
- address_line_2string or null
- citystringrequired
- regionstring or null
- postal_codestringrequired
- country_codestringrequired
- access_notesstring or null
- lawn_area_m2string or null
  The lawn at the property in square metres, with up to two decimal places, or null when it has not been measured. Use it as the quantity of lawn work priced per square metre, such as turfing. A patio or decking is priced the same way and is some other size.
  Matches ^\d{1,8}(\.\d{1,2})?$.
- latitudenumber (double) or null
  Where the property is, to the middle of its postcode. Looked up shortly after the property is saved, and null until then. Stays null when the postcode is unknown, in Northern Ireland or outside the United Kingdom.
  At least -90. At most 90. Read only.
- longitudenumber (double) or null
  At least -180. At most 180. Read only.
- billing_namestring or null
- billing_addressobject or null
  Fields(6)
  address_line_1stringrequired
  address_line_2string or null
  citystringrequired
  regionstring or null
  postal_codestringrequired
  country_codestringrequired
  At least 2 characters. Up to 2 characters.
- archived_atstring (date-time) or null

A refusal answers in the one error shape every operation shares.

Example

A request our own tests send. The ids are made up: put your own in their place.

curl -X POST "https://app.tradesender.co.uk/api/v1/customers/372a8e62-6d44-552f-9c0e-c1229b6478be/properties" \
  -H "Authorization: Bearer $TRADESENDER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "property": {
    "name": "Home",
    "address_line_1": "10 Market Road",
    "city": "London",
    "postal_code": "N1 1AA",
    "country_code": "GB",
    "access_notes": "Call on arrival.",
    "lawn_area_m2": "240"
  }
}'