Change Updates

Do not miss any PlannrCRM API changes, ever again

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

RSS

Feb 28, 2025

main
1.0.0
Compare

API structure has changed

24 structure changes including:
3 Breaking changes
6 Additions
15 Modifications
3 Removals
Modified 15
POST /api/v1/firm/{firm_uuid}/branding
  • Body
  • application/json content type Modified
    • show_fact_find_illustrations property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • show_fact_find_illustrations property Added
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • public_url property Added
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • public_url property Added
POST /api/v1/fact-find/schema
  • Response
  • 201 response Modified
    • application/json content type Modified
      • public_url property Added
POST /api/v1/fact-find/request/{factFindRequest_uuid}/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account, invitation_url, fact_find_passes properties Added
  • Body
  • application/json content type Added
POST /api/v1/fact-find/request
  • Body
  • application/json content type Modified
    • circle_uuid, send_invitation_email properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account, invitation_url, fact_find_passes properties Added
GET /api/v1/note/{notableType}/{notableUuid}
  • Query
  • filter[path_exact] query parameter Added
GET /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • show_fact_find_illustrations property Added
GET /api/v1/fact-find/schema/{factFindSchema_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • public_url property Added
GET /api/v1/fact-find/request/{factFindRequest_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account, invitation_url, fact_find_passes properties Added
GET /api/v1/client/{client_uuid}/all-notes
  • Query
  • filter[path_exact] query parameter Added
GET /api/v1/circles/{circle_uuid}/notes
  • Query
  • filter[path_exact] query parameter Added
POST /api/v1/firm/{firm_uuid}/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • show_fact_find_illustrations property Added
PUT /api/v1/fact-find/schema/{factFindSchema_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • public_url property Added
PUT /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • show_fact_find_illustrations property Added
Removed 3 Breaking
POST /api/v1/fact-find/request/{factFindRequest_uuid}/section/{factFindSchemaSection_uuid}/complete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/fact-find/request/{factFindRequest_uuid}/section/{factFindSchemaSection_uuid}/completion
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/fact-find/request/{factFindRequest_uuid}/section/{factFindSchemaSection_uuid}/incomplete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 6
PUT /api/v1/circles/{circle_uuid}/fact-find-access
POST /api/v1/fact-find/request/{factFindRequest_uuid}/section/{factFindSchemaSection_uuid}/progress
POST /api/v1/fact-find/request/{factFindRequest_uuid}/finish
POST /api/v1/fact-find/request/{factFindRequest_uuid}/create-account
GET /api/v1/fact-find-passes/{factFindRequest_uuid}
GET /api/v1/circles/{circle_uuid}/fact-find-access