Do not miss any PlannrCRM API changes, ever again

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

RSS

about 2 hours ago

main
v1.138.4
Compare
v1.138.4

API structure has changed

Next change
61 structure changes including:
61 Modifications
Modified 61 Breaking
GET /api/v1/account/{account_uuid}/check
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • folder property Modified
GET /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folder property Modified
        • files property Modified
GET /api/v1/account/{account_uuid}/conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • latest_message property Modified
GET /api/v1/account/{account_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • files property Modified
      • files property Modified
        • preview_url property Added
      • parents property Modified
        • files property Modified
      • ancestors property Modified
        • files property Modified
      • children property Modified
        • files property Modified
GET /api/v1/cases/{case_uuid}/conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • latest_message property Modified
GET /api/v1/cases/{case_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • files property Modified
      • files property Modified
        • preview_url property Added
      • parents property Modified
        • files property Modified
      • ancestors property Modified
        • files property Modified
      • children property Modified
        • files property Modified
GET /api/v1/circles/{circle_uuid}/conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • latest_message property Modified
GET /api/v1/circles/{circle_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • files property Modified
      • files property Modified
        • preview_url property Added
      • parents property Modified
        • files property Modified
      • ancestors property Modified
        • files property Modified
      • children property Modified
        • files property Modified
GET /api/v1/circles/{circle_uuid}/fact-find-requests
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • latest_file property Modified
GET /api/v1/client/{client_id}/fact-find/requests
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • latest_file property Modified
GET /api/v1/conversation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • latest_message property Modified
GET /api/v1/conversation/{conversation_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • files property Modified
      • files property Modified
        • preview_url property Added
      • parents property Modified
        • files property Modified
      • ancestors property Modified
        • files property Modified
      • children property Modified
        • files property Modified
GET /api/v1/conversation/{conversation_uuid}/messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • files property Modified
GET /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • files property Modified
        • preview_url property Added
GET /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_message property Modified
        • files property Modified
GET /api/v1/fact-find/request
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • latest_file property Modified
GET /api/v1/fact-find/request/{factFindRequest_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_file property Modified
        • preview_url property Added
GET /api/v1/file/bin
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • folder property Modified
        • preview_url property Added
GET /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folder property Modified
        • files property Modified
      • preview_url property Added
GET /api/v1/files/{model}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folder property Modified
        • files property Modified
      • preview_url property Added
GET /api/v1/firm/{firm_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • files property Modified
      • files property Modified
        • preview_url property Added
      • parents property Modified
        • files property Modified
      • ancestors property Modified
        • files property Modified
      • children property Modified
        • files property Modified
GET /api/v1/folder/{folder_uuid}/files
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folder property Modified
        • files property Modified
      • preview_url property Added
GET /api/v1/folder/{folder_uuid}/tree
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • files property Modified
      • files property Modified
        • preview_url property Added
      • parents property Modified
        • files property Modified
      • ancestors property Modified
        • files property Modified
      • children property Modified
        • files property Modified
GET /api/v1/folder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • files property Modified
      • files property Modified
        • preview_url property Added
      • parents property Modified
        • files property Modified
      • ancestors property Modified
        • files property Modified
      • children property Modified
        • files property Modified
GET /api/v1/illustration/{illustration_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • files property Modified
      • files property Modified
        • preview_url property Added
      • parents property Modified
        • files property Modified
      • ancestors property Modified
        • files property Modified
      • children property Modified
        • files property Modified
GET /api/v1/import
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • error_report property Modified
GET /api/v1/import/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • error_report property Modified
        • preview_url property Added
GET /api/v1/plans/{plan_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • files property Modified
      • files property Modified
        • preview_url property Added
      • parents property Modified
        • files property Modified
      • ancestors property Modified
        • files property Modified
      • children property Modified
        • files property Modified
GET /api/v1/report
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • files, folder properties Modified
GET /api/v1/report/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • files property Modified
        • preview_url property Added
      • folder property Modified
        • files property Modified
GET /api/v2/fact-find/session
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • latest_file property Modified
GET /api/v2/fact-find/session/{factFindSession_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_file property Modified
        • preview_url property Added
GET /api/v2/fact-find/session/{factFindSession_uuid}/launch
  • Response
  • 401 response Modified
    • application/json content type Modified
      • Type is now object
      • Plannr_Error property Added
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • 403 response Modified
    • application/json content type Modified
      • Type is now object
      • Plannr_Error property Added
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • 404 response Modified
    • application/json content type Modified
      • Type is now object
      • Plannr_Error property Added
    • text/plain content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
GET /api/v2/mortgage-searches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • products, files properties Modified
GET /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products property Modified
        • files property Modified
      • files property Modified
        • preview_url property Added
GET /api/v2/portal/actions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • resource property Modified
POST /api/v1/account/{account_uuid}/check
  • Response
  • 201 response Modified
    • application/json content type Modified
      • folder property Modified
        • files property Modified
POST /api/v1/addons/mortgagebrain/mortgage-search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products property Modified
        • files property Modified
      • files property Modified
        • preview_url property Added
POST /api/v1/conversation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_message property Modified
        • files property Modified
POST /api/v1/conversation/inline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_message property Modified
        • files property Modified
POST /api/v1/conversation/{conversation_uuid}/messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • files property Modified
        • preview_url property Added
POST /api/v1/conversation/{conversation_uuid}/messages/inline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • files property Modified
        • preview_url property Added
POST /api/v1/fact-find/request
  • Response
  • 201 response Modified
    • application/json content type Modified
      • latest_file property Modified
        • preview_url property Added
POST /api/v1/fact-find/request/{factFindRequest_uuid}/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_file property Modified
        • preview_url property Added
POST /api/v1/fact-find/request/{factFindRequest_uuid}/finish
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_file property Modified
        • preview_url property Added
POST /api/v1/file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folder property Modified
        • files property Modified
      • preview_url property Added
POST /api/v1/file/direct-upload
  • Response
  • 201 response Modified
    • application/json content type Modified
      • folder property Modified
        • files property Modified
      • preview_url property Added
POST /api/v1/folder
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • files property Modified
      • files property Modified
        • preview_url property Added
      • parents property Modified
        • files property Modified
      • ancestors property Modified
        • files property Modified
      • children property Modified
        • files property Modified
POST /api/v1/import
  • Response
  • 200 response Modified
    • application/json content type Modified
      • error_report property Modified
        • preview_url property Added
POST /api/v1/import/map/{import_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • error_report property Modified
        • preview_url property Added
POST /api/v1/import/start/{import_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • error_report property Modified
        • preview_url property Added
POST /api/v1/provider-statement/import
  • Response
  • 201 response Modified
    • application/json content type Modified
      • error_report property Modified
        • preview_url property Added
POST /api/v1/report
  • Response
  • 201 response Modified
    • application/json content type Modified
      • files property Modified
        • preview_url property Added
      • folder property Modified
        • files property Modified
POST /api/v2/fact-find/session
  • Response
  • 201 response Modified
    • application/json content type Modified
      • latest_file property Modified
        • preview_url property Added
PUT /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folder property Modified
        • files property Modified
PUT /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • files property Modified
        • preview_url property Added
PUT /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_message property Modified
        • files property Modified
PUT /api/v1/file/{file_uuid}/copy
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folder property Modified
        • files property Modified
      • preview_url property Added
PUT /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folder property Modified
        • files property Modified
      • preview_url property Added
PUT /api/v1/folder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • folders property Modified
        • files property Modified
      • files property Modified
        • preview_url property Added
      • parents property Modified
        • files property Modified
      • ancestors property Modified
        • files property Modified
      • children property Modified
        • files property Modified
PUT /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • products property Modified
        • files property Modified
      • files property Modified
        • preview_url property Added