Do not miss any RealScout API changes, ever again

Subscribe to the RealScout API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
18 structure changes including:
18 Modifications
Modified 18 Breaking
GET /activity
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from string | null to string
            Breaking
        • contact property Modified
      • next_cursor property Modified
        • Type went from string to string | null
GET /contacts
  • Query
  • include query parameter Modified
    • Type went from array to array[string]
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • updated_at property Added
GET /contacts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • commutes property Modified
        • nodes property Modified
          • Type went from array[object] | null to array[object | null] | null
      • notes property Modified
        • nodes property Modified
          • Type went from array[object] | null to array[object | null] | null
      • buying_timeline property Modified
        • updated_at property Modified
          • Type went from string(date-time) | null to string(date-time)
            Breaking
      • updated_at, selling_timeline properties Added
GET /conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from string | null to string
            Breaking
      • next_cursor property Modified
        • Type went from string to string | null
GET /home-value-alerts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • contact property Modified
GET /home-value-alerts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contact property Modified
        • realscout_url property Modified
          • Type went from string(uri) | null to string(uri)
            Breaking
GET /listing-alerts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • contact, email_settings properties Modified
GET /listing-alerts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contact property Modified
        • realscout_url property Modified
          • Type went from string(uri) | null to string(uri)
            Breaking
GET /market-alerts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • contact property Modified
GET /market-alerts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contact property Modified
        • realscout_url property Modified
          • Type went from string(uri) | null to string(uri)
            Breaking
PATCH /contacts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contact property Modified
        • updated_at property Added
POST /contacts
  • Response
  • 201 response Modified
    • application/json content type Modified
      • contact property Modified
        • updated_at property Added
POST /contacts/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contacts property Modified
        • updated_at property Added
POST /contacts/auto-nurture/disable
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contacts property Modified
        • updated_at property Added
POST /contacts/auto-nurture/enable
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contacts property Modified
        • updated_at property Added
POST /contacts/tags/add
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contacts property Modified
        • updated_at property Added
POST /contacts/tags/remove
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contacts property Modified
        • updated_at property Added
POST /contacts/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contacts property Modified
        • updated_at property Added
4 structure changes including:
4 Additions
Added 4
GET /listing-alert-templates
GET /tags
POST /contacts/tags/add
POST /contacts/tags/remove
2 structure changes including:
2 Additions
Added 2
GET /listing-links
GET /search-links
2 structure changes including:
2 Additions
Added 2
GET /conversations
GET /conversations/{id}/messages
2 structure changes including:
2 Additions
Added 2
GET /listing-alerts
GET /listing-alerts/{id}
4 structure changes including:
4 Additions
Added 4
GET /home-value-alerts
GET /home-value-alerts/{id}
GET /market-alerts
GET /market-alerts/{id}
10 structure changes including:
10 Modifications
Modified 10 Breaking
GET /activity
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_at property Modified
          • Type went from number | null to string(date-time) | null
            Breaking
        • property property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • actionable property Added
GET /contacts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_at, archived_at, last_active_at, last_login_at properties Modified
          • Type went from number | null to string(date-time) | null
            Breaking
        • alerts property Modified
        • nurture_state, auto_nurture_enabled, nurture_reasons, auto_nurture_enabled_at properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • status, auto_nurture properties Added
  • Query
  • nurture_state query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • status query parameter Added
GET /contacts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_at, archived_at, last_active_at, last_login_at, first_email_received_at properties Modified
        • Type went from number | null to string(date-time) | null
          Breaking
      • alerts property Modified
        • listing_alerts, market_alerts, home_value_alerts properties Modified
      • notes property Modified
        • nodes property Modified
      • buying_timeline property Modified
        • updated_at property Modified
          • Type went from number | null to string(date-time) | null
            Breaking
      • residence property Modified
        • last_confirmed_at property Modified
          • Type went from number | null to string(date-time) | null
            Breaking
      • nurture_state, auto_nurture_enabled, nurture_reasons, auto_nurture_enabled_at properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • status, auto_nurture properties Added
GET /me
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_at property Modified
        • Type went from number | null to string(date-time) | null
          Breaking
PATCH /contacts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contact property Modified
        • created_at, archived_at, last_active_at, last_login_at properties Modified
          • Type went from number | null to string(date-time) | null
            Breaking
        • nurture_state, auto_nurture_enabled, nurture_reasons, auto_nurture_enabled_at properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • status, auto_nurture properties Added
POST /contacts
  • Response
  • 201 response Modified
    • application/json content type Modified
      • contact property Modified
        • created_at, archived_at, last_active_at, last_login_at properties Modified
          • Type went from number | null to string(date-time) | null
            Breaking
        • nurture_state, auto_nurture_enabled, nurture_reasons, auto_nurture_enabled_at properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • status, auto_nurture properties Added
POST /contacts/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contacts property Modified
        • created_at, archived_at, last_active_at, last_login_at properties Modified
          • Type went from number | null to string(date-time) | null
            Breaking
        • nurture_state, auto_nurture_enabled, nurture_reasons, auto_nurture_enabled_at properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • status, auto_nurture properties Added
POST /contacts/auto-nurture/disable
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contacts property Modified
        • created_at, archived_at, last_active_at, last_login_at properties Modified
          • Type went from number | null to string(date-time) | null
            Breaking
        • nurture_state, auto_nurture_enabled, nurture_reasons, auto_nurture_enabled_at properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • status, auto_nurture properties Added
POST /contacts/auto-nurture/enable
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contacts property Modified
        • created_at, archived_at, last_active_at, last_login_at properties Modified
          • Type went from number | null to string(date-time) | null
            Breaking
        • nurture_state, auto_nurture_enabled, nurture_reasons, auto_nurture_enabled_at properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • status, auto_nurture properties Added
POST /contacts/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • contacts property Modified
        • created_at, archived_at, last_active_at, last_login_at properties Modified
          • Type went from number | null to string(date-time) | null
            Breaking
        • nurture_state, auto_nurture_enabled, nurture_reasons, auto_nurture_enabled_at properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • status, auto_nurture properties Added