{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Custom fields","description":"Guides and API reference for the DataSift (REISift) Core API and SiftMap API."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"custom-fields","__idx":0},"children":["Custom fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"field-definitions","__idx":1},"children":["Field definitions"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/custom-fields/group/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List field groups (folders for fields)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/custom-fields/group/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PATCH"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/custom-fields/group/{id}/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update a group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/custom-fields/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List field definitions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/custom-fields/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a field"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET / PATCH"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/custom-fields/{id}/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read or update a field"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET / POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/custom-fields/{field_id}/option/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Options for select-type fields"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET / PATCH / DELETE"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/custom-fields/{field_id}/option/{id}/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Manage an option"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fields have a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["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 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Foreclosure"]}," group holding ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Auction Date"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Opening Bid"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Trustee"]},", for example."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"per-record-values","__idx":2},"children":["Per-record values"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/property/{property_uuid}/custom-field/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read a record's custom field values"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PATCH"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/property/{property_uuid}/custom-field/update-values/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Write values on the record"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"the-setup-pattern","__idx":3},"children":["The setup pattern"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Build definitions once, idempotently, at integration setup:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"import os, requests\nBASE = \"https://apiv2.reisift.io\"\nH = {\"Authorization\": f\"Api-Key {os.environ['DATASIFT_API_KEY']}\",\n     \"Content-Type\": \"application/json\"}\n\nWANTED = {\"Auction Date\": \"date\", \"Opening Bid\": \"money\", \"Trustee\": \"text_input\"}\n\ndef labels():\n    r = requests.get(f\"{BASE}/api/internal/custom-fields/\", headers=H, params={\"limit\": 200}, timeout=30)\n    r.raise_for_status()\n    return {f[\"label\"] for f in r.json()[\"results\"]}\n\nexisting = labels()\nfor label, field_type in WANTED.items():\n    if label not in existing:\n        requests.post(f\"{BASE}/api/internal/custom-fields/\", headers=H, timeout=30,\n                      json={\"label\": label, \"field_type\": field_type, \"entity_type\": \"property\"}\n                      ).raise_for_status()\n\n# Verify: re-list and confirm every wanted field now exists\nassert set(WANTED) <= labels()\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required fields when creating a field: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field_type"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text_input"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["url"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phone"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["money"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["date"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["select"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["multiselect"]},") and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity_type"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["property"]},"). Optional: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["group_id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["position"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["placeholder"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options"]}," for select types."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"practical-rules","__idx":4},"children":["Practical rules"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Cache definition ids."]}," Field and option ids are stable; resolve titles to ids once at startup, not per record."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom fields power presets."]}," Filter presets can filter on custom field values, which makes fields like ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Auction Date"]}," the backbone of time-driven funnels (for example, \"auction inside 30 days\" as a preset)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write then read."]}," After ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update-values"]},", read the record's values back; a wrong field id fails quietly from your code's perspective if you skip verification."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Deleting fields and field groups is done in the DataSift app, because deleting a definition removes its value from every record."]}]}]},"headings":[{"value":"Custom fields","id":"custom-fields","depth":1},{"value":"Field definitions","id":"field-definitions","depth":2},{"value":"Per-record values","id":"per-record-values","depth":2},{"value":"The setup pattern","id":"the-setup-pattern","depth":2},{"value":"Practical rules","id":"practical-rules","depth":2}],"frontmatter":{"seo":{"title":"Custom fields"}},"lastModified":"2026-11-01T21:43:02.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/custom-fields","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}