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

20 days ago

main
v1.82.2
Compare
v1.82.2

API structure has changed

22 structure changes including:
1 Breaking change
21 Modifications
1 Removal
Modified 21 Breaking
DELETE /api/v1/addon-subscriptions/{addonSubscription_uuid}/unsubscribe
  • Response
  • 204 response Modified
    • application/json content type Modified
      • addon property Modified
        • params property Modified
GET /api/v1/addon
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • params property Modified
GET /api/v1/addon-subscriptions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • addon property Modified
GET /api/v1/addon-subscriptions/{addonSubscription_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • addon property Modified
        • params property Modified
GET /api/v1/addons/seccl/{addon}/client/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • employers property Modified
        • addressDetail property Modified
GET /api/v1/task
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • workflow_task property Added
GET /api/v1/task/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • workflow_task property Added
GET /api/v2/plans/linked-policy-numbers
  • Response
  • 401 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
GET /api/v2/plans/{plan_uuid}/returns
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • time_weighted_return, money_weighted_return properties Modified
PATCH /api/v1/addons/seccl/{addon}/client/{account_uuid}
  • Body
  • application/json content type Modified
    • title, nationality, national_insurance_no, tax_domicile, bank_details, marital_status, retirement_age, vulnerability, requires_debit_mandate, employment_status, employers, nationalities, platform_terms_agreed properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • employers property Modified
        • addressDetail property Modified
PATCH /api/v1/task/{task_uuid}/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • workflow_task property Added
PATCH /api/v1/task/{task_uuid}/uncomplete/{taskStatus}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • workflow_task property Added
POST /api/v1/addon-subscriptions/{addonSubscription_uuid}/confirm-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • addon property Modified
        • params property Modified
POST /api/v1/addon-subscriptions/{addonSubscription_uuid}/disable
  • Response
  • 200 response Modified
    • application/json content type Modified
      • addon property Modified
        • params property Modified
POST /api/v1/addon-subscriptions/{addonSubscription_uuid}/enable
  • Response
  • 200 response Modified
    • application/json content type Modified
      • addon property Modified
        • params property Modified
POST /api/v1/addons/mortgagebrain/mortgage-search
  • Body
  • application/json content type Modified
    • applicants property Modified
      • date_of_birth, birth_gender, salutation, retirement_age, employment_status, annual_salary_amount properties Added
    • case_uuids property Modified
      • Type went from array[string(uuid)] to array[string(uuid)] | null
    • oauth_connection_uuid property Modified
      • Type went from string(uuid) to string(uuid) | null
POST /api/v1/subscribe
  • Response
  • 200 response Modified
    • application/json content type Modified
      • addon property Modified
        • params property Modified
POST /api/v1/task
  • Response
  • 201 response Modified
    • application/json content type Modified
      • workflow_task property Added
POST /api/v2/plans/{plan_uuid}/linked-policy-numbers
  • Response
  • 401 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 201 response Added
PUT /api/v1/task/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • workflow_task property Added
PUT /api/v2/plans/{plan_uuid}/linked-policy-numbers/{uuid}
  • Response
  • 201 response Added
Removed 1 Breaking
GET /api/v1/networks/{network_uuid}/charges
  • Removing a resource is always breaking unless it was deprecated before
    Breaking