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

21 days ago

main
v1.67.0
Compare
v1.67.0

API structure has changed

43 structure changes including:
43 Modifications
Modified 43 Breaking
POST /api/v1/account/{account_uuid}/login
  • Body
  • application/json content type Modified
    • has_write_permission, has_delete_permission, receives_unread_notifications_email properties Modified
      • Type went from string to boolean
        Breaking
POST /api/v1/bulk-actions/execute
  • Body
  • application/json content type Modified
    • filters property Modified
      • Type went from array to object
        Breaking
      • taskable_uuid, taskable_type properties Added
    • data property Modified
      • Type went from array to object
        Breaking
    • name property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • type property Added
POST /api/v1/client/{client_uuid}/employment
  • Body
  • application/json content type Modified
    • address property Modified
      • name, move_in_date, moved_in_month, moved_in_year, moved_out_month, moved_out_year, residential_status, residential_status_other properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
    • turnover_history property Modified
      • Type went from array to array[object]
      • object property Added
POST /api/v1/client/{client_uuid}/goal
  • Body
  • application/json content type Modified
    • progress property Modified
      • Type went from integer to number(float)
        Breaking
POST /api/v1/conversation/{conversation_uuid}/messages
  • Body
  • application/json content type Modified
    • files property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/conversation/{conversation_uuid}/messages/inline
  • Body
  • application/json content type Modified
    • files property Modified
      • Type went from array<file> to array[string(binary)]
        Breaking
POST /api/v1/custom-default-folder
  • Body
  • application/json content type Modified
    • structure property Modified
      • Property is no longer required
      • Type went from array to array[object]
      • DefaultFoldersStructure property Added
POST /api/v1/document
  • Body
  • application/json content type Modified
    • client_uuids property Modified
      • Type went from array to array[string(uuid)]
    • known_dependants property Modified
      • Type went from array to object
        Breaking
POST /api/v1/document-signing
  • Body
  • application/json content type Modified
    • participant_uuids, document_template_uuids properties Modified
      • Type went from array to array[string(uuid)]
    • document_template_dependants property Modified
      • Type went from array to object
        Breaking
POST /api/v1/document-template/{documentTemplate_uuid}/content/docx
  • Body
  • application/json content type Modified
    • file property Modified
      • Type went from uploaded-file to string(binary)
        Breaking
POST /api/v1/document/{document_uuid}/content/docx
  • Body
  • application/json content type Modified
    • file property Modified
      • Type went from uploaded-file to string(binary)
        Breaking
POST /api/v1/employee
  • Body
  • application/json content type Modified
    • groups property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/expenditure-structure/field/reorder
  • Body
  • application/json content type Modified
    • order property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/expenditure-structure/section/reorder
  • Body
  • application/json content type Modified
    • order property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/expenditure-structure/section/set-custom-expenditure
  • Body
  • application/json content type Modified
    • section_uuids property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/fact-find/request/{factFindRequest_uuid}/create-account
  • Body
  • application/json content type Added
POST /api/v1/file
  • Body
  • application/json content type Modified
    • files property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/file/direct-upload
  • Body
  • application/json content type Modified
    • file property Modified
      • Type went from multipart-file to string(binary)
        Breaking
POST /api/v1/folder/{folder_uuid}/permissions
  • Body
  • application/json content type Modified
    • participants property Modified
      • Type went from array to array[object]
      • object property Added
POST /api/v1/form
  • Body
  • application/json content type Modified
    • allowed_hosts property Modified
      • Type went from array to array[string(hostname)]
POST /api/v1/form/{form_uuid}/submission/{submission_uuid}/answer
  • Body
  • application/json content type Modified
    • answers property Modified
      • Type went from array to object
        Breaking
POST /api/v1/illustration
  • Body
  • application/json content type Modified
    • accounts property Modified
      • Type went from array to array[string(uuid)]
    • request_data property Modified
      • Type went from array to object
        Breaking
POST /api/v1/import
  • Body
  • application/json content type Modified
    • file property Modified
      • Type went from file to string(binary)
        Breaking
POST /api/v1/import/map/{import_uuid}
  • Body
  • application/json content type Modified
    • headers property Modified
      • Type went from array to object
        Breaking
POST /api/v1/introducer
  • Body
  • application/json content type Modified
    • groups property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/life-stage/reorder
  • Body
  • application/json content type Modified
    • order property Modified
      • Type went from array to array[string(uuid)]
POST /api/v1/report-template
  • Body
  • application/json content type Modified
    • report_query property Modified
      • Type went from array to object
        Breaking
POST /api/v1/upload-files/create
  • Body
  • application/json content type Added
POST /api/v2/shareholder
  • Body
  • application/json content type Modified
    • ownership_percentage property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • percentage property Added
POST /api/v2/webhook-subscriptions
  • Body
  • application/json content type Modified
    • events property Modified
      • Type went from array to array[string]
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Body
  • application/json content type Modified
    • primary, has_delete_permission properties Modified
      • Type went from string to boolean
        Breaking
PUT /api/v1/client/{client_uuid}/employment/{uuid}
  • Body
  • application/json content type Modified
    • address property Modified
      • Type went from array to object
        Breaking
      • address_1, address_2, address_3, address_4, town_city, county, postcode, country properties Added
    • turnover_history property Modified
      • Type went from array to array[object]
      • object property Added
PUT /api/v1/client/{client_uuid}/goal/{uuid}
  • Body
  • application/json content type Modified
    • progress property Modified
      • Type went from integer to number(float)
        Breaking
PUT /api/v1/custom-default-folder/{customDefaultFolder_uuid}
  • Body
  • application/json content type Modified
    • structure property Modified
      • Property is no longer required
      • Type went from array to array[object]
PUT /api/v1/document/{uuid}
  • Body
  • application/json content type Modified
    • client_uuids property Modified
      • Type went from array to array[string(uuid)]
    • known_dependants property Modified
      • Type went from array to object
        Breaking
PUT /api/v1/employee/{uuid}
  • Body
  • application/json content type Modified
    • groups property Modified
      • Type went from array to array[string(uuid)]
PUT /api/v1/firm/{uuid}
  • Body
  • application/json content type Modified
    • ip_whitelist property Modified
      • Type went from array to array[string(ipv4)]
    • cc_email_addresses, bcc_email_addresses properties Modified
      • Type went from array to array[string(email)]
PUT /api/v1/form/{form_uuid}/question/{uuid}
  • Body
  • application/json content type Modified
    • selection_options property Modified
      • Type went from array to array[string]
PUT /api/v1/form/{uuid}
  • Body
  • application/json content type Modified
    • allowed_hosts property Modified
      • Type went from array to array[string(hostname)]
PUT /api/v1/illustration/{uuid}
  • Body
  • application/json content type Modified
    • request_data property Modified
      • Type went from array to object
        Breaking
PUT /api/v1/introducer/{uuid}
  • Body
  • application/json content type Modified
    • groups property Modified
      • Type went from array to array[string(uuid)]
PUT /api/v1/report-template/{reportTemplate_uuid}
  • Body
  • application/json content type Modified
    • report_query property Modified
      • Type went from array to object
        Breaking
PUT /api/v2/webhook-subscriptions/{uuid}
  • Body
  • application/json content type Modified
    • events property Modified
      • Type went from array to array[string]