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 1 hour ago

main
v1.132.3
Compare
v1.132.3

API structure has changed

Next change
422 structure changes including:
422 Modifications
Modified 422 Breaking
DELETE /api/v1/cases/{case_uuid}/participants
  • Response
  • 422 response Added
DELETE /api/v1/conversation/{conversation_uuid}/admin
  • Response
  • 422 response Added
DELETE /api/v1/conversation/{conversation_uuid}/participants
  • Response
  • 422 response Added
DELETE /api/v1/group/{group_uuid}/participants
  • Response
  • 422 response Added
DELETE /api/v1/mobile/notification-token
  • Response
  • 422 response Added
DELETE /api/v1/personal-access-tokens/{id}
  • Response
  • 422 response Added
DELETE /api/v1/plans/{plan_uuid}/beneficiary/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
DELETE /api/v1/plans/{plan_uuid}/claim/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
DELETE /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
DELETE /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, paid_at, value properties Removed
      • message property Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, fund_name, reference, sector, sedol, isin, citi, units, unit_price, unit_price_raw, purchase_price, is_active, value, sub_account, external_references properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, withdrawn_at, value properties Removed
      • message property Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
DELETE /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
DELETE /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
DELETE /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/participants
  • Response
  • 422 response Added
GET /api/v1/addons/be-iq/client/{client_uuid}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/addons/be-iq/token
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/addons/mortgagebrain/ready
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/addons/seccl/{addon}/client-products/{account_uuid}
  • Response
  • 422 response Added
GET /api/v1/addons/seccl/{addon}/client/{account_uuid}/bank-details/status
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/addons/seccl/{addon}/client/{id}
  • Response
  • 422 response Added
GET /api/v1/addons/seccl/{addon}/direct-debit-mandate
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/addons/seccl/{addon}/search-assets
  • Response
  • 422 response Added
GET /api/v1/addons/transact/advisers
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/bank-transaction
  • Response
  • 422 response Added
GET /api/v1/business-units/{business_unit_uuid}/branding
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/business-units/{business_unit_uuid}/members
  • Response
  • 422 response Added
GET /api/v1/charge
  • Response
  • 422 response Added
GET /api/v1/charge/{uuid}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/circles/{circle_uuid}/charges
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/circles/{circle_uuid}/emails
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
GET /api/v1/circles/{circle_uuid}/expectations
  • Response
  • 422 response Added
GET /api/v1/circles/{circle_uuid}/fact-find-access
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/circles/{circle_uuid}/wealth
  • Response
  • 422 response Added
GET /api/v1/client
  • Response
  • 422 response Added
GET /api/v1/client/{client_uuid}/charges
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/client/{client_uuid}/emails
  • Response
  • 422 response Added
GET /api/v1/client/{client_uuid}/expectations
  • Response
  • 422 response Added
GET /api/v1/client/{client_uuid}/potential-duplicates
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/client/{client_uuid}/wealth
  • Response
  • 422 response Added
GET /api/v1/document-template/{documentTemplate_uuid}/content/docx
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/document-template/{documentTemplate_uuid}/content/pdf
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/document-template/{documentTemplate_uuid}/content/preview
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/document-template/{documentTemplate_uuid}/content/sfdt
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/expectation
  • Response
  • 422 response Added
GET /api/v1/file/{file_uuid}/download
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/file/{file_uuid}/download/temporary-url
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/files/{model}/{modelUuid}
  • Response
  • 422 response Added
GET /api/v1/firm
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/group
  • Response
  • 422 response Added
GET /api/v1/import/keys/{importer}/{mode}
  • Response
  • 422 response Added
GET /api/v1/import/modes/{importer}
  • Response
  • 422 response Added
GET /api/v1/logs/{modelType}/{modelUuid}
  • Response
  • 422 response Added
GET /api/v1/mailboxes/{mailbox_uuid}/folders
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/mailboxes/{mailbox_uuid}/reauthenticate
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/metrics/aum
  • Response
  • 422 response Added
GET /api/v1/metrics/cases
  • Response
  • 422 response Added
GET /api/v1/metrics/cases/completed
  • Response
  • 422 response Added
GET /api/v1/metrics/clients
  • Response
  • 422 response Added
GET /api/v1/metrics/conversations
  • Response
  • 422 response Added
GET /api/v1/metrics/documents/generated
  • Response
  • 422 response Added
GET /api/v1/metrics/fact-finds/sent
  • Response
  • 422 response Added
GET /api/v1/metrics/files/uploaded
  • Response
  • 422 response Added
GET /api/v1/metrics/introducers
  • Response
  • 422 response Added
GET /api/v1/metrics/messages/sent
  • Response
  • 422 response Added
GET /api/v1/metrics/plans
  • Response
  • 422 response Added
GET /api/v1/metrics/signatures
  • Response
  • 422 response Added
GET /api/v1/metrics/tasks
  • Response
  • 422 response Added
GET /api/v1/metrics/tasks/completed
  • Response
  • 422 response Added
GET /api/v1/metrics/time-logged
  • Response
  • 422 response Added
GET /api/v1/migrate-joint-logins
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/navigator/{modelType}/{modelUuid}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/note/{uuid}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/personal-access-tokens
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/plans/{plan_uuid}/charges
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/plans/{plan_uuid}/expectations
  • Response
  • 422 response Added
GET /api/v1/plans/{plan_uuid}/reporting/valuations/{subAccount}
  • Response
  • 422 response Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/portal-engagement/summary
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
GET /api/v1/referral-connections
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/referrals
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/search
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
GET /api/v1/state
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/statement-transaction
  • Response
  • 422 response Added
GET /api/v1/static/cover-types/{type}
  • Response
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/static/transaction-sub-types/{transactionType}
  • Response
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/task
  • Response
  • 422 response Added
GET /api/v1/time-entry/{trackable_type}/{trackable_uuid}
  • Response
  • 422 response Added
GET /api/v1/workflow/{workflow_uuid}/task
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v2/circles/{circle_uuid}/expenditures
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v2/circles/{circle_uuid}/expenditures/{expenditure_uuid}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v2/direct-debit-mandates/{direct_debit_mandate_uuid}/view
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v2/fact-find/blocks/default
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
GET /api/v2/flux
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
GET /api/v2/networth/line-graph
  • Response
  • 422 response Added
GET /api/v2/plans
  • Response
  • 422 response Added
GET /api/v2/plans/line-graph
  • Response
  • 422 response Added
GET /api/v2/plans/{plan_uuid}/returns
  • Response
  • 422 response Added
GET /api/v2/portal/actions
  • Response
  • 422 response Added
PATCH /api/v1/addons/seccl/{addon}/client/{account_uuid}
  • Response
  • 422 response Added
PATCH /api/v1/checklist-item/{checklistItem_uuid}
  • Response
  • 422 response Added
PATCH /api/v1/checklist/{uuid}
  • Response
  • 422 response Added
PATCH /api/v1/task/{task_uuid}/complete
  • Response
  • 422 response Added
PATCH /api/v1/task/{task_uuid}/uncomplete/{taskStatus}
  • Response
  • 422 response Added
POST /api/v1/account
  • Response
  • 422 response Added
POST /api/v1/account/check-duplicates
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/account/{account_uuid}/address
  • Response
  • 422 response Added
POST /api/v1/account/{account_uuid}/check
  • Response
  • 422 response Added
POST /api/v1/account/{account_uuid}/contact-detail
  • Response
  • 422 response Added
POST /api/v1/account/{account_uuid}/login
  • Response
  • 422 response Added
POST /api/v1/addons/be-iq/profiler/invite
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/addons/conquest/client/{client}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/addons/mortgagebrain/mortgage-search
  • Response
  • 422 response Added
POST /api/v1/addons/nucleus/sync-clients
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/addons/nucleus/sync-plans
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/addons/pensionlab/launch-widget
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/addons/seccl/{addon}/associate-node
  • Response
  • 422 response Added
POST /api/v1/addons/seccl/{addon}/client
  • Response
  • 422 response Added
POST /api/v1/addons/seccl/{addon}/client/{account_uuid}/bank-details
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/addons/seccl/{addon}/client/{account_uuid}/direct-debit-mandate/portal-completion
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/addons/seccl/{addon}/client/{account_uuid}/products/{clientProductId}/accept
  • Response
  • 422 response Added
POST /api/v1/addons/seccl/{addon}/direct-debit-mandate
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/addons/seccl/{addon}/sync-client/{account_uuid}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/addons/seccl/{addon}/sync-clients
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/addons/seccl/{addon}/sync-plan/{plan_uuid}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/addons/seccl/{addon}/sync-plans
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/addons/smartsearch/ukaml/{client_uuid}/run
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/addons/transact/account-opening
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/adviser-split
  • Response
  • 422 response Added
POST /api/v1/automation-blueprints
  • Response
  • 422 response Added
POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps
  • Response
  • 422 response Added
POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/trigger
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/bank-statement
  • Response
  • 422 response Added
POST /api/v1/bank-statement/upload
  • Response
  • 422 response Added
POST /api/v1/bank-transaction
  • Response
  • 422 response Added
POST /api/v1/bank-transaction/reconcile
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/bulk-actions/execute
  • Response
  • 422 response Added
POST /api/v1/business-units
  • Response
  • 422 response Added
POST /api/v1/business-units/{business_unit_uuid}/members/{action}
  • Response
  • 422 response Added
POST /api/v1/cases
  • Response
  • 422 response Added
POST /api/v1/cases-status
  • Response
  • 422 response Added
POST /api/v1/cases-type
  • Response
  • 422 response Added
POST /api/v1/cases/{case_uuid}/participants
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/charge
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/charge-split
  • Response
  • 422 response Added
POST /api/v1/charge-split-schema
  • Response
  • 422 response Added
POST /api/v1/checklist/{checklist_uuid}/items
  • Response
  • 422 response Added
POST /api/v1/circles
  • Response
  • 422 response Added
POST /api/v1/client
  • Response
  • 422 response Added
POST /api/v1/client-status
  • Response
  • 422 response Added
POST /api/v1/client-status/{clientStatus}/transfer-clients
  • Response
  • 422 response Added
POST /api/v1/client/{client_uuid}/dependant
  • Response
  • 422 response Added
POST /api/v1/client/{client_uuid}/employment
  • Response
  • 422 response Added
POST /api/v1/client/{client_uuid}/expenditure/sync-to-circle
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/custom
  • Response
  • 422 response Added
POST /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/custom/{expenditure_uuid}
  • Response
  • 422 response Added
POST /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/{lifeStageField_uuid}
  • Response
  • 422 response Added
POST /api/v1/client/{client_uuid}/goal
  • Response
  • 422 response Added
POST /api/v1/client/{client_uuid}/income
  • Response
  • 422 response Added
POST /api/v1/client/{client_uuid}/linked-clients
  • Response
  • 422 response Added
POST /api/v1/client/{client_uuid}/owners
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/client/{client_uuid}/potential-duplicates/dismiss
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/client/{client_uuid}/risk
  • Response
  • 422 response Added
POST /api/v1/client/{client_uuid}/staff-members
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/clone/{modelType}/{modelUuid}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/conversation
  • Response
  • 422 response Added
POST /api/v1/conversation/inline
  • Response
  • 422 response Added
POST /api/v1/conversation/{conversation_uuid}/admin
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/conversation/{conversation_uuid}/archive
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/conversation/{conversation_uuid}/messages
  • Response
  • 422 response Added
POST /api/v1/conversation/{conversation_uuid}/messages/inline
  • Response
  • 422 response Added
POST /api/v1/conversation/{conversation_uuid}/notifications
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/conversation/{conversation_uuid}/participants
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/conversation/{conversation_uuid}/pin
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/conversation/{conversation_uuid}/unarchive
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/custom-default-folder
  • Response
  • 422 response Added
POST /api/v1/custom-field
  • Response
  • 422 response Added
POST /api/v1/document
  • Response
  • 422 response Added
POST /api/v1/document-pack/document-pack
  • Response
  • 422 response Added
POST /api/v1/document-signing
  • Response
  • 422 response Added
POST /api/v1/document-template
  • Response
  • 422 response Added
POST /api/v1/document-template/{documentTemplate_uuid}/content/docx
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/document/{document_uuid}/content/docx
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/employee
  • Response
  • 422 response Added
POST /api/v1/expectation/balance
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/expectation/calculate
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/expectation/reconcile
  • Response
  • 422 response Added
POST /api/v1/expectation/unbalance
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/expenditure-structure/field
  • Response
  • 422 response Added
POST /api/v1/expenditure-structure/field/reorder
  • Response
  • 422 response Added
POST /api/v1/expenditure-structure/section
  • Response
  • 422 response Added
POST /api/v1/expenditure-structure/section/reorder
  • Response
  • 422 response Added
POST /api/v1/expenditure-structure/section/set-custom-expenditure
  • Response
  • 422 response Added
POST /api/v1/fact-find/request
  • Response
  • 422 response Added
POST /api/v1/fact-find/request/{factFindRequest_uuid}/complete
  • Response
  • 422 response Added
POST /api/v1/fact-find/request/{factFindRequest_uuid}/create-account
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
  • 422 response Added
POST /api/v1/fact-find/request/{factFindRequest_uuid}/section/{factFindSchemaSection_uuid}/progress
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
  • 422 response Added
POST /api/v1/fact-find/schema
  • Response
  • 422 response Added
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/generate-pdf
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
  • 422 response Added
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/section
  • Response
  • 422 response Added
POST /api/v1/file
  • Response
  • 422 response Added
POST /api/v1/file/create-file-record
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/file/direct-upload
  • Response
  • 422 response Added
POST /api/v1/firm/{firm_uuid}/branding
  • Response
  • 422 response Added
POST /api/v1/firm/{firm_uuid}/settings
  • Response
  • 422 response Added
POST /api/v1/firm/{firm}/fca
  • Response
  • 422 response Added
POST /api/v1/folder
  • Response
  • 422 response Added
POST /api/v1/folder/{folder_uuid}/permissions
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/form
  • Response
  • 422 response Added
POST /api/v1/form/{form_uuid}/question
  • Response
  • 422 response Added
POST /api/v1/form/{form_uuid}/section
  • Response
  • 422 response Added
POST /api/v1/form/{form_uuid}/submission
  • Response
  • 422 response Added
POST /api/v1/form/{form_uuid}/submission-request/{account_uuid}
  • Response
  • 422 response Added
POST /api/v1/form/{form_uuid}/submission/{submission_uuid}/answer
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/form/{form_uuid}/submission/{submission_uuid}/submit
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/form/{form_uuid}/unpublish
  • Response
  • 422 response Added
POST /api/v1/group
  • Response
  • 422 response Added
POST /api/v1/group/{group_uuid}/participants
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/illustration
  • Response
  • 422 response Added
POST /api/v1/illustration/{illustration_uuid}/proceed
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/import
  • Response
  • 422 response Added
POST /api/v1/import/map/{import_uuid}
  • Response
  • 422 response Added
POST /api/v1/integrations/{passportClient_id}/revoke
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/introducer
  • Response
  • 422 response Added
POST /api/v1/life-stage
  • Response
  • 422 response Added
POST /api/v1/life-stage/reorder
  • Response
  • 422 response Added
POST /api/v1/loa
  • Response
  • 422 response Added
POST /api/v1/mailboxes
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/me/switch-account
  • Response
  • 422 response Added
POST /api/v1/migrate-joint-documents-to-circle
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/migrate-joint-logins/{jointAccountLogin_uuid}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/mobile/notification-token
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/my/welcome-widget-tasks/{id}
  • Response
  • 422 response Added
POST /api/v1/new-business-event
  • Response
  • 422 response Added
POST /api/v1/note
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/note/{notableType}/{notableUuid}/mentions
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/notifications/read-all
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/notifications/read/{notification_id}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/notifications/subscribe/{subscribeableType}/{subscribeableUuid}
  • Response
  • 422 response Added
POST /api/v1/notifications/unread/{notification_id}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/notifications/unsubscribe/{subscribeableType}/{subscribeableUuid}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/personal-access-tokens
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/plans
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/plans/{plan_uuid}/beneficiary
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, name, percentage, cover properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
POST /api/v1/plans/{plan_uuid}/claim
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, claim_amount, claim_start_date, claim_end_date, claim_notes, client properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
POST /api/v1/plans/{plan_uuid}/cover
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, cover_type, benefit_amount, benefit_frequency, benefit_status, excess, indexation, client properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, opened_at, name, type, sub_type, abstract_type, policy_number, proposal_reference, status, inactive_at, inactive_reason, agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, shown_on_circles, review_date, on_panel, is_group_scheme, is_sub_group_scheme, is_group_scheme_member, advice_area, main_account, sub_accounts, provider, covers, claims, total_benefit_amount, total_benefits, latest_valuations, value, valued_at, original_valued_at, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, statistics, cases, tags, is_wrap_product, is_wrap_child, wrap, wrap_children, linked_policy_numbers, can_be_deleted, contract_enquiry_account, custom_fields, external_references, group_scheme, group_scheme_member_detail properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
POST /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, transfer_type, date_of_transfer_valuation, date_advice_given, premium, premium_monthly, premium_annually, total_premium_to_date, amount, percentage, frequency, source, payment_method, start_date, end_date, pensionable_salary, details, created_by, plan, transferred_from_plan, transferred_from_plan_type, transferred_from_plan_sub_type properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
POST /api/v1/plans/{plan_uuid}/provider-feed-sync
  • Response
  • 409 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/plans/{plan_uuid}/sub-accounts
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, paid_at, value properties Removed
      • message property Added
  • 422 response Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, fund_name, reference, sector, sedol, isin, citi, units, unit_price, unit_price_raw, purchase_price, is_active, value, sub_account, external_references properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, is_proposed, proposed_at, name properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/sync-holdings
  • Response
  • 409 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 409 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, withdrawn_at, value properties Removed
      • message property Added
  • 422 response Added
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, opened_at, name, type, sub_type, abstract_type, policy_number, proposal_reference, status, inactive_at, inactive_reason, agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, shown_on_circles, review_date, on_panel, is_group_scheme, is_sub_group_scheme, is_group_scheme_member, advice_area, main_account, sub_accounts, provider, covers, claims, total_benefit_amount, total_benefits, latest_valuations, value, valued_at, original_valued_at, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, statistics, cases, tags, is_wrap_product, is_wrap_child, wrap, wrap_children, linked_policy_numbers, can_be_deleted, contract_enquiry_account, custom_fields, external_references, group_scheme properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
POST /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, plan, sub_account, holding, account, transaction_schedule, provider, type, sub_type, amount, date, notes, status, editable properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
POST /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, plan, sub_account, holding, account, provider, provider_controlled, type, sub_type, amount, frequency, start_date, end_date, next_transaction_date, paused_until properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
POST /api/v1/postcode/search
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/provider-statement
  • Response
  • 422 response Added
POST /api/v1/provider-statement/import
  • Response
  • 422 response Added
POST /api/v1/provider-statement/upload
  • Response
  • 422 response Added
POST /api/v1/reaction
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/referral-connections
  • Response
  • 422 response Added
POST /api/v1/referrals
  • Response
  • 422 response Added
POST /api/v1/referrals/{referral_uuid}/reject
  • Response
  • 422 response Added
POST /api/v1/report
  • Response
  • 422 response Added
POST /api/v1/report-template
  • Response
  • 422 response Added
POST /api/v1/service-level
  • Response
  • 422 response Added
POST /api/v1/statement-transaction
  • Response
  • 422 response Added
POST /api/v1/statement-transaction/auto-reconcile
  • Response
  • 422 response Added
POST /api/v1/statement-transaction/create-expectations
  • Response
  • 422 response Added
POST /api/v1/subscribe
  • Response
  • 422 response Added
POST /api/v1/tag
  • Response
  • 422 response Added
POST /api/v1/task
  • Response
  • 422 response Added
POST /api/v1/task-status
  • Response
  • 422 response Added
POST /api/v1/task/{task_uuid}/checklists
  • Response
  • 422 response Added
POST /api/v1/time-entry
  • Response
  • 422 response Added
POST /api/v1/unipass/certificate
  • Response
  • 422 response Added
POST /api/v1/upload-files
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/upload-files/create
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/webhooks/{webhookTarget_uuid}
  • Response
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
POST /api/v1/workflow
  • Response
  • 422 response Added
POST /api/v1/workflow/{workflow_uuid}/run
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/workflow/{workflow_uuid}/task
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/checklists
  • Response
  • 422 response Added
POST /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/participants
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v2/addresses
  • Response
  • 422 response Added
POST /api/v2/bank-accounts
  • Response
  • 422 response Added
POST /api/v2/circles/{circle_uuid}/expenditures/{lifeStage_uuid}/custom
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v2/circles/{circle_uuid}/expenditures/{lifeStage_uuid}/custom/{expenditure_uuid}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v2/circles/{circle_uuid}/expenditures/{lifeStage_uuid}/{lifeStageField_uuid}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v2/contact-details
  • Response
  • 422 response Added
POST /api/v2/dependants
  • Response
  • 422 response Added
POST /api/v2/employments
  • Response
  • 422 response Added
POST /api/v2/fact-find/blocks/reorder
  • Response
  • 422 response Added
POST /api/v2/fact-find/fact-find-questions/{fact_find_question_uuid}/factFindQuestionCondition
  • Response
  • 422 response Added
POST /api/v2/fact-find/questions/custom-field
  • Response
  • 422 response Added
POST /api/v2/fact-find/questions/reorder
  • Response
  • 422 response Added
POST /api/v2/fact-find/sections/reorder
  • Response
  • 422 response Added
POST /api/v2/fact-find/session
  • Response
  • 422 response Added
POST /api/v2/fact-find/templates
  • Response
  • 422 response Added
POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/clone
  • Response
  • 422 response Added
POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/generate-pdf
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/sections
  • Response
  • 422 response Added
POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/sections/{factFindSection_uuid}/blocks
  • Response
  • 422 response Added
POST /api/v2/goals
  • Response
  • 422 response Added
POST /api/v2/income
  • Response
  • 422 response Added
POST /api/v2/plans/{plan_uuid}/linked-policy-numbers
  • Response
  • 422 response Added
POST /api/v2/risks
  • Response
  • 422 response Added
POST /api/v2/shareholder
  • Response
  • 422 response Added
POST /api/v2/valuations/bulk
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
  • 422 response Added
POST /api/v2/webhook-subscriptions
  • Response
  • 422 response Added
POST /api/v2/webhook-subscriptions/calls/{outgoingWebhookCall_uuid}/retry
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is now required
          Breaking
PUT /api/v1/account/{account_uuid}/address/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/account/{account_uuid}/contact-detail/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/account/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/addon-subscriptions/{addonSubscription_uuid}
  • Response
  • 422 response Added
PUT /api/v1/adviser-split/{adviserSplit_uuid}
  • Response
  • 422 response Added
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Response
  • 422 response Added
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps/{blueprintStep_uuid}
  • Response
  • 422 response Added
PUT /api/v1/bank-statement/{bankStatement_uuid}
  • Response
  • 422 response Added
PUT /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 422 response Added
PUT /api/v1/business-units/{business_unit_uuid}/branding
  • Response
  • 422 response Added
PUT /api/v1/business-units/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/cases-status/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/cases-type/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/cases/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/charge-split-schema/{chargeSplitSchema_uuid}
  • Response
  • 422 response Added
PUT /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 422 response Added
PUT /api/v1/charge/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/circles/{circle_uuid}/fact-find-access
  • Response
  • 422 response Added
PUT /api/v1/circles/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/client-status/{clientStatus_uuid}
  • Response
  • 422 response Added
PUT /api/v1/client/{client_uuid}/dependant/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/client/{client_uuid}/employment/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/client/{client_uuid}/goal/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/client/{client_uuid}/income/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/client/{client_uuid}/linked-clients/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
  • Response
  • 422 response Added
PUT /api/v1/client/{client_uuid}/risk/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/client/{client_uuid}/staff-members/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/client/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/conversation/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/custom-default-folder/{customDefaultFolder_uuid}
  • Response
  • 422 response Added
PUT /api/v1/custom-field/{customField_uuid}
  • Response
  • 422 response Added
PUT /api/v1/document-pack/document-pack/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/document-template/{documentTemplate_uuid}
  • Response
  • 422 response Added
PUT /api/v1/document/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/employee/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/expectation/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/expenditure-structure/field/{lifeStageField_uuid}
  • Response
  • 422 response Added
PUT /api/v1/expenditure-structure/section/{lifeStageSection_uuid}
  • Response
  • 422 response Added
PUT /api/v1/fact-find/schema/{factFindSchema_uuid}
  • Response
  • 422 response Added
PUT /api/v1/fact-find/schema/{factFindSchema_uuid}/section/{factFindSchemaSection_uuid}
  • Response
  • 422 response Added
PUT /api/v1/file/{file_uuid}/copy
  • Response
  • 422 response Added
PUT /api/v1/file/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/firm/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/folder/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/form/{form_uuid}/question/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/form/{form_uuid}/section/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/form/{form_uuid}/submission-request/{submissionRequest_uuid}
  • Response
  • 422 response Added
PUT /api/v1/form/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/group/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/illustration/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/introducer/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/life-stage/{lifeStage_uuid}
  • Response
  • 422 response Added
PUT /api/v1/mailboxes/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/me
  • Response
  • 422 response Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 422 response Added
PUT /api/v1/note/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/oauth/connections/{oauthConnection_uuid}
  • Response
  • 422 response Added
PUT /api/v1/plans/{plan_uuid}/beneficiary/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, name, percentage, cover properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
PUT /api/v1/plans/{plan_uuid}/claim/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, claim_amount, claim_start_date, claim_end_date, claim_notes, client properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
PUT /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, cover_type, benefit_amount, benefit_frequency, benefit_status, excess, indexation, client properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
PUT /api/v1/plans/{plan_uuid}/ownership
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, opened_at, name, type, sub_type, abstract_type, policy_number, proposal_reference, status, inactive_at, inactive_reason, agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, shown_on_circles, review_date, on_panel, is_group_scheme, is_sub_group_scheme, is_group_scheme_member, advice_area, main_account, sub_accounts, provider, covers, claims, total_benefit_amount, total_benefits, latest_valuations, value, valued_at, original_valued_at, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, statistics, cases, tags, is_wrap_product, is_wrap_child, wrap, wrap_children, linked_policy_numbers, can_be_deleted, contract_enquiry_account, custom_fields, external_references properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, transfer_type, date_of_transfer_valuation, date_advice_given, premium, premium_monthly, premium_annually, total_premium_to_date, amount, percentage, frequency, source, payment_method, start_date, end_date, pensionable_salary, details, created_by, plan, transferred_from_plan, transferred_from_plan_type, transferred_from_plan_sub_type properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, paid_at, value properties Removed
      • message property Added
  • 422 response Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, fund_name, reference, sector, sedol, isin, citi, units, unit_price, unit_price_raw, purchase_price, is_active, value, sub_account, external_references properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/portfolios/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, is_proposed, proposed_at, name properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, valued_at, value, sub_account properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, withdrawn_at, value properties Removed
      • message property Added
  • 422 response Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, name, policy_number, latest_valuation, is_main_account, active_portfolio, statistics properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
PUT /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, plan, sub_account, holding, account, provider, provider_controlled, type, sub_type, amount, frequency, start_date, end_date, next_transaction_date, paused_until properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
PUT /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, plan, sub_account, holding, account, transaction_schedule, provider, type, sub_type, amount, date, notes, status, editable properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
PUT /api/v1/plans/{uuid}
  • Response
  • 409 response Modified
    • application/json content type Modified
      • uuid, created_at, updated_at, opened_at, name, type, sub_type, abstract_type, policy_number, proposal_reference, status, inactive_at, inactive_reason, agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, show_on_joint, shown_on_circles, review_date, on_panel, is_group_scheme, is_sub_group_scheme, is_group_scheme_member, advice_area, main_account, sub_accounts, provider, covers, claims, total_benefit_amount, total_benefits, latest_valuations, value, valued_at, original_valued_at, client, accounts, seller, linked_owners, linked_plans, visible_to_circles, statistics, cases, tags, is_wrap_product, is_wrap_child, wrap, wrap_children, linked_policy_numbers, can_be_deleted, contract_enquiry_account, custom_fields, external_references properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • message property Added
  • 422 response Added
PUT /api/v1/provider-statement/{providerStatement_uuid}
  • Response
  • 422 response Added
PUT /api/v1/report-template/{reportTemplate_uuid}
  • Response
  • 422 response Added
PUT /api/v1/service-level/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 422 response Added
PUT /api/v1/tag/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/task-status/{taskStatus_uuid}
  • Response
  • 422 response Added
PUT /api/v1/task/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/time-entry/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/workflow/{uuid}
  • Response
  • 422 response Added
PUT /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}
  • Response
  • 422 response Added
PUT /api/v2/addresses/{uuid}
  • Response
  • 422 response Added
PUT /api/v2/bank-accounts/{uuid}
  • Response
  • 422 response Added
PUT /api/v2/contact-details/{uuid}
  • Response
  • 422 response Added
PUT /api/v2/dependants/{uuid}
  • Response
  • 422 response Added
PUT /api/v2/employments/{uuid}
  • Response
  • 422 response Added
PUT /api/v2/fact-find/blocks/{factFindBlock_uuid}
  • Response
  • 422 response Added
PUT /api/v2/fact-find/factFindQuestionCondition/{uuid}
  • Response
  • 422 response Added
PUT /api/v2/fact-find/questions/{factFindQuestion_uuid}
  • Response
  • 422 response Added
PUT /api/v2/fact-find/sections/{factFindSection_uuid}
  • Response
  • 422 response Added
PUT /api/v2/fact-find/templates/{factFindTemplate_uuid}
  • Response
  • 422 response Added
PUT /api/v2/goals/{uuid}
  • Response
  • 422 response Added
PUT /api/v2/income/{uuid}
  • Response
  • 422 response Added
PUT /api/v2/mortgage-searches/{uuid}
  • Response
  • 422 response Added
PUT /api/v2/plans/{plan_uuid}/linked-policy-numbers/{uuid}
  • Response
  • 422 response Added
PUT /api/v2/risks/{uuid}
  • Response
  • 422 response Added
PUT /api/v2/shareholder/{uuid}
  • Response
  • 422 response Added
PUT /api/v2/webhook-subscriptions/{uuid}
  • Response
  • 422 response Added