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

17 days ago

main
v1.66.2
Compare
v1.66.2

API structure has changed

14 structure changes including:
14 Modifications
Modified 14 Breaking
DELETE /api/v1/group/{group_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[string(uuid)]
DELETE /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/addons/seccl/{addon}/associate-node
  • Body
  • application/json content type Modified
    • associations property Modified
      • Type went from array to array[object]
      • object property Added
POST /api/v1/addons/smartsearch/ukaml/{client_uuid}/run
  • Body
  • application/json content type Modified
    • attributes property Modified
      • Type went from array to object
        Breaking
      • bank, addresses, documents properties Added
    • attributes.bank, attributes.bank.account_type, attributes.bank.sortcode, attributes.bank.account_number, attributes.bank.roll_number, attributes.addresses, attributes.addresses.*.flat, attributes.addresses.*.building, attributes.addresses.*.street_1, attributes.addresses.*.street_2, attributes.addresses.*.town, attributes.addresses.*.region, attributes.addresses.*.postcode, attributes.addresses.*.duration, attributes.documents, attributes.documents.national_insurance, attributes.passport, attributes.documents.passport.country, attributes.documents.passport.expiry, attributes.documents.passport.mrz_line_2, attributes.documents.driving_licence, attributes.documents.driving_licence.number properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /api/v1/addons/transact/account-opening
  • Body
  • application/json content type Modified
    • investors property Modified
      • Type went from array to array[object]
      • object property Added
    • bank_account property Modified
      • Type went from array to object
        Breaking
      • sort_code, account_number, account_name_or_roll_number, is_building_society properties Added
POST /api/v1/group
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/group/{group_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/subscribe
  • Body
  • application/json content type Modified
    • config property Modified
      • Type went from array to object
        Breaking
POST /api/v1/workflow/{workflow_uuid}/task
  • Body
  • application/json content type Modified
    • participants, groups properties Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/participants
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[string(uuid)]
PUT /api/v1/addon-subscriptions/{addonSubscription_uuid}
  • Body
  • application/json content type Modified
    • config property Modified
      • Type went from array to object
        Breaking
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Body
  • application/json content type Modified
    • conditions property Modified
      • Type went from array to array[object]
      • object property Added
    • configuration property Modified
      • Type went from array to object
        Breaking
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps/{blueprintStep_uuid}
  • Body
  • application/json content type Modified
    • configuration property Modified
      • Type went from array to object
        Breaking
      • params property Added
PUT /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}
  • Body
  • application/json content type Modified
    • participants, groups properties Modified
      • Type went from array to array[string(uuid)]