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
100 structure changes including:
8 Breaking changes
18 Additions
74 Modifications
8 Removals
Modified 74 Breaking
POST /api/v1/tag
  • Response
  • 200 (1) response Removed
POST /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps
  • Path
  • $automationBlueprint path parameter Modified
GET /api/v1/tag
  • Response
  • 200 (1) response Removed
GET /api/v1/options/time-trackable
  • Response
  • 200 response Removed
GET /api/v1/options/custom-fields
  • Response
  • 200 response Removed
GET /api/v1/file/{file}/download
  • Response
  • 200 response Removed
GET /api/v1/document/{id}
  • Response
  • 200 response Modified
    • uuid, created_at, updated_at properties Added
GET /api/v1/client/{client}/address/{id}
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
GET /api/v1/cases-type/{id}
  • Response
  • 200 response Modified
    • slug, participants_count, participants properties Removed
GET /api/v1/cases-type
  • Query
  • sort query parameter Added
  • Response
  • 200 response Added
GET /api/v1/cases-status
  • Response
  • 200 (1) response Removed
GET /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
DELETE /api/v1/workflow/{workflow}/task/{workflowTask}/participants
  • Response
  • 204 response Removed
DELETE /api/v1/workflow/{workflow_id}/task/{workflowTask}
  • Response
  • 204 response Removed
DELETE /api/v1/workflow/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/tag/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/plans/{plan}/sub-accounts/{subAccount}/valuations/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/payment/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/import/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/group/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/group/{group}/participants
  • Response
  • 201 response Removed
POST /api/v1/payment/csv
  • Response
  • 200 response Removed
POST /api/v1/payment
  • Response
  • 200 response Removed
POST /api/v1/import/client
  • Response
  • 202 response Removed
POST /api/v1/group/{group}/participants
  • Response
  • 201 response Removed
POST /api/v1/folder/{folder}/permissions
  • Response
  • 204 response Removed
POST /api/v1/fact-find/request/{factFindRequest}/section/{factFindSchemaSection}/incomplete
  • Response
  • 204 response Removed
POST /api/v1/fact-find/request/{factFindRequest}/section/{factFindSchemaSection}/complete
  • Response
  • 204 response Removed
POST /api/v1/document/{document}/preview-pdf
  • Response
  • 202 response Removed
POST /api/v1/document/{document}/build
  • Response
  • 200 response Modified
    • uuid, created_at, updated_at properties Added
POST /api/v1/document
  • Response
  • 201 response Modified
    • uuid, created_at, updated_at properties Added
POST /api/v1/custom-field
  • Response
  • 201 response Removed
POST /api/v1/conversation/{conversation}/unarchive
  • Response
  • 204 response Removed
POST /api/v1/conversation/{conversation}/participants
  • Response
  • 204 response Removed
POST /api/v1/conversation/{conversation}/notifications
  • Response
  • 204 response Removed
POST /api/v1/conversation/{conversation}/archive
  • Response
  • 204 response Removed
POST /api/v1/conversation/{conversation}/admin
  • Response
  • 204 response Removed
POST /api/v1/client/{client}/address
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
POST /api/v1/cases/{case}/participants
  • Response
  • 204 response Removed
POST /api/v1/cases-type
  • Response
  • 200 response Added
POST /api/v1/cases-status
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
  • 201 response Removed
DELETE /api/v1/folder/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/client/{client}/address/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/cases/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/cases/{case}/participants
  • Response
  • 204 response Removed
DELETE /api/v1/cases-status/{id}
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
  • 204 response Removed
DELETE /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
DELETE /api/v1/automation-blueprints/{automationBlueprint}
  • Response
  • 204 response Removed
POST /api/v1/workflow
  • Response
  • 201 response Removed
POST /api/v1/workflow/{workflow}/run
  • Response
  • 202 response Removed
POST /api/v1/workflow/{workflow}/task
  • Response
  • 201 response Removed
POST /api/v1/workflow/{workflow}/task/{workflowTask}/participants
  • Response
  • 204 response Removed
PUT /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
PUT /api/v1/cases-status/{id}
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
  • 200 (1) response Removed
PUT /api/v1/cases-type/{id}
  • Response
  • 200 response Added
PUT /api/v1/client/{client}/address/{id}
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
PUT /api/v1/document/{id}
  • Response
  • 200 response Modified
    • uuid, created_at, updated_at properties Added
PUT /api/v1/tag/{id}
  • Response
  • 200 (1) response Removed
DELETE /api/v1/file/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/fee/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/fee-schedule/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/fact-find/schema/{factFindSchema}/section/{factFindSchemaSection}
  • Response
  • 204 response Removed
DELETE /api/v1/fact-find/schema/{factFindSchema}
  • Response
  • 204 response Removed
DELETE /api/v1/fact-find/request/{factFindRequest}
  • Response
  • 204 response Removed
DELETE /api/v1/document/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/client/{client}/contact-detail/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/client/{client}/linked-clients/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/client/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/conversation/{conversation}/admin
  • Response
  • 204 response Removed
DELETE /api/v1/conversation/{conversation}/leave
  • Response
  • 204 response Removed
DELETE /api/v1/conversation/{conversation}/messages/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/conversation/{conversation}/participants
  • Response
  • 204 response Removed
DELETE /api/v1/conversation/{id}
  • Response
  • 204 response Removed
DELETE /api/v1/custom-field/{customField}
  • Response
  • 204 response Removed
Removed 8 Breaking
DELETE /api/v1/template/{id}
GET /api/v1/template
GET /api/v1/template/{id}
POST /api/v1/template
POST /api/v1/template/{template}/dependants
POST /api/v1/template/{template}/preview
POST /api/v1/template/{template}/preview-pdf
PUT /api/v1/template/{id}
Added 18
DELETE /api/v1/document-pack/{id}
DELETE /api/v1/document-template/{documentTemplate}
GET /api/v1/client/{client}/signatures
GET /api/v1/document-pack
GET /api/v1/document-pack/{documentPack}/dependants
GET /api/v1/document-pack/{id}
GET /api/v1/document-signing
GET /api/v1/document-signing/{signatureTransaction}
GET /api/v1/document-template
GET /api/v1/document-template/{documentTemplate}
POST /api/v1/document-pack
POST /api/v1/document-signing
POST /api/v1/document-template
POST /api/v1/document-template/{documentTemplate}/dependants
POST /api/v1/document-template/{documentTemplate}/preview
POST /api/v1/document-template/{documentTemplate}/preview-pdf
PUT /api/v1/document-pack/{id}
PUT /api/v1/document-template/{documentTemplate}
23 structure changes including:
12 Breaking changes
7 Additions
4 Modifications
12 Removals
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
Removed 12 Breaking
PUT /api/v1/network/{id}
POST /api/v1/network
GET /api/v1/network/{id}
GET /api/v1/network
GET /api/v1/firm/{firm}/documents
GET /api/v1/conversation/{conversation}/documents
GET /api/v1/client/{client}/plans
GET /api/v1/client/{client}/groups
GET /api/v1/client/{client}/documents
GET /api/v1/client/{client}/conversations
GET /api/v1/cases/{case}/documents
DELETE /api/v1/network/{id}
Added 7
GET /api/v1/firm/{firm}/documents
GET /api/v1/conversation/{conversation}/documents
GET /api/v1/client/{client}/plans
GET /api/v1/client/{client}/groups
GET /api/v1/client/{client}/documents
GET /api/v1/client/{client}/conversations
GET /api/v1/cases/{case}/documents
11 structure changes including:
5 Additions
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/client/{client}/employment
  • Body
  • content type Modified
    • shared_owner_uuid property Added
PUT /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
PUT /api/v1/client/{client}/employment/{id}
  • Body
  • content type Modified
    • shared_owner_uuid property Added
Added 5
DELETE /api/v1/client/{client}/income/{id}
GET /api/v1/client/{client}/income
GET /api/v1/client/{client}/income/{id}
POST /api/v1/client/{client}/income
PUT /api/v1/client/{client}/income/{id}
11 structure changes including:
11 Modifications
Modified 11 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
GET /api/v1/client/{client}/employment/{id}
  • Response
  • 200 response Modified
    • shared_owner_type, shared_owner properties Added
GET /api/v1/client/{client}/goal
  • Query
  • include query parameter Added
GET /api/v1/client/{client}/goal/{id}
  • Response
  • 200 response Modified
    • shared_owner_type, shared_owner properties Added
POST /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps
  • Path
  • $automationBlueprint path parameter Modified
POST /api/v1/client/{client}/employment
  • Response
  • 201 response Modified
    • shared_owner_type, shared_owner properties Added
POST /api/v1/client/{client}/goal
  • Body
  • content type Modified
    • shared_owner_uuid property Added
  • Response
  • 201 response Modified
    • shared_owner_type, shared_owner properties Added
PUT /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
PUT /api/v1/client/{client}/employment/{id}
  • Response
  • 200 response Modified
    • shared_owner_type, shared_owner properties Added
PUT /api/v1/client/{client}/goal/{id}
  • Body
  • content type Modified
    • shared_owner_uuid property Added
  • Response
  • 200 response Modified
    • shared_owner_type, shared_owner properties Added
13 structure changes including:
1 Addition
12 Modifications
Modified 12 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
GET /api/v1/client/{client}/dependant
  • Query
  • include query parameter Added
GET /api/v1/client/{client}/expense
  • Query
  • include query parameter Added
GET /api/v1/client/{client}/expense/{id}
  • Response
  • 200 response Modified
    • shared_owner_type, shared_owner properties Added
POST /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps
  • Path
  • $automationBlueprint path parameter Modified
POST /api/v1/client
  • Body
  • content type Modified
    • is_uk_resident, is_uk_domicile, expected_retirement_age, state_retirement_age, nationalities, vulnerability_details, third_party_offered, procedure_adaptation, client_preferences, current_state_of_health, state_of_health_explanation, cigarettes_daily, smoker_since, long_term_care_needed, long_term_care_notes, has_will, will_notes, will_last_reviewed, has_power_of_attorney, power_of_attorney_notes, first_contact_date, next_review_date, units_of_alcohol_weekly, height, weight, health_notes, has_iht_planning, iht_planning_notes, has_gifted_family, gift_notes, is_anticipating_inheritance, anticipating_inheritance_notes properties Added
POST /api/v1/client/{client}/expense
  • Body
  • content type Modified
    • shared_owner_uuid property Added
  • Response
  • 201 response Modified
    • shared_owner_type, shared_owner properties Added
PUT /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
PUT /api/v1/client/{client_id}/owners/personal-details/{owner}
  • Body
  • content type Modified
    • is_uk_resident, is_uk_domicile, expected_retirement_age, state_retirement_age, nationalities, vulnerability_details, third_party_offered, procedure_adaptation, client_preferences, current_state_of_health, state_of_health_explanation, cigarettes_daily, smoker_since, long_term_care_needed, long_term_care_notes, has_will, will_notes, will_last_reviewed, has_power_of_attorney, power_of_attorney_notes, first_contact_date, next_review_date, units_of_alcohol_weekly, height, weight, health_notes, has_iht_planning, iht_planning_notes, has_gifted_family, gift_notes, is_anticipating_inheritance, anticipating_inheritance_notes properties Added
  • Response
  • 200 response Modified
    • is_uk_resident, is_uk_domicile, expected_retirement_age, state_retirement_age, nationalities, third_party_offered, procedure_adaptation, cigarettes_daily, smoker_since, long_term_care_needed, has_will, will_notes, will_last_reviewed, has_power_of_attorney properties Added
PUT /api/v1/client/{client}/expense/{id}
  • Body
  • content type Modified
    • shared_owner_uuid property Added
  • Response
  • 200 response Modified
    • shared_owner_type, shared_owner properties Added
PUT /api/v1/client/{id}
  • Body
  • content type Modified
    • is_uk_resident, is_uk_domicile, expected_retirement_age, state_retirement_age, nationalities, vulnerability_details, third_party_offered, procedure_adaptation, client_preferences, current_state_of_health, state_of_health_explanation, cigarettes_daily, smoker_since, long_term_care_needed, long_term_care_notes, has_will, will_notes, will_last_reviewed, has_power_of_attorney, power_of_attorney_notes, first_contact_date, next_review_date, units_of_alcohol_weekly, height, weight, health_notes, has_iht_planning, iht_planning_notes, has_gifted_family, gift_notes, is_anticipating_inheritance, anticipating_inheritance_notes properties Added
Added 1
GET /api/v1/static/nationalities
8 structure changes including:
1 Addition
7 Modifications
Modified 7 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/client
  • Body
  • content type Modified
    • is_uk_resident, is_uk_domicile, expected_retirement_age, state_retirement_age, nationalities, vulnerability_details, third_party_offered, procedure_adaptation, client_preferences, current_state_of_health, state_of_health_explanation, cigarettes_daily, smoker_since, long_term_care_needed, long_term_care_notes, has_will, will_notes, will_last_reviewed, has_power_of_attorney, power_of_attorney_notes, first_contact_date, next_review_date, units_of_alcohol_weekly, height, weight, health_notes, has_iht_planning, iht_planning_notes, has_gifted_family, gift_notes, is_anticipating_inheritance, anticipating_inheritance_notes properties Added
PUT /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
PUT /api/v1/client/{client_id}/owners/personal-details/{owner}
  • Body
  • content type Modified
    • is_uk_resident, is_uk_domicile, expected_retirement_age, state_retirement_age, nationalities, vulnerability_details, third_party_offered, procedure_adaptation, client_preferences, current_state_of_health, state_of_health_explanation, cigarettes_daily, smoker_since, long_term_care_needed, long_term_care_notes, has_will, will_notes, will_last_reviewed, has_power_of_attorney, power_of_attorney_notes, first_contact_date, next_review_date, units_of_alcohol_weekly, height, weight, health_notes, has_iht_planning, iht_planning_notes, has_gifted_family, gift_notes, is_anticipating_inheritance, anticipating_inheritance_notes properties Added
  • Response
  • 200 response Modified
    • is_uk_resident, is_uk_domicile, expected_retirement_age, state_retirement_age, nationalities, third_party_offered, procedure_adaptation, cigarettes_daily, smoker_since, long_term_care_needed, has_will, will_notes, will_last_reviewed, has_power_of_attorney properties Added
PUT /api/v1/client/{id}
  • Body
  • content type Modified
    • is_uk_resident, is_uk_domicile, expected_retirement_age, state_retirement_age, nationalities, vulnerability_details, third_party_offered, procedure_adaptation, client_preferences, current_state_of_health, state_of_health_explanation, cigarettes_daily, smoker_since, long_term_care_needed, long_term_care_notes, has_will, will_notes, will_last_reviewed, has_power_of_attorney, power_of_attorney_notes, first_contact_date, next_review_date, units_of_alcohol_weekly, height, weight, health_notes, has_iht_planning, iht_planning_notes, has_gifted_family, gift_notes, is_anticipating_inheritance, anticipating_inheritance_notes properties Added
Added 1
GET /api/v1/static/nationalities
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/client/{client}/goal/{id}
GET /api/v1/client/{client}/goal
GET /api/v1/client/{client}/goal/{id}
POST /api/v1/client/{client}/goal
PUT /api/v1/client/{client}/goal/{id}