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
19 structure changes including:
19 Breaking changes
19 Removals
Removed 19 Breaking
DELETE /api/v1/payment-method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/v1/subscription
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/invoice
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/invoice/{invoiceId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/invoice/{invoiceId}/download
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/me/otp/recovery-codes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/me/otp/show
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/payment-method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/subscription
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/subscription/plans
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/firm/{firm_id}/billing
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/me/otp/confirm
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/me/otp/new-recovery-codes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/me/otp/reset
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/me/otp/settings
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/me/sms/setup
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/payment-method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/v1/subscription
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/v1/payment-method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
5 structure changes including:
5 Modifications
Modified 5
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_wrap_product, is_wrap_child properties Added
POST /api/v1/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_wrap_product, is_wrap_child properties Added
  • 200 (1) response Modified
    • application/json content type Modified
      • is_wrap_product, is_wrap_child properties Added
  • 200 (2) response Modified
    • application/json content type Modified
      • is_wrap_product, is_wrap_child properties Added
  • 200 (3) response Modified
    • application/json content type Modified
      • is_wrap_product, is_wrap_child properties Added
  • 200 (4) response Modified
    • application/json content type Modified
      • is_wrap_product, is_wrap_child properties Added
  • 200 (5) response Modified
    • application/json content type Modified
      • is_wrap_product, is_wrap_child properties Added
  • 200 (6) response Modified
    • application/json content type Modified
      • is_wrap_product, is_wrap_child properties Added
  • 200 (7) response Modified
    • application/json content type Modified
      • is_wrap_product, is_wrap_child properties Added
  • 200 (8) response Modified
    • application/json content type Modified
      • is_wrap_product, is_wrap_child properties Added
  • 200 (9) response Modified
    • application/json content type Modified
      • is_wrap_product, is_wrap_child properties Added
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_wrap_product, is_wrap_child properties Added
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_wrap_product, is_wrap_child properties Added
PUT /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_wrap_product, is_wrap_child properties Added
10 structure changes including:
1 Breaking change
5 Additions
4 Modifications
1 Removal
Modified 4 Breaking
GET /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • fca_numbers property Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

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

          Breaking

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

          Breaking

PUT /api/v1/firm/{uuid}
  • Body
  • application/json content type Modified
    • fca_numbers property Removed
      • Removing a resource is always breaking unless it was deprecated before

        Breaking

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

          Breaking

Removed 1 Breaking
POST /api/v1/my/welcome-widget-items
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 5
DELETE /api/v1/firm/{firm_uuid}/fca/{uuid}
GET /api/v1/firm/{firm}/fca
GET /api/v1/my/welcome-widget-tasks
POST /api/v1/firm/{firm}/fca
POST /api/v1/my/welcome-widget-tasks/{id}
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /api/v1/fact-find/schema/{factFindSchema_uuid}/section/{factFindSchemaSection_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_completed property Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

POST /api/v1/fact-find/schema/{factFindSchema_uuid}/section
  • Response
  • 201 response Modified
    • application/json content type Modified
      • is_completed property Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

PUT /api/v1/fact-find/schema/{factFindSchema_uuid}/section/{factFindSchemaSection_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_completed property Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

7 structure changes including:
1 Breaking change
1 Addition
5 Modifications
1 Removal
Modified 5
GET /api/v1/import
  • Query
  • filter[types], filter[statuses] query parameters Added
GET /api/v1/import/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Added
POST /api/v1/import
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Added
POST /api/v1/import/map/{import_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Added
POST /api/v1/import/start/{import_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Added
Removed 1 Breaking
GET /api/v1/import/keys/{importer}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /api/v1/import/keys/{importer}/{mode}
3 structure changes including:
3 Modifications
Modified 3
GET /api/v1/fact-find/schema/{factFindSchema_uuid}/section/{factFindSchemaSection_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_completed property Added
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/section
  • Response
  • 201 response Modified
    • application/json content type Modified
      • is_completed property Added
PUT /api/v1/fact-find/schema/{factFindSchema_uuid}/section/{factFindSchemaSection_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_completed property Added