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

Jun 22, 2023

main
1.0.0
Compare

API structure has changed

42 structure changes including:
10 Breaking changes
15 Additions
17 Modifications
10 Removals
Modified 17 Breaking
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • groups property Modified
    • task_board_uuid property Removed
    • type, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account properties Added
POST /api/v1/employee
  • Response
  • 200 response Modified
    • groups property Modified
    • task_board_uuid property Removed
    • type, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account properties Added
POST /api/v1/client
  • Body
  • content type Modified
    • assigned_paraplanner_uuid property Added
  • Response
  • 200 response Modified
    • groups property Modified
    • task_board_uuid property Removed
    • type, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account properties Added
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • fields property Removed
    • agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, review_date, on_panel properties Added
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • groups property Modified
    • task_board_uuid property Removed
    • type, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account properties Added
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • groups property Modified
    • task_board_uuid property Removed
    • type, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account properties Added
GET /api/v1/employee
  • Response
  • 200 response Modified
    • groups property Modified
    • task_board_uuid property Removed
    • type, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account properties Added
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • groups property Modified
    • task_board_uuid property Removed
    • type, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account properties Added
GET /api/v1/client/{client_uuid}/wealth
  • Response
  • 200 response Modified
    • total_wealth_now, total_wealth_last_month, recent_change_percentage properties Removed
    • valued_at, networth, total_assets, total_liabilities, total_protection properties Added
  • Query
  • date, filter[include_other_plans] query parameters Added
GET /api/v1/client/{client_uuid}/plans
  • Query
  • filter[include_other_plans] query parameter Added
GET /api/v1/client
  • Response
  • 200 response Modified
    • groups property Modified
    • task_board_uuid property Removed
    • type, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account properties Added
  • Query
  • filter[status] query parameter Added
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • groups property Modified
    • task_board_uuid property Removed
    • type, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account properties Added
POST /api/v1/plans
  • Body
  • content type Modified
    • show_on_joint property Added
  • Response
  • 200 response Modified
    • fields property Removed
    • agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, review_date, on_panel properties Added
  • 200 (1) response Modified
    • fields property Removed
    • agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, review_date, on_panel properties Added
  • 200 (2) response Modified
    • fields property Removed
    • agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, review_date, on_panel properties Added
  • 200 (3) response Modified
    • fields property Removed
    • agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, review_date, on_panel properties Added
  • 200 (4) response Modified
    • fields property Removed
    • agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, review_date, on_panel properties Added
  • 200 (5) response Modified
    • fields property Removed
    • agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, review_date, on_panel properties Added
  • 200 (6) response Modified
    • fields property Removed
    • agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, review_date, on_panel properties Added
  • 200 (7) response Modified
    • fields property Removed
    • agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, review_date, on_panel properties Added
  • 200 (8) response Modified
    • fields property Removed
    • agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, review_date, on_panel properties Added
  • 200 (9) response Modified
    • fields property Removed
    • agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, review_date, on_panel properties Added
PUT /api/v1/client/{uuid}
  • Body
  • content type Modified
    • assigned_paraplanner_uuid property Added
  • Response
  • 200 response Modified
    • groups property Modified
    • task_board_uuid property Removed
    • type, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account properties Added
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • groups property Modified
    • task_board_uuid property Removed
    • type, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account properties Added
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • groups property Modified
    • task_board_uuid property Removed
    • type, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account properties Added
PUT /api/v1/plans/{uuid}
  • Body
  • content type Modified
    • show_on_joint property Added
  • Response
  • 200 response Modified
    • fields property Removed
    • agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, review_date, on_panel properties Added
Removed 10 Breaking
DELETE /api/v1/account/{account_uuid}/address/{uuid}
DELETE /api/v1/account/{account_uuid}/contact-detail/{id}
GET /api/v1/account/{account_uuid}/address
GET /api/v1/account/{account_uuid}/address/{uuid}
GET /api/v1/account/{account_uuid}/contact-detail
GET /api/v1/account/{account_uuid}/contact-detail/{id}
POST /api/v1/account/{account_uuid}/address
POST /api/v1/account/{account_uuid}/contact-detail
PUT /api/v1/account/{account_uuid}/address/{uuid}
PUT /api/v1/account/{account_uuid}/contact-detail/{id}
Added 15
PUT /api/v1/account/{uuid}
PUT /api/v1/account/{account_uuid}/contact-detail/{id}
PUT /api/v1/account/{account_uuid}/address/{uuid}
POST /api/v1/account/{account_uuid}/contact-detail
POST /api/v1/account/{account_uuid}/address
POST /api/v1/account
GET /api/v1/account/{uuid}
GET /api/v1/account/{account_uuid}/contact-detail/{id}
GET /api/v1/account/{account_uuid}/contact-detail
GET /api/v1/account/{account_uuid}/address/{uuid}
GET /api/v1/account/{account_uuid}/address
GET /api/v1/account
DELETE /api/v1/account/{uuid}
DELETE /api/v1/account/{account_uuid}/contact-detail/{id}
DELETE /api/v1/account/{account_uuid}/address/{uuid}