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
2 structure changes including:
1 Breaking change
1 Addition
1 Removal
Removed 1 Breaking
POST /api/v1/document/{document_uuid}/start-review
Added 1
POST /api/v1/document/{document_uuid}/review
5 structure changes including:
1 Addition
4 Modifications
Modified 4 Breaking
GET /api/v1/document/{uuid}
  • Response
  • 200 response Modified
    • past_dependants property Added
POST /api/v1/document
  • Body
  • content type Modified
    • name, html properties Modified
    • submit_for_review, dependants properties Added
  • Response
  • 201 response Modified
    • past_dependants property Added
POST /api/v1/document/{document_uuid}/build
  • Response
  • 200 response Modified
    • past_dependants property Added
PUT /api/v1/document/{uuid}
  • Body
  • content type Modified
    • name, html properties Modified
    • template_uuid property Removed
    • processed_html property Added
  • Response
  • 200 response Modified
    • past_dependants property Added
Added 1
POST /api/v1/document/{document_uuid}/start-review
9 structure changes including:
1 Addition
8 Modifications
Modified 8 Breaking
GET /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • participants property Modified
GET /api/v1/import/{uuid}
  • Response
  • 200 response Modified
    • updated_at, errors_count properties Added
POST /api/v1/client
  • Body
  • content type Modified
    • previous_review_date, anniversary_review_date properties Added
POST /api/v1/conversation
  • Response
  • 200 response Modified
    • participants property Modified
POST /api/v1/firm/{firm_uuid}/branding
  • Body
  • content type Modified
    • banner property Added
POST /api/v1/import/client
  • Response
  • 200 response Modified
    • updated_at, errors_count properties Added
PUT /api/v1/client/{uuid}
  • Body
  • content type Modified
    • direct_report_uuid, prospect_converted_at, will_notes, next_review_date, previous_review_date, anniversary_review_date properties Modified
    • email property Removed
    • groups property Added
PUT /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • participants property Modified
Added 1
POST /api/v1/import/valuations
5 structure changes including:
5 Modifications
Modified 5
GET /api/v1/document-pack
  • Response
  • 200 response Added
GET /api/v1/document-pack/{id}
  • Response
  • 200 response Added
GET /api/v1/note/{notableType}/{notableUuid}
  • Query
  • sort, include, per_page query parameters Added
  • Response
  • 200 response Added
POST /api/v1/document-pack
  • Response
  • 200 response Added
PUT /api/v1/document-pack/{id}
  • Response
  • 200 response Added
242 structure changes including:
242 Modifications
Modified 242 Breaking
DELETE /api/v1/account/{account_uuid}/login/{uuid}
  • Path
  • account, id path parameters Removed
  • account_uuid, uuid path parameters Added
DELETE /api/v1/addon-subscriptions/{addonSubscription_uuid}/unsubscribe
  • Path
  • addonSubscription path parameter Removed
  • addonSubscription_uuid path parameter Added
DELETE /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Path
  • automationBlueprint path parameter Removed
  • automationBlueprint_uuid path parameter Added
DELETE /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps/{blueprintStep_uuid}
  • Path
  • $automationBlueprint path parameter Modified
  • blueprintStep path parameter Removed
  • automationBlueprint_uuid, blueprintStep_uuid path parameters Added
DELETE /api/v1/board/{board_uuid}/list/{boardList_uuid}
  • Path
  • board_id, boardList path parameters Removed
  • board_uuid, boardList_uuid path parameters Added
DELETE /api/v1/board/{board_uuid}/list/{boardList_uuid}/task/{boardTask_uuid}
  • Path
  • board_id, boardList, boardTask path parameters Removed
  • board_uuid, boardList_uuid, boardTask_uuid path parameters Added
DELETE /api/v1/cases/{case_uuid}/participants
  • Path
  • case path parameter Removed
  • case_uuid path parameter Added
DELETE /api/v1/cases/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/client/{client_uuid}/address/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
DELETE /api/v1/client/{client_uuid}/contact-detail/{id}
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
DELETE /api/v1/client/{client_uuid}/dependant/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
DELETE /api/v1/client/{client_uuid}/employment/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
DELETE /api/v1/client/{client_uuid}/expense/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
DELETE /api/v1/client/{client_uuid}/goal/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
DELETE /api/v1/client/{client_uuid}/income/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
DELETE /api/v1/client/{client_uuid}/linked-clients/{id}
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
DELETE /api/v1/client/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/conversation/{conversation_uuid}/admin
  • Path
  • conversation path parameter Removed
  • conversation_uuid path parameter Added
DELETE /api/v1/conversation/{conversation_uuid}/leave
  • Path
  • conversation path parameter Removed
  • conversation_uuid path parameter Added
DELETE /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Path
  • conversation, id path parameters Removed
  • conversation_uuid, uuid path parameters Added
DELETE /api/v1/conversation/{conversation_uuid}/participants
  • Path
  • conversation path parameter Removed
  • conversation_uuid path parameter Added
DELETE /api/v1/conversation/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/custom-field/{customField_uuid}
  • Path
  • customField_uuid path parameter Added
DELETE /api/v1/document-template/{documentTemplate_uuid}
  • Path
  • documentTemplate path parameter Removed
  • documentTemplate_uuid path parameter Added
DELETE /api/v1/document/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/employee/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/fact-find/request/{factFindRequest_uuid}
  • Path
  • factFindRequest path parameter Removed
  • factFindRequest_uuid path parameter Added
DELETE /api/v1/fact-find/schema/{factFindSchema_uuid}
  • Path
  • factFindSchema path parameter Removed
  • factFindSchema_uuid path parameter Added
DELETE /api/v1/fact-find/schema/{factFindSchema_uuid}/section/{factFindSchemaSection_uuid}
  • Path
  • factFindSchema, factFindSchemaSection path parameters Removed
  • factFindSchema_uuid, factFindSchemaSection_uuid path parameters Added
DELETE /api/v1/fee-type/{feeType_uuid}
  • Path
  • feeType path parameter Removed
  • feeType_uuid path parameter Added
DELETE /api/v1/fee/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/file/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/firm/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/folder/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/group/{group_uuid}/participants
  • Path
  • group path parameter Removed
  • group_uuid path parameter Added
DELETE /api/v1/group/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/import/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/introducer/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/note/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/payment-origin/{paymentOrigin_uuid}
  • Path
  • paymentOrigin path parameter Removed
  • paymentOrigin_uuid path parameter Added
DELETE /api/v1/payment/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{id}
  • Path
  • plan path parameter Removed
  • plan_uuid path parameter Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions/{uuid}
  • Path
  • plan, subAccount, id path parameters Removed
  • plan_uuid, subAccount_uuid, uuid path parameters Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Path
  • plan, subAccount, id path parameters Removed
  • plan_uuid, subAccount_uuid, uuid path parameters Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}
  • Path
  • plan, subAccount, id path parameters Removed
  • plan_uuid, subAccount_uuid, uuid path parameters Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals/{uuid}
  • Path
  • plan, subAccount, id path parameters Removed
  • plan_uuid, subAccount_uuid, uuid path parameters Added
DELETE /api/v1/plans/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/reaction/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/snippet/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/tag/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/workflow/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
DELETE /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}
  • Path
  • workflow_id, workflowTask path parameters Removed
  • workflow_uuid, workflowTask_uuid path parameters Added
DELETE /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/participants
  • Path
  • workflow, workflowTask path parameters Removed
  • workflow_uuid, workflowTask_uuid path parameters Added
GET /api/v1/account/{account_uuid}/login
  • Path
  • account path parameter Removed
  • account_uuid path parameter Added
GET /api/v1/addon-subscriptions/{addonSubscription_uuid}
  • Path
  • addonSubscription path parameter Removed
  • addonSubscription_uuid path parameter Added
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Path
  • automationBlueprint path parameter Removed
  • automationBlueprint_uuid path parameter Added
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps
  • Path
  • automationBlueprint path parameter Removed
  • automationBlueprint_uuid path parameter Added
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps/{blueprintStep_uuid}
  • Path
  • $automationBlueprint path parameter Modified
  • blueprintStep path parameter Removed
  • automationBlueprint_uuid, blueprintStep_uuid path parameters Added
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}/executions
  • Path
  • automationBlueprint path parameter Removed
  • automationBlueprint_uuid path parameter Added
GET /api/v1/board/{board_uuid}/list/trashed
  • Path
  • board path parameter Removed
  • board_uuid path parameter Added
GET /api/v1/board/{board_uuid}/list/{boardList_uuid}/task
  • Path
  • board_id, boardList path parameters Removed
  • board_uuid, boardList_uuid path parameters Added
GET /api/v1/board/{board_uuid}/list/{boardList_uuid}/task/{boardTask_uuid}
  • Path
  • board_id, boardList, boardTask path parameters Removed
  • board_uuid, boardList_uuid, boardTask_uuid path parameters Added
GET /api/v1/board/{board_uuid}/tasks
  • Path
  • board_id path parameter Removed
  • board_uuid path parameter Added
GET /api/v1/board/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/cases/{case_uuid}/conversations
  • Path
  • case path parameter Removed
  • case_uuid path parameter Added
GET /api/v1/cases/{case_uuid}/documents
  • Path
  • case path parameter Removed
  • case_uuid path parameter Added
GET /api/v1/cases/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/client
  • Query
  • filter[name], filter[email] query parameters Added
GET /api/v1/client/{client_uuid}/address
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/address/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
GET /api/v1/client/{client_uuid}/cases
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/contact-detail
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/contact-detail/{id}
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/conversations
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/dependant
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/dependant/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
GET /api/v1/client/{client_uuid}/documents
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/employment
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/employment/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
GET /api/v1/client/{client_uuid}/expense
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/expense/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
GET /api/v1/client/{client_uuid}/goal
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/goal/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
GET /api/v1/client/{client_uuid}/groups
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/income
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/income/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
GET /api/v1/client/{client_uuid}/linked-clients
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/owners
  • Path
  • client_id path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/plans
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/signatures
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{client_uuid}/wealth
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
GET /api/v1/client/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/conversation/{conversation_uuid}/documents
  • Path
  • conversation path parameter Removed
  • conversation_uuid path parameter Added
GET /api/v1/conversation/{conversation_uuid}/message/{message_uuid}/edits
  • Path
  • conversation, message path parameters Removed
  • conversation_uuid, message_uuid path parameters Added
GET /api/v1/conversation/{conversation_uuid}/messages
  • Path
  • conversation path parameter Removed
  • conversation_uuid path parameter Added
GET /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Path
  • conversation, id path parameters Removed
  • conversation_uuid, uuid path parameters Added
GET /api/v1/conversation/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/custom-field/{customField_uuid}
  • Path
  • customField_uuid path parameter Added
GET /api/v1/document-pack/{documentPack_uuid}/dependants
  • Path
  • documentPack path parameter Removed
  • documentPack_uuid path parameter Added
GET /api/v1/document-signing/{signatureTransaction_uuid}
  • Path
  • signatureTransaction path parameter Removed
  • signatureTransaction_uuid path parameter Added
GET /api/v1/document-template/{documentTemplate_uuid}
  • Path
  • documentTemplate path parameter Removed
  • documentTemplate_uuid path parameter Added
GET /api/v1/document/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/employee/{employee_uuid}/audits
  • Path
  • employee path parameter Removed
  • employee_uuid path parameter Added
GET /api/v1/employee/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/fact-find/request/{factFindRequest_uuid}
  • Path
  • factFindRequest path parameter Removed
  • factFindRequest_uuid path parameter Added
GET /api/v1/fact-find/request/{factFindRequest_uuid}/section
  • Path
  • factFindRequest path parameter Removed
  • factFindRequest_uuid path parameter Added
GET /api/v1/fact-find/schema/{factFindSchema_uuid}
  • Path
  • factFindSchema path parameter Removed
  • factFindSchema_uuid path parameter Added
GET /api/v1/fact-find/schema/{factFindSchema_uuid}/section
  • Path
  • factFindSchema path parameter Removed
  • factFindSchema_uuid path parameter Added
GET /api/v1/fact-find/schema/{factFindSchema_uuid}/section/{factFindSchemaSection_uuid}
  • Path
  • factFindSchema, factFindSchemaSection path parameters Removed
  • factFindSchema_uuid, factFindSchemaSection_uuid path parameters Added
GET /api/v1/fee-type/{feeType_uuid}
  • Path
  • feeType path parameter Removed
  • feeType_uuid path parameter Added
GET /api/v1/fee/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/file/{file_uuid}/download
  • Path
  • file path parameter Removed
  • file_uuid path parameter Added
GET /api/v1/file/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/firm/{firm_uuid}/documents
  • Path
  • firm path parameter Removed
  • firm_uuid path parameter Added
GET /api/v1/firm/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/folder/{folder_uuid}/tree
  • Path
  • folder path parameter Removed
  • folder_uuid path parameter Added
GET /api/v1/folder/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/group/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/import/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/introducer/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/note/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/payment-origin/{paymentOrigin_uuid}
  • Path
  • paymentOrigin path parameter Removed
  • paymentOrigin_uuid path parameter Added
GET /api/v1/payment/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/plans/{plan_uuid}/reporting/valuations/{subAccount}
  • Path
  • plan path parameter Removed
  • plan_uuid path parameter Added
GET /api/v1/plans/{plan_uuid}/sub-accounts
  • Path
  • plan path parameter Removed
  • plan_uuid path parameter Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{id}
  • Path
  • plan path parameter Removed
  • plan_uuid path parameter Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions
  • Path
  • plan, subAccount path parameters Removed
  • plan_uuid, subAccount_uuid path parameters Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions/{uuid}
  • Path
  • plan, subAccount, id path parameters Removed
  • plan_uuid, subAccount_uuid, uuid path parameters Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings
  • Path
  • plan, subAccount path parameters Removed
  • plan_uuid, subAccount_uuid path parameters Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Path
  • plan, subAccount, id path parameters Removed
  • plan_uuid, subAccount_uuid, uuid path parameters Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations
  • Path
  • plan, subAccount path parameters Removed
  • plan_uuid, subAccount_uuid path parameters Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}
  • Path
  • plan, subAccount, id path parameters Removed
  • plan_uuid, subAccount_uuid, uuid path parameters Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals
  • Path
  • plan, subAccount path parameters Removed
  • plan_uuid, subAccount_uuid path parameters Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals/{uuid}
  • Path
  • plan, subAccount, id path parameters Removed
  • plan_uuid, subAccount_uuid, uuid path parameters Added
GET /api/v1/plans/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/providers/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/snippet/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/workflow/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
GET /api/v1/workflow/{workflow_uuid}/task
  • Path
  • workflow_id path parameter Removed
  • workflow_uuid path parameter Added
GET /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}
  • Path
  • workflow_id, workflowTask path parameters Removed
  • workflow_uuid, workflowTask_uuid path parameters Added
POST /api/v1/account/{account_uuid}/login
  • Path
  • account path parameter Removed
  • account_uuid path parameter Added
POST /api/v1/addon-subscriptions/{addonSubscription_uuid}/disable
  • Path
  • addonSubscription path parameter Removed
  • addonSubscription_uuid path parameter Added
POST /api/v1/addon-subscriptions/{addonSubscription_uuid}/enable
  • Path
  • addonSubscription path parameter Removed
  • addonSubscription_uuid path parameter Added
POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps
  • Path
  • $automationBlueprint path parameter Modified
  • automationBlueprint_uuid path parameter Added
POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/trigger
  • Path
  • automationBlueprint path parameter Removed
  • automationBlueprint_uuid path parameter Added
POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/webhook-targets
  • Path
  • automationBlueprint path parameter Removed
  • automationBlueprint_uuid path parameter Added
POST /api/v1/board/{board_uuid}/list
  • Path
  • board path parameter Removed
  • board_uuid path parameter Added
POST /api/v1/board/{board_uuid}/list/{boardList_uuid}/task
  • Path
  • board, boardList path parameters Removed
  • board_uuid, boardList_uuid path parameters Added
POST /api/v1/cases/{case_uuid}/participants
  • Path
  • case path parameter Removed
  • case_uuid path parameter Added
POST /api/v1/client/{client_uuid}/address
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
POST /api/v1/client/{client_uuid}/contact-detail
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
POST /api/v1/client/{client_uuid}/dependant
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
POST /api/v1/client/{client_uuid}/employment
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
POST /api/v1/client/{client_uuid}/expense
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
POST /api/v1/client/{client_uuid}/goal
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
POST /api/v1/client/{client_uuid}/income
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
POST /api/v1/client/{client_uuid}/linked-clients
  • Path
  • client_uuid path parameter Added
POST /api/v1/client/{client_uuid}/owners
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
POST /api/v1/conversation/{conversation_uuid}/admin
  • Path
  • conversation path parameter Removed
  • conversation_uuid path parameter Added
POST /api/v1/conversation/{conversation_uuid}/archive
  • Path
  • conversation path parameter Removed
  • conversation_uuid path parameter Added
POST /api/v1/conversation/{conversation_uuid}/mentions
  • Path
  • conversation path parameter Removed
  • conversation_uuid path parameter Added
POST /api/v1/conversation/{conversation_uuid}/messages
  • Path
  • conversation path parameter Removed
  • conversation_uuid path parameter Added
POST /api/v1/conversation/{conversation_uuid}/notifications
  • Path
  • conversation path parameter Removed
  • conversation_uuid path parameter Added
POST /api/v1/conversation/{conversation_uuid}/participants
  • Path
  • conversation path parameter Removed
  • conversation_uuid path parameter Added
POST /api/v1/conversation/{conversation_uuid}/pin
  • Path
  • conversation path parameter Removed
  • conversation_uuid path parameter Added
POST /api/v1/conversation/{conversation_uuid}/unarchive
  • Path
  • conversation path parameter Removed
  • conversation_uuid path parameter Added
POST /api/v1/document-template/{documentTemplate_uuid}/dependants
  • Path
  • documentTemplate path parameter Removed
  • documentTemplate_uuid path parameter Added
POST /api/v1/document-template/{documentTemplate_uuid}/preview
  • Path
  • documentTemplate path parameter Removed
  • documentTemplate_uuid path parameter Added
POST /api/v1/document-template/{documentTemplate_uuid}/preview-pdf
  • Path
  • documentTemplate path parameter Removed
  • documentTemplate_uuid path parameter Added
POST /api/v1/document/{document_uuid}/build
  • Path
  • document path parameter Removed
  • document_uuid path parameter Added
POST /api/v1/document/{document_uuid}/dependants
  • Path
  • document path parameter Removed
  • document_uuid path parameter Added
POST /api/v1/document/{document_uuid}/preview
  • Path
  • document path parameter Removed
  • document_uuid path parameter Added
POST /api/v1/document/{document_uuid}/preview-pdf
  • Path
  • document path parameter Removed
  • document_uuid path parameter Added
POST /api/v1/fact-find/request/{factFindRequest_uuid}/complete
  • Path
  • factFindRequest path parameter Removed
  • factFindRequest_uuid path parameter Added
POST /api/v1/fact-find/request/{factFindRequest_uuid}/section/{factFindSchemaSection_uuid}/complete
  • Path
  • factFindRequest, factFindSchemaSection path parameters Removed
  • factFindRequest_uuid, factFindSchemaSection_uuid path parameters Added
POST /api/v1/fact-find/request/{factFindRequest_uuid}/section/{factFindSchemaSection_uuid}/incomplete
  • Path
  • factFindRequest, factFindSchemaSection path parameters Removed
  • factFindRequest_uuid, factFindSchemaSection_uuid path parameters Added
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/archive
  • Path
  • factFindSchema path parameter Removed
  • factFindSchema_uuid path parameter Added
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/section
  • Path
  • factFindSchema path parameter Removed
  • factFindSchema_uuid path parameter Added
POST /api/v1/fact-find/schema/{factFindSchema_uuid}/unarchive
  • Path
  • factFindSchema path parameter Removed
  • factFindSchema_uuid path parameter Added
POST /api/v1/fee/{fee_uuid}/reconcile
  • Path
  • fee path parameter Removed
  • fee_uuid path parameter Added
POST /api/v1/firm/{firm_uuid}/branding
  • Path
  • firm path parameter Removed
  • firm_uuid path parameter Added
POST /api/v1/firm/{firm_uuid}/settings
  • Path
  • firm path parameter Removed
  • firm_uuid path parameter Added
POST /api/v1/folder/{folder_uuid}/permissions
  • Path
  • folder path parameter Removed
  • folder_uuid path parameter Added
POST /api/v1/group/{group_uuid}/participants
  • Path
  • group path parameter Removed
  • group_uuid path parameter Added
POST /api/v1/notifications/read/{notification_id}
  • Path
  • notification_id path parameter Added
POST /api/v1/plans/{plan_uuid}/sub-accounts
  • Path
  • plan path parameter Removed
  • plan_uuid path parameter Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions
  • Path
  • plan, subAccount path parameters Removed
  • plan_uuid, subAccount_uuid path parameters Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings
  • Path
  • plan, subAccount path parameters Removed
  • plan_uuid, subAccount_uuid path parameters Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations
  • Path
  • plan, subAccount path parameters Removed
  • plan_uuid, subAccount_uuid path parameters Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals
  • Path
  • plan, subAccount path parameters Removed
  • plan_uuid, subAccount_uuid path parameters Added
POST /api/v1/time-entry/{timeEntry_uuid}/stop
  • Path
  • timeEntry path parameter Removed
  • timeEntry_uuid path parameter Added
POST /api/v1/webhooks/{webhookTarget_uuid}
  • Path
  • webhookTarget path parameter Removed
  • webhookTarget_uuid path parameter Added
POST /api/v1/workflow/{workflow_uuid}/run
  • Path
  • workflow path parameter Removed
  • workflow_uuid path parameter Added
POST /api/v1/workflow/{workflow_uuid}/task
  • Path
  • workflow path parameter Removed
  • workflow_uuid path parameter Added
POST /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/participants
  • Path
  • workflow, workflowTask path parameters Removed
  • workflow_uuid, workflowTask_uuid path parameters Added
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Path
  • account, id path parameters Removed
  • account_uuid, uuid path parameters Added
PUT /api/v1/addon-subscriptions/{addonSubscription_uuid}
  • Path
  • addonSubscription path parameter Removed
  • addonSubscription_uuid path parameter Added
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Path
  • automationBlueprint path parameter Removed
  • automationBlueprint_uuid path parameter Added
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps/{blueprintStep_uuid}
  • Path
  • $automationBlueprint path parameter Modified
  • blueprintStep path parameter Removed
  • automationBlueprint_uuid, blueprintStep_uuid path parameters Added
PUT /api/v1/board/{board_uuid}/list/{boardList_uuid}
  • Path
  • board_id, boardList path parameters Removed
  • board_uuid, boardList_uuid path parameters Added
PUT /api/v1/board/{board_uuid}/list/{boardList_uuid}/task/{boardTask_uuid}
  • Path
  • board_id, boardList, boardTask path parameters Removed
  • board_uuid, boardList_uuid, boardTask_uuid path parameters Added
PUT /api/v1/board/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/cases/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/client/{client_uuid}/address/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
PUT /api/v1/client/{client_uuid}/contact-detail/{id}
  • Path
  • client path parameter Removed
  • client_uuid path parameter Added
PUT /api/v1/client/{client_uuid}/dependant/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
PUT /api/v1/client/{client_uuid}/employment/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
PUT /api/v1/client/{client_uuid}/expense/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
PUT /api/v1/client/{client_uuid}/goal/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
PUT /api/v1/client/{client_uuid}/income/{uuid}
  • Path
  • client, id path parameters Removed
  • client_uuid, uuid path parameters Added
PUT /api/v1/client/{client_uuid}/linked-clients/{id}
  • Path
  • client_uuid path parameter Added
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
  • Path
  • client_id, owner path parameters Removed
  • client_uuid, owner_uuid path parameters Added
PUT /api/v1/client/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Path
  • conversation, id path parameters Removed
  • conversation_uuid, uuid path parameters Added
PUT /api/v1/conversation/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/custom-field/{customField_uuid}
  • Path
  • customField_uuid path parameter Added
PUT /api/v1/document-template/{documentTemplate_uuid}
  • Path
  • documentTemplate path parameter Removed
  • documentTemplate_uuid path parameter Added
PUT /api/v1/document/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/employee/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/fact-find/schema/{factFindSchema_uuid}
  • Path
  • factFindSchema path parameter Removed
  • factFindSchema_uuid path parameter Added
PUT /api/v1/fact-find/schema/{factFindSchema_uuid}/section/{factFindSchemaSection_uuid}
  • Path
  • factFindSchema, factFindSchemaSection path parameters Removed
  • factFindSchema_uuid, factFindSchemaSection_uuid path parameters Added
PUT /api/v1/fee-type/{feeType_uuid}
  • Path
  • feeType path parameter Removed
  • feeType_uuid path parameter Added
PUT /api/v1/fee/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/file/{file_uuid}/copy
  • Path
  • file path parameter Removed
  • file_uuid path parameter Added
PUT /api/v1/file/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/firm/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/folder/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/group/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/introducer/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/note/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/payment-origin/{paymentOrigin_uuid}
  • Path
  • paymentOrigin path parameter Removed
  • paymentOrigin_uuid path parameter Added
PUT /api/v1/payment/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{id}
  • Path
  • plan path parameter Removed
  • plan_uuid path parameter Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions/{uuid}
  • Path
  • plan, subAccount, id path parameters Removed
  • plan_uuid, subAccount_uuid, uuid path parameters Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Path
  • plan, subAccount, id path parameters Removed
  • plan_uuid, subAccount_uuid, uuid path parameters Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}
  • Path
  • plan, subAccount, id path parameters Removed
  • plan_uuid, subAccount_uuid, uuid path parameters Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals/{uuid}
  • Path
  • plan, subAccount, id path parameters Removed
  • plan_uuid, subAccount_uuid, uuid path parameters Added
PUT /api/v1/plans/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/snippet/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/tag/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/workflow/{uuid}
  • Path
  • id path parameter Removed
  • uuid path parameter Added
PUT /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}
  • Path
  • workflow_id, workflowTask path parameters Removed
  • workflow_uuid, workflowTask_uuid path parameters Added
28 structure changes including:
1 Addition
27 Modifications
Modified 27 Breaking
PUT /api/v1/introducer/{id}
  • Response
  • 200 response Modified
    • external_references property Added
PUT /api/v1/document-template/{documentTemplate}
  • Response
  • 200 response Modified
    • dependants property Added
PUT /api/v1/document-pack/{id}
  • Response
  • 200 response Removed
PUT /api/v1/client/{id}
  • Response
  • 200 response Modified
    • external_references property Added
PUT /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • external_references property Added
POST /api/v1/import/client
  • Body
  • content type Modified
    • subscribe property Added
POST /api/v1/folder
  • Body
  • content type Modified
    • parent property Modified
POST /api/v1/employee
  • Response
  • 200 response Modified
    • external_references property Added
POST /api/v1/document-template
  • Response
  • 201 response Modified
    • dependants property Added
POST /api/v1/document-signing
  • Response
  • 200 response Modified
    • account property Removed
    • launched_by property Added
POST /api/v1/document-pack
  • Response
  • 200 response Removed
POST /api/v1/client
  • Body
  • content type Modified
    • email, direct_report_uuid, prospect_converted_at, will_notes, next_review_date properties Modified
    • previous_review_date, anniversary_review_date properties Removed
    • external_reference property Added
  • Response
  • 200 response Modified
    • external_references property Added
POST /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps
  • Path
  • $automationBlueprint path parameter Modified
GET /api/v1/introducer/{id}
  • Response
  • 200 response Modified
    • external_references property Added
GET /api/v1/employee
  • Response
  • 200 response Modified
    • external_references property Added
GET /api/v1/document-template/{documentTemplate}
  • Response
  • 200 response Modified
    • dependants property Added
GET /api/v1/document-template
  • Query
  • sort query parameter Added
GET /api/v1/document-signing/{signatureTransaction}
  • Response
  • 200 response Modified
    • account property Removed
    • launched_by property Added
GET /api/v1/document-signing
  • Query
  • filter[date_from], filter[date_to] query parameters Added
GET /api/v1/document-pack/{id}
  • Response
  • 200 response Removed
GET /api/v1/document-pack
  • Response
  • 200 response Removed
GET /api/v1/client/{id}
  • Response
  • 200 response Modified
    • external_references property Added
GET /api/v1/client/{client}/signatures
  • Query
  • filter[date_from], filter[date_to] query parameters Added
GET /api/v1/client
  • Response
  • 200 response Modified
    • external_references property Added
GET /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
DELETE /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
Added 1
POST /api/v1/file/direct-upload
9 structure changes including:
5 Additions
4 Modifications
Modified 4 Breaking
DELETE /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
GET /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
POST /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps
  • Path
  • $automationBlueprint path parameter Modified
PUT /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
Added 5
DELETE /api/v1/introducer/{id}
GET /api/v1/introducer
GET /api/v1/introducer/{id}
POST /api/v1/introducer
PUT /api/v1/introducer/{id}
6 structure changes including:
6 Modifications
Modified 6 Breaking
DELETE /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
GET /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
POST /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps
  • Path
  • $automationBlueprint path parameter Modified
POST /api/v1/time-entry
  • Body
  • content type Modified
    • total_time_in_minutes property Added
PUT /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
PUT /api/v1/time-entry/{id}
  • Body
  • content type Modified
    • total_time_in_minutes property Added