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

Changelog

Last update:
Compare
5 structure changes including:
5 Modifications
Modified 5
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • valued_at property Added
POST /api/v1/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • valued_at property Added
  • 200 (1) response Modified
    • application/json content type Modified
      • valued_at property Added
  • 200 (2) response Modified
    • application/json content type Modified
      • valued_at property Added
  • 200 (3) response Modified
    • application/json content type Modified
      • valued_at property Added
  • 200 (4) response Modified
    • application/json content type Modified
      • valued_at property Added
  • 200 (5) response Modified
    • application/json content type Modified
      • valued_at property Added
  • 200 (6) response Modified
    • application/json content type Modified
      • valued_at property Added
  • 200 (7) response Modified
    • application/json content type Modified
      • valued_at property Added
  • 200 (8) response Modified
    • application/json content type Modified
      • valued_at property Added
  • 200 (9) response Modified
    • application/json content type Modified
      • valued_at property Added
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • valued_at property Added
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • valued_at property Added
PUT /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • valued_at property Added
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • email_welcome_paragraph property Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

      • email_welcome_paragraph_html property Added
POST /api/v1/firm/{firm_uuid}/branding
  • Body
  • application/json content type Modified
    • email_welcome_paragraph property Removed
      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • email_welcome_paragraph_html property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • email_welcome_paragraph property Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

      • email_welcome_paragraph_html property Added
POST /api/v1/firm/{firm_uuid}/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • email_welcome_paragraph property Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

      • email_welcome_paragraph_html property Added
PUT /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • email_welcome_paragraph property Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

      • email_welcome_paragraph_html property Added
6 structure changes including:
6 Modifications
Modified 6 Breaking
GET /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • welcome_paragraph_html, email_welcome_paragraph properties Added
POST /api/v1/account/{account_uuid}/login
  • Body
  • application/json content type Modified
    • wealth_enabled property Modified
      • Full types went from string to boolean

        Breaking

      • wealth_enabled property Modified
        • Full types went from string to boolean

          Breaking

    • goals_enabled, factfind_enabled, tasks_enabled, welcome_enabled properties Added
POST /api/v1/firm/{firm_uuid}/branding
  • Body
  • application/json content type Modified
    • welcome_paragraph_html, email_welcome_paragraph properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • welcome_paragraph_html, email_welcome_paragraph properties Added
POST /api/v1/firm/{firm_uuid}/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • welcome_paragraph_html, email_welcome_paragraph properties Added
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Body
  • application/json content type Modified
    • goals_enabled, factfind_enabled, tasks_enabled, welcome_enabled properties Added
PUT /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • welcome_paragraph_html, email_welcome_paragraph properties Added
9 structure changes including:
2 Additions
7 Modifications
Modified 7
GET /api/v1/document-template/{documentTemplate_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • public_preview_url property Added
GET /api/v1/document/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • public_preview_url property Added
POST /api/v1/document
  • Response
  • 201 response Modified
    • application/json content type Modified
      • public_preview_url property Added
POST /api/v1/document-template
  • Response
  • 201 response Modified
    • application/json content type Modified
      • public_preview_url property Added
POST /api/v1/document/{document_uuid}/publish
  • Response
  • 200 response Modified
    • application/json content type Modified
      • public_preview_url property Added
PUT /api/v1/document-template/{documentTemplate_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • public_preview_url property Added
PUT /api/v1/document/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • public_preview_url property Added
Added 2
GET /api/v1/document-template/{documentTemplate_uuid}/content/preview
GET /api/v1/document/{document_uuid}/content/preview
56 structure changes including:
28 Breaking changes
28 Additions
28 Removals
Removed 28 Breaking
DELETE /api/v1/account/{account_uuid}/login/{uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/v1/reaction/{uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/v1/upload-files
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/account/{account_uuid}/login
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/addon
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/employee/{employee}/logs
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/logs/{modelType}/{modelUuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/me/logs
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/navigator/{modelType}/{modelUuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/search
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/state
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/account/{account_uuid}/login
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/addons/fundment/sync-clients
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/addons/fundment/sync-plans
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/addons/nucleus/sync-clients
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/addons/nucleus/sync-plans
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/addons/seccl/sync-clients
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/addons/seccl/sync-plans
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/webhook-targets
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/clone/{modelType}/{modelUuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/file/direct-upload
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/postcode/search
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/reaction
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/tinymce/auth
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/upload-files
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/upload-files/create
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/webhooks/{webhookTarget_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 28
DELETE /api/v1/account/{account_uuid}/login/{uuid}
DELETE /api/v1/reaction/{uuid}
DELETE /api/v1/upload-files
GET /api/v1/account/{account_uuid}/login
GET /api/v1/addon
GET /api/v1/employee/{employee}/logs
GET /api/v1/logs/{modelType}/{modelUuid}
GET /api/v1/me/logs
GET /api/v1/navigator/{modelType}/{modelUuid}
GET /api/v1/search
GET /api/v1/state
POST /api/v1/account/{account_uuid}/login
POST /api/v1/addons/fundment/sync-clients
POST /api/v1/addons/fundment/sync-plans
POST /api/v1/addons/nucleus/sync-clients
POST /api/v1/addons/nucleus/sync-plans
POST /api/v1/addons/seccl/sync-clients
POST /api/v1/addons/seccl/sync-plans
POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/webhook-targets
POST /api/v1/clone/{modelType}/{modelUuid}
POST /api/v1/file/direct-upload
POST /api/v1/postcode/search
POST /api/v1/reaction
POST /api/v1/tinymce/auth
POST /api/v1/upload-files
POST /api/v1/upload-files/create
POST /api/v1/webhooks/{webhookTarget_uuid}
PUT /api/v1/account/{account_uuid}/login/{uuid}