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

about 7 hours ago

main
v1.103.2
Compare
v1.103.2

API structure has changed

5 structure changes including:
5 Modifications
Modified 5 Breaking
POST /api/v1/account
  • Body
  • application/json content type Modified
    • alternative Modified
      • Create Client Account alternative Modified
        • type, role, first_name, last_name, business_details properties Modified
          • Properties are now required
            Breaking
      • Create Employee Account alternative Modified
        • type, role, first_name, last_name, send_welcome_email, departments properties Modified
          • Properties are now required
            Breaking
      • Create Introducer Account alternative Modified
        • type, role, first_name, last_name, entity_name properties Modified
          • Properties are now required
            Breaking
POST /api/v1/addons/smartsearch/ukaml/{client_uuid}/run
  • Body
  • application/json content type Modified
    • attributes property Modified
      • bank, addresses properties Modified
        • Properties are now required
          Breaking
POST /api/v1/addons/transact/account-opening
  • Body
  • application/json content type Modified
    • bank_account property Modified
      • sort_code, account_number, account_name_or_roll_number properties Modified
        • Properties are now required
          Breaking
PUT /api/v1/account/{uuid}
  • Body
  • application/json content type Modified
    • alternative Modified
      • Update Client Account alternative Modified
        • business_details property Modified
          • Property is now required
            Breaking
          • Type went from array to object
            Breaking
        • business_details.status, business_details.status_comments, business_details.type, business_details.type_comments, business_details.incorporated_on, business_details.business_registered_address, business_details.business_registered_address.uuid, business_details.business_registered_address.name, business_details.business_registered_address.address_1, business_details.business_registered_address.address_2, business_details.business_registered_address.address_3, business_details.business_registered_address.address_4, business_details.business_registered_address.town_city, business_details.business_registered_address.county, business_details.business_registered_address.postcode, business_details.business_registered_address.country, business_details.nature, business_details.uk_sic_code, business_details.companies_house_number, business_details.year_end_day, business_details.year_end_month, business_details.firm_website, business_details.employee_count, business_details.self_employed_staff_count, business_details.business_value, business_details.is_registered_vat, business_details.vat_number, business_details.accountant_company, business_details.accountant_name, business_details.business_accountant_address, business_details.business_accountant_address.uuid, business_details.business_accountant_address.name, business_details.business_accountant_address.address_1, business_details.business_accountant_address.address_2, business_details.business_accountant_address.address_3, business_details.business_accountant_address.address_4, business_details.business_accountant_address.town_city, business_details.business_accountant_address.county, business_details.business_accountant_address.postcode, business_details.business_accountant_address.country, business_details.legal_adviser_name, business_details.business_legal_adviser_address, business_details.business_legal_adviser_address.uuid, business_details.business_legal_adviser_address.name, business_details.business_legal_adviser_address.address_1, business_details.business_legal_adviser_address.address_2, business_details.business_legal_adviser_address.address_3, business_details.business_legal_adviser_address.address_4, business_details.business_legal_adviser_address.town_city, business_details.business_legal_adviser_address.county, business_details.business_legal_adviser_address.postcode, business_details.business_legal_adviser_address.country, business_details.auditor_name, business_details.business_auditor_address, business_details.business_auditor_address.uuid, business_details.business_auditor_address.name, business_details.business_auditor_address.address_1, business_details.business_auditor_address.address_2, business_details.business_auditor_address.address_3, business_details.business_auditor_address.address_4, business_details.business_auditor_address.town_city, business_details.business_auditor_address.county, business_details.business_auditor_address.postcode, business_details.business_auditor_address.country, business_details.data_protection_officer, business_details.primary_contacts, business_details.primary_contacts.*.uuid, business_details.primary_contacts.*.name, business_details.primary_contacts.*.email, business_details.primary_contacts.*.address, business_details.primary_contacts.*.address.uuid, business_details.primary_contacts.*.address.name, business_details.primary_contacts.*.address.address_1, business_details.primary_contacts.*.address.address_2, business_details.primary_contacts.*.address.address_3, business_details.primary_contacts.*.address.address_4, business_details.primary_contacts.*.address.town_city, business_details.primary_contacts.*.address.county, business_details.primary_contacts.*.address.postcode, business_details.primary_contacts.*.address.country properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps/{blueprintStep_uuid}
  • Body
  • application/json content type Modified
    • configuration property Modified
      • params property Modified
        • Property is now required
          Breaking