Skip to content

Custom fields

Custom fields extend property records with your own structured data: auction dates, equity figures, lead scores, campaign metadata, anything your workflow needs to store per record. Definitions are account-wide; values live per record.

Field definitions

MethodPathPurpose
GET/api/internal/custom-fields/group/List field groups (folders for fields)
POST/api/internal/custom-fields/group/Create a group
PATCH/api/internal/custom-fields/group/{id}/Update a group
GET/api/internal/custom-fields/List field definitions
POST/api/internal/custom-fields/Create a field
GET / PATCH/api/internal/custom-fields/{id}/Read or update a field
GET / POST/api/internal/custom-fields/{field_id}/option/Options for select-type fields
GET / PATCH / DELETE/api/internal/custom-fields/{field_id}/option/{id}/Manage an option

Fields have a field_type (text, number, date, select and so on); select fields carry their allowed values as options. Group related fields so the record page stays readable - a Foreclosure group holding Auction Date, Opening Bid, Trustee, for example.

Per-record values

MethodPathPurpose
GET/api/internal/property/{property_uuid}/custom-field/Read a record's custom field values
PATCH/api/internal/property/{property_uuid}/custom-field/update-values/Write values on the record

The setup pattern

Build definitions once, idempotently, at integration setup:

import os, requests
BASE = "https://apiv2.reisift.io"
H = {"Authorization": f"Api-Key {os.environ['DATASIFT_API_KEY']}",
     "Content-Type": "application/json"}

WANTED = {"Auction Date": "date", "Opening Bid": "money", "Trustee": "text_input"}

def labels():
    r = requests.get(f"{BASE}/api/internal/custom-fields/", headers=H, params={"limit": 200}, timeout=30)
    r.raise_for_status()
    return {f["label"] for f in r.json()["results"]}

existing = labels()
for label, field_type in WANTED.items():
    if label not in existing:
        requests.post(f"{BASE}/api/internal/custom-fields/", headers=H, timeout=30,
                      json={"label": label, "field_type": field_type, "entity_type": "property"}
                      ).raise_for_status()

# Verify: re-list and confirm every wanted field now exists
assert set(WANTED) <= labels()

Required fields when creating a field: label, field_type (text, text_input, url, boolean, number, phone, money, date, select, multiselect) and entity_type (property). Optional: group_id, required, position, placeholder, and options for select types.

Practical rules

  • Cache definition ids. Field and option ids are stable; resolve titles to ids once at startup, not per record.
  • Custom fields power presets. Filter presets can filter on custom field values, which makes fields like Auction Date the backbone of time-driven funnels (for example, "auction inside 30 days" as a preset).
  • Write then read. After update-values, read the record's values back; a wrong field id fails quietly from your code's perspective if you skip verification.
  • Deleting fields and field groups is done in the DataSift app, because deleting a definition removes its value from every record.