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
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}
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}/expense/{id}
GET /api/v1/client/{client}/expense
GET /api/v1/client/{client}/expense/{id}
POST /api/v1/client/{client}/expense
PUT /api/v1/client/{client}/expense/{id}
10 structure changes including:
6 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 6
DELETE /api/v1/client/{client}/employment/{id}
GET /api/v1/client/{client}/employment
GET /api/v1/client/{client}/employment/{id}
GET /api/v1/static/occupations
POST /api/v1/client/{client}/employment
PUT /api/v1/client/{client}/employment/{id}
19 structure changes including:
12 Additions
7 Modifications
Modified 7 Breaking
PUT /api/v1/firm/{id}
  • Response
  • 200 response Modified
    • address_1, address_2, town_city, county, postcode, country, is_subscribed properties Added
PUT /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
POST /api/v1/firm/{firm}/branding
  • Response
  • 200 response Modified
    • address_1, address_2, town_city, county, postcode, country, is_subscribed properties Added
POST /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps
  • Path
  • $automationBlueprint path parameter Modified
GET /api/v1/firm/{id}
  • Response
  • 200 response Modified
    • address_1, address_2, town_city, county, postcode, country, is_subscribed properties 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 12
PUT /api/v1/payment-method
POST /api/v1/subscription
POST /api/v1/payment-method
POST /api/v1/firm/{firm_id}/billing
GET /api/v1/subscription/plans
GET /api/v1/subscription
GET /api/v1/payment-method
GET /api/v1/invoice/{invoiceId}/download
GET /api/v1/invoice/{invoiceId}
GET /api/v1/invoice
DELETE /api/v1/subscription
DELETE /api/v1/payment-method