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

Jan 8, 2026

main
v1.70.4
Compare
v1.70.4

API structure has changed

18 structure changes including:
1 Breaking change
1 Addition
16 Modifications
1 Removal
Modified 16 Breaking
PUT /api/v2/risks/{uuid}
  • Body
  • application/json content type Modified
    • level property Modified
      • Type went from integer to integer | null
    • level_string, risk_assessment_provider, time_horizon properties Modified
      • Type went from string to string | null
PUT /api/v2/income/{uuid}
  • Body
  • application/json content type Modified
    • type_other property Modified
      • Type went from string to string | null
    • start_date, end_date properties Modified
      • Type went from string to string(date) | null
    • shared_owner_uuid property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /api/v2/goals/{uuid}
  • Body
  • application/json content type Modified
    • account_uuids, visible_to_circles_uuids properties Modified
      • Type went from array to array[string(uuid)]
    • timeframe property Modified
      • Type went from string to string | null
PUT /api/v2/employments/{uuid}
  • Body
  • application/json content type Modified
    • accountant_company_name, accountant_email, accountant_telephone_number, accountant_address, business_name, business_year_end, directors, employer, email_address, job_title, occupation_code, phone_number properties Modified
      • Type went from string to string | null
    • business_value, percentage_of_business_owned, profit properties Modified
      • Type went from integer to integer | null
    • last_salary_increase property Modified
      • Type went from string(date) to string(date) | null
    • shareholding_in_business property Modified
      • Type went from number(float) to number(float) | null
    • turnover_history property Added
PUT /api/v2/dependants/{uuid}
  • Body
  • application/json content type Modified
    • account_uuids property Modified
      • Property is now required
        Breaking
      • Type went from array to array[string(uuid)]
    • first_name, last_name, relationship properties Modified
      • Properties are now required
        Breaking
    • known_as, notes properties Modified
      • Type went from string to string | null
    • date_of_birth property Modified
      • Type went from string(date) to string(date) | null
PUT /api/v2/contact-details/{uuid}
  • Body
  • application/json content type Modified
    • name property Modified
      • Property is now required
        Breaking
    • value property Modified
      • value alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • string-1, string-2, object-3, string-4 alternatives Added
    • account_uuids property Modified
      • Property is now required
        Breaking
      • Type went from array to array[string(uuid)]
    • primary_account_uuids property Modified
      • Type went from array to array[string(uuid)]
PUT /api/v2/bank-accounts/{uuid}
  • Body
  • application/json content type Modified
    • account_uuids property Modified
      • Type went from array to array[string(uuid)]
PUT /api/v2/addresses/{uuid}
  • Body
  • application/json content type Modified
    • account_uuids, primary_account_uuids properties Modified
      • Type went from array to array[string(uuid)]
    • move_in_date property Added
POST /api/v2/risks
  • Body
  • application/json content type Modified
    • account_uuid property Modified
      • Property is now required
        Breaking
      • Type went from string to string(uuid)
    • level property Modified
      • Type went from integer to integer | null
    • level_string, risk_assessment_provider, time_horizon properties Modified
      • Type went from string to string | null
POST /api/v2/income
  • Body
  • application/json content type Modified
    • type_other property Modified
      • Type went from string to string | null
    • start_date, end_date properties Modified
      • Type went from string to string(date) | null
    • shared_owner_uuid property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/v2/goals
  • Body
  • application/json content type Modified
    • account_uuids, visible_to_circles_uuids properties Modified
      • Type went from array to array[string(uuid)]
    • description property Modified
      • Property is no longer required
      • Type went from string to string | null
    • timeframe property Modified
      • Type went from string to string | null
POST /api/v2/employments
  • Body
  • application/json content type Modified
    • accountant_company_name, accountant_email, accountant_telephone_number, accountant_address, business_name, business_year_end, directors, employer, email_address, job_title, occupation_code, phone_number properties Modified
      • Type went from string to string | null
    • business_value, percentage_of_business_owned, profit properties Modified
      • Type went from integer to integer | null
    • last_salary_increase property Modified
      • Type went from string(date) to string(date) | null
    • shareholding_in_business property Modified
      • Type went from number(float) to number(float) | null
    • turnover_history property Added
POST /api/v2/dependants
  • Body
  • application/json content type Modified
    • account_uuids property Modified
      • Type went from array to array[string(uuid)]
    • known_as, notes properties Modified
      • Type went from string to string | null
    • date_of_birth property Modified
      • Type went from string(date) to string(date) | null
POST /api/v2/contact-details
  • Body
  • application/json content type Modified
    • value property Modified
      • value alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • string-1, string-2, object-3, string-4 alternatives Added
    • account_uuids, primary_account_uuids properties Modified
      • Type went from array to array[string(uuid)]
POST /api/v2/bank-accounts
  • Body
  • application/json content type Modified
    • account_uuids property Modified
      • Type went from array to array[string(uuid)]
POST /api/v2/addresses
  • Body
  • application/json content type Modified
    • account_uuids, primary_account_uuids properties Modified
      • Type went from array to array[string(uuid)]
    • name, address_1 properties Modified
      • Properties are no longer required
    • move_in_date property Added
Removed 1 Breaking
GET /api/v1/platform/{uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /api/v1/platform/{id}