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
v1.32.0
1 structure change including:
1 Modification
Modified 1 Breaking
GET /api/v1/platform/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • platform_terms_url, product_terms properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • config, friendly_name properties Added
v1.30.3
1 structure change including:
1 Addition
Added 1
POST /api/v1/illustration/{illustration_uuid}/generate
v1.30.0
78 structure changes including:
78 Modifications
Modified 78
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/account/{account_uuid}/check
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/bank-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/charge
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/circles/{circle_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/client/{client_uuid}/emails
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{client_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{client_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{client_uuid}/owners
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{client}/shared-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/file/bin
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/files/{model}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • brand_colours property Modified
        • portal_sidebar_user_select_background, portal_sidebar_user_select_hover, portal_sidebar_user_select_text, portal_sidebar_user_select_text_hover, portal_sidebar_user_select_border, portal_sidebar_user_select_border_hover properties Added
GET /api/v1/folder/{folder_uuid}/files
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/group/{group_uuid}/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/logins
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/mailboxes/message/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/new-business-event
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/plans/{plan_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/plans/{plan_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v2/shareholder
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/account/{account_uuid}/check
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/account/{account_uuid}/login/{login_uuid}/expire
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/account/{account_uuid}/login/{login_uuid}/make-primary
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/bank-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/bank-transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/file/direct-upload
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/firm/{firm_uuid}/branding
  • Response
  • 200 response Modified
    • application/json content type Modified
      • brand_colours property Modified
        • portal_sidebar_user_select_background, portal_sidebar_user_select_hover, portal_sidebar_user_select_text, portal_sidebar_user_select_text_hover, portal_sidebar_user_select_border, portal_sidebar_user_select_border_hover properties Added
POST /api/v1/firm/{firm_uuid}/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • brand_colours property Modified
        • portal_sidebar_user_select_background, portal_sidebar_user_select_hover, portal_sidebar_user_select_text, portal_sidebar_user_select_text_hover, portal_sidebar_user_select_border, portal_sidebar_user_select_border_hover properties Added
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/provider-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/statement-transaction/{statementTransaction_uuid}/unreconcile-expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v2/shareholder
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/file/{file_uuid}/copy
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • brand_colours property Modified
        • portal_sidebar_user_select_background, portal_sidebar_user_select_hover, portal_sidebar_user_select_text, portal_sidebar_user_select_text_hover, portal_sidebar_user_select_border, portal_sidebar_user_select_border_hover properties Added
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
v1.27.1
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /api/v1/client/{client_uuid}/owners
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • title, name_with_title, gender, ni_number, date_of_birth, nickname, target_retirement_age, pronouns, smoker_status, residential_status, country_of_residence, marital_status, is_vulnerable, is_uk_resident, is_uk_domicile, expected_retirement_age, state_retirement_age, nationalities, third_party_offered, procedure_adaptation, cigarettes_daily, smoker_since, last_used_nicotine_products_date, long_term_care_needed, has_will, will_notes, will_last_reviewed, has_power_of_attorney properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • type, role, photo_url, firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, groups, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account, can_be_deleted, joint_account_circle, circles, ownership_percentage, inactive_at, custom_fields, external_references properties Added
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • title, name_with_title, gender, ni_number, date_of_birth, nickname, target_retirement_age, pronouns, smoker_status, residential_status, country_of_residence, marital_status, is_vulnerable, is_uk_resident, is_uk_domicile, expected_retirement_age, state_retirement_age, nationalities, third_party_offered, procedure_adaptation, cigarettes_daily, smoker_since, last_used_nicotine_products_date, long_term_care_needed, has_will, will_notes, will_last_reviewed, has_power_of_attorney properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • type, role, photo_url, firm, primary_phone_number, primary_email, current_time_entry, assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, groups, tags, owners, first_contact_date, next_review_date, previous_review_date, anniversary_review_date, with_login, has_joint_account, can_be_deleted, joint_account_circle, circles, ownership_percentage, inactive_at, custom_fields, external_references properties Added
v1.27.0
5 structure changes including:
2 Additions
3 Modifications
Modified 3
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}/executions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • next_step, previous_step properties Added
GET /api/v1/automation-executions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • next_step, previous_step properties Added
  • Query
  • filter[client_uuids] query parameter Added
GET /api/v1/automation-executions/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • next_step, previous_step properties Added
Added 2
POST /api/v1/automation-step/{automationStep_uuid}/start
POST /api/v1/automation-step/{automationStep_uuid}/stop
v1.25.0
3 structure changes including:
1 Addition
2 Modifications
Modified 2 Breaking
GET /api/v1/file/bin
  • Response
  • 401 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
PUT /api/v1/file/{file_uuid}/copy
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
    • folder property Modified
      • Property is now required
        Breaking
Added 1
GET /api/v1/file/{file_uuid}/download/temporary-url