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
6 structure changes including:
1 Addition
5 Modifications
Modified 5
GET /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • folder_name property Added
POST /api/v1/file
  • Response
  • 200 response Modified
    • folder_name property Added
POST /api/v1/file/direct-upload
  • Response
  • 201 response Modified
    • folder_name property Added
PUT /api/v1/file/{file_uuid}/copy
  • Response
  • 200 response Modified
    • folder_name property Added
PUT /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • folder_name property Added
Added 1
GET /api/v1/documents/{model}/{modelUuid}
12 structure changes including:
7 Additions
5 Modifications
Modified 5 Breaking
POST /api/v1/firm/{firm_uuid}/branding
  • Body
  • content type Modified
    • primary_colour property Removed
    • brand_colours property Added
POST /api/v1/plans
  • Body
  • content type Modified
    • premium property Removed
    • premium_contribution, premium_contribution_frequency, premium_contribution_details, transfer_from, initial_purchase_amount properties Added
  • Response
  • 200 (1) response Modified
    • fields property Modified
  • 200 (2) response Modified
    • fields property Modified
  • 200 (3) response Modified
    • fields property Modified
  • 200 (4) response Modified
    • fields property Modified
  • 200 (5) response Modified
    • fields property Modified
PUT /api/v1/me
  • Body
  • content type Modified
    • two_factor_enabled, two_factor_mobile properties Removed
PUT /api/v1/plans/{uuid}
  • Body
  • content type Modified
    • premium property Removed
    • premium_contribution, premium_contribution_frequency, premium_contribution_details, transfer_from, initial_purchase_amount properties Added
PUT /api/v1/tag/{uuid}
  • Body
  • content type Modified
    • colour property Added
Added 7
GET /api/v1/me/otp/recovery-codes
GET /api/v1/me/otp/show
POST /api/v1/me/otp/confirm
POST /api/v1/me/otp/new-recovery-codes
POST /api/v1/me/otp/reset
POST /api/v1/me/otp/settings
POST /api/v1/me/sms/setup
3 structure changes including:
3 Modifications
Modified 3 Breaking
POST /api/v1/plans
  • Body
  • content type Modified
    • current_value, current_value_at properties Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}
  • Body
  • content type Modified
    • value property Modified
PUT /api/v1/plans/{uuid}
  • Body
  • content type Modified
    • current_value, current_value_at properties Added
10 structure changes including:
5 Additions
5 Modifications
Modified 5 Breaking
GET /api/v1/client/{client_uuid}/new-business-events
  • Query
  • filter[provider], filter[adviser], filter[date_range] query parameters Removed
  • filter[provider_uuid], filter[adviser_uuid], filter[date_from], filter[date_to] query parameters Added
GET /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • existing_plan_type property Removed
    • existing_plan property Added
GET /api/v1/plans/{plan_uuid}/new-business-events
  • Query
  • filter[provider], filter[adviser], filter[date_range] query parameters Removed
  • filter[provider_uuid], filter[adviser_uuid], filter[date_from], filter[date_to] query parameters Added
POST /api/v1/new-business-event
  • Body
  • content type Modified
    • premium_frequency, is_vulnerable_client properties Modified
    • existing_plan_type property Removed
    • existing_plan_uuid property Added
  • Response
  • 201 response Modified
    • existing_plan_type property Removed
    • existing_plan property Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Body
  • content type Modified
    • premium_frequency, is_vulnerable_client properties Modified
    • existing_plan_type property Removed
    • existing_plan_uuid property Added
  • Response
  • 200 response Modified
    • existing_plan_type property Removed
    • existing_plan property Added
Added 5
GET /api/v1/static/advice-types/{type}
GET /api/v1/static/conducted-by
GET /api/v1/static/contribution-types/{type}
GET /api/v1/static/frequencies/{type}
GET /api/v1/static/source-of-funds
49 structure changes including:
22 Breaking changes
23 Additions
4 Modifications
22 Removals
Modified 4 Breaking
PUT /api/v1/employee/{uuid}
  • Body
  • content type Modified
    • with_login, departments properties Added
POST /api/v1/employee
  • Body
  • content type Modified
    • email property Modified
    • with_login, departments properties Added
GET /api/v1/employee
  • Query
  • filter[departments] query parameter Added
PUT /api/v1/expectation/{uuid}
  • Body
  • content type Modified
    • advice_area property Added
Removed 22 Breaking
DELETE /api/v1/account/{account_uuid}/contact-detail/{id}
DELETE /api/v1/client/{client_uuid}/linked-clients/{id}
DELETE /api/v1/client/{uuid}
GET /api/v1/account/{account_uuid}/contact-detail
GET /api/v1/account/{account_uuid}/contact-detail/{id}
GET /api/v1/client
GET /api/v1/client/{client_id}/fact-find/requests
GET /api/v1/client/{client_uuid}/linked-clients
GET /api/v1/client/{client_uuid}/new-business-events
GET /api/v1/client/{client_uuid}/owners
GET /api/v1/client/{client_uuid}/plans
GET /api/v1/client/{client_uuid}/wealth
GET /api/v1/client/{client}/shared-accounts
GET /api/v1/client/{uuid}
POST /api/v1/account/{account_uuid}/contact-detail
POST /api/v1/client
POST /api/v1/client/{client_uuid}/linked-clients
POST /api/v1/client/{client_uuid}/owners
PUT /api/v1/account/{account_uuid}/contact-detail/{id}
PUT /api/v1/client/{client_uuid}/linked-clients/{id}
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
PUT /api/v1/client/{uuid}
Added 23
DELETE /api/v1/account/{account_uuid}/contact-detail/{id}
DELETE /api/v1/client/{client_uuid}/linked-clients/{id}
DELETE /api/v1/client/{uuid}
GET /api/v1/account/{account_uuid}/contact-detail
GET /api/v1/account/{account_uuid}/contact-detail/{id}
GET /api/v1/client
GET /api/v1/client/{client_id}/fact-find/requests
GET /api/v1/client/{client_uuid}/linked-clients
GET /api/v1/client/{client_uuid}/new-business-events
GET /api/v1/client/{client_uuid}/owners
GET /api/v1/client/{client_uuid}/plans
GET /api/v1/client/{client_uuid}/wealth
GET /api/v1/client/{client}/shared-accounts
GET /api/v1/client/{uuid}
GET /api/v1/static/departments
POST /api/v1/account/{account_uuid}/contact-detail
POST /api/v1/client
POST /api/v1/client/{client_uuid}/linked-clients
POST /api/v1/client/{client_uuid}/owners
PUT /api/v1/account/{account_uuid}/contact-detail/{id}
PUT /api/v1/client/{client_uuid}/linked-clients/{id}
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
PUT /api/v1/client/{uuid}
1 structure change including:
1 Addition
Added 1
POST /api/v1/postcode/search
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • advisor property Removed
    • adviser property Added
POST /api/v1/new-business-event
  • Body
  • content type Modified
    • advisor_uuid property Removed
    • adviser_uuid property Added
  • Response
  • 201 response Modified
    • advisor property Removed
    • adviser property Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Body
  • content type Modified
    • advisor_uuid property Removed
    • adviser_uuid property Added
  • Response
  • 200 response Modified
    • advisor property Removed
    • adviser property Added