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

2 days ago

main
v1.79.3
Compare
v1.79.3

API structure has changed

4 structure changes including:
4 Modifications
Modified 4 Breaking
POST /api/v1/plans
  • Body
  • application/json content type Modified
    • name, policy_number, proposal_reference, inactive_reason properties Modified
      • Type went from string to string | null
    • provider_uuid, seller_uuid, active_adviser_uuid, wrap_uuid, contract_enquiry_account_uuid properties Modified
      • Type went from string(uuid) to string(uuid) | null
    • opened_at, inactive_at, agency_in_your_name_from, review_date, current_value_at properties Modified
      • Type went from string(date) to string(date) | null
    • agency_in_your_name, originally_sold_by_firm, under_advice, show_on_joint, on_panel, is_group_scheme, is_wrap_product properties Modified
      • Type went from boolean to boolean | null
    • visible_on_client_portal, include_in_client_valuation properties Modified
      • Properties are now required
        Breaking
    • visible_to_circles_uuids property Modified
      • Type went from array[string(uuid)] to array[string(uuid)] | null
    • current_value property Modified
      • Type went from integer to integer | null
    • seller_name property Added
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Body
  • application/json content type Modified
    • on_risk_at property Modified
      • Type went from string(date) to string(date) | null
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Body
  • application/json content type Modified
    • policy_number property Modified
      • Type went from string to string | null
    • inactive_at, on_risk_at properties Modified
      • Type went from string(date) to string(date) | null
PUT /api/v1/plans/{uuid}
  • Body
  • application/json content type Modified
    • name, policy_number, proposal_reference, inactive_reason properties Modified
      • Type went from string to string | null
    • accounts property Modified
      • Type went from array to array[object]
      • object property Added
    • provider_uuid, seller_uuid, active_adviser_uuid, wrap_uuid, contract_enquiry_account_uuid properties Modified
      • Type went from string(uuid) to string(uuid) | null
    • opened_at property Modified
      • Type went from string to string(date) | null
    • inactive_at, agency_in_your_name_from, review_date, current_value_at properties Modified
      • Type went from string(date) to string(date) | null
    • agency_in_your_name, originally_sold_by_firm, under_advice, on_panel properties Modified
      • Type went from boolean to boolean | null
    • cases, visible_to_circles_uuids properties Modified
      • Type went from array to array[string(uuid)] | null
    • linked_owners, linked_plans properties Modified
      • Type went from array to array[string(uuid)]
    • current_value property Modified
      • Type went from integer to integer | null
    • group_scheme_member_detail property Modified
      • Type went from array to object
        Breaking
      • workplace_location, employment_division properties Added
    • beneficiaries property Modified
      • Type went from array to array[object]
      • object property Added
    • seller_name property Added