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
10 structure changes including:
5 Breaking changes
5 Additions
5 Removals
Removed 5 Breaking
DELETE /api/v1/firm/{firm}/note/{id}
GET /api/v1/firm/{firm}/note/{id}
GET /api/v1/firm/{firm}/note/{notable_type}/{notable_uuid}
POST /api/v1/firm/{firm}/note
PUT /api/v1/firm/{firm}/note/{id}
Added 5
DELETE /api/v1/firm/{firm}/note/{id}
GET /api/v1/firm/{firm}/note/{id}
GET /api/v1/firm/{firm}/note/{notable_type}/{notable_uuid}
POST /api/v1/firm/{firm}/note
PUT /api/v1/firm/{firm}/note/{id}
1 structure change including:
1 Modification
Modified 1 Breaking
GET /api/v1/firm/{firm}/note/{notable_type}/{notable_uuid}
  • Path
  • notable_type path parameter Modified
32 structure changes including:
2 Breaking changes
8 Additions
22 Modifications
2 Removals
Modified 22 Breaking
POST /api/v1/firm/{firm}/group
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
POST /api/v1/firm/{firm}/employee
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
POST /api/v1/firm/{firm}/conversation/{conversation}/messages
  • Response
  • 200 response Modified
    • uuid, contents, edited, author, reactions, created_at, updated_at, deleted_at properties Added
POST /api/v1/firm/{firm}/conversation
  • Response
  • 200 response Modified
    • latest_message, created_at, updated_at properties Added
POST /api/v1/firm/{firm}/client
  • Response
  • 200 response Modified
    • photo_url, gender, ni_number, nickname, date_of_birth, target_retirement_age, middle_name, pronouns, smoker_status, residential_status, marital_status properties Removed
    • role, firm, created_at, updated_at properties Added
POST /api/v1/firm/{firm}/cases
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
POST /api/v1/firm
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
GET /api/v1/firm/{id}
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
GET /api/v1/firm/{firm}/group/{id}
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
GET /api/v1/firm/{firm}/employee
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
GET /api/v1/firm/{firm}/conversation/{id}
  • Response
  • 200 response Modified
    • latest_message, created_at, updated_at properties Added
GET /api/v1/firm/{firm}/conversation/{conversation}/messages/{id}
  • Response
  • 200 response Modified
    • uuid, contents, edited, author, reactions, created_at, updated_at, deleted_at properties Added
GET /api/v1/firm/{firm}/conversation/{conversation}/messages
  • Response
  • 200 response Modified
    • property Removed
    • data property Added
GET /api/v1/firm/{firm}/client/{id}
  • Response
  • 200 response Modified
    • photo_url, gender, ni_number, nickname, date_of_birth, target_retirement_age, middle_name, pronouns, smoker_status, residential_status, marital_status properties Removed
    • role, firm, created_at, updated_at properties Added
GET /api/v1/firm/{firm}/client
  • Response
  • 200 response Modified
    • photo_url, gender, ni_number, nickname, date_of_birth, target_retirement_age, middle_name, pronouns, smoker_status, residential_status, marital_status properties Removed
    • role, firm, created_at, updated_at properties Added
GET /api/v1/firm/{firm}/cases/{id}
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
PUT /api/v1/firm/{firm}/cases/{id}
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
PUT /api/v1/firm/{firm}/client/{id}
  • Response
  • 200 response Modified
    • photo_url, gender, ni_number, nickname, date_of_birth, target_retirement_age, middle_name, pronouns, smoker_status, residential_status, marital_status properties Removed
    • role, firm, created_at, updated_at properties Added
PUT /api/v1/firm/{firm}/conversation/{conversation}/messages/{id}
  • Response
  • 200 response Modified
    • uuid, contents, edited, author, reactions, created_at, updated_at, deleted_at properties Added
PUT /api/v1/firm/{firm}/conversation/{id}
  • Response
  • 200 response Modified
    • latest_message, created_at, updated_at properties Added
PUT /api/v1/firm/{firm}/group/{id}
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
PUT /api/v1/firm/{id}
  • Response
  • 200 response Modified
    • created_at, updated_at properties Added
Removed 2 Breaking
POST /api/v1/logout
POST /api/v1/user/switch-account
Added 8
PUT /api/v1/me
PUT /api/v1/firm/{firm}/note/{id}
POST /api/v1/me/switch-account
POST /api/v1/firm/{firm}/note
GET /api/v1/me
GET /api/v1/firm/{firm}/note/{notable_type}/{notable_uuid}
GET /api/v1/firm/{firm}/note/{id}
DELETE /api/v1/firm/{firm}/note/{id}
66 structure changes including:
2 Additions
64 Modifications
Modified 64 Breaking
PUT /api/v1/network/{id}
  • Path
  • id path parameter Added
POST /api/v1/firm/{firm}/conversation/{conversation}/messages
  • Path
  • firm, conversation path parameters Added
POST /api/v1/firm/{firm}/conversation/{conversation}/admin
  • Path
  • firm, conversation path parameters Added
POST /api/v1/firm/{firm}/conversation
  • Path
  • firm path parameter Added
POST /api/v1/firm/{firm}/client/{client}/linked-clients
  • Path
  • firm, client path parameters Added
POST /api/v1/firm/{firm}/client/{client}/address
  • Response
  • 401 response Removed
  • Path
  • firm, client path parameters Added
POST /api/v1/firm/{firm}/client
  • Path
  • firm path parameter Added
POST /api/v1/firm/{firm}/cases/{case}/participants
  • Path
  • firm, case path parameters Added
POST /api/v1/firm/{firm}/cases
  • Path
  • firm path parameter Added
GET /api/v1/state
  • Response
  • 401 response Removed
GET /api/v1/network/{id}
  • Response
  • 401 response Removed
  • Path
  • id path parameter Added
GET /api/v1/network
  • Response
  • 401 response Removed
GET /api/v1/firm/{id}
  • Path
  • id path parameter Added
GET /api/v1/firm/{firm}/group/{id}
  • Path
  • firm, id path parameters Added
GET /api/v1/firm/{firm}/group
  • Path
  • firm path parameter Added
GET /api/v1/firm/{firm}/employee
  • Path
  • firm path parameter Added
GET /api/v1/firm/{firm}/conversation/{id}
  • Path
  • firm, id path parameters Added
PUT /api/v1/firm/{id}
  • Path
  • id path parameter Added
PUT /api/v1/firm/{firm}/group/{id}
  • Path
  • firm, id path parameters Added
PUT /api/v1/firm/{firm}/conversation/{id}
  • Path
  • firm, id path parameters Added
PUT /api/v1/firm/{firm}/conversation/{conversation}/messages/{id}
  • Path
  • firm, conversation, id path parameters Added
PUT /api/v1/firm/{firm}/client/{id}
  • Path
  • firm, id path parameters Added
PUT /api/v1/firm/{firm}/client/{client}/linked-clients/{linked_client}
  • Path
  • firm, client, linked_client path parameters Added
PUT /api/v1/firm/{firm}/client/{client}/address/{id}
  • Path
  • firm, client, id path parameters Added
PUT /api/v1/firm/{firm}/cases/{id}
  • Path
  • firm, id path parameters Added
POST /api/v1/user/switch-account
  • Response
  • 401 response Removed
POST /api/v1/network
  • Response
  • 401 response Removed
POST /api/v1/logout
  • Response
  • 401 response Removed
POST /api/v1/firm/{firm}/group/{group}/participants
  • Path
  • firm, group path parameters Added
POST /api/v1/firm/{firm}/group
  • Path
  • firm path parameter Added
POST /api/v1/firm/{firm}/employee
  • Path
  • firm path parameter Added
POST /api/v1/firm/{firm}/conversation/{conversation}/participants
  • Path
  • firm, conversation path parameters Added
POST /api/v1/firm/{firm}/conversation/{conversation}/notifications
  • Path
  • firm, conversation path parameters Added
DELETE /api/v1/firm/{firm}/cases/{case}/participants
  • Path
  • firm, case path parameters Added
DELETE /api/v1/firm/{firm}/cases/{id}
  • Path
  • firm, id path parameters Added
DELETE /api/v1/firm/{firm}/client/{client}/address/{id}
  • Path
  • firm, client, id path parameters Added
DELETE /api/v1/firm/{firm}/client/{client}/linked-clients/{linked_client}
  • Path
  • firm, client, linked_client path parameters Added
DELETE /api/v1/firm/{firm}/client/{id}
  • Path
  • firm, id path parameters Added
DELETE /api/v1/firm/{firm}/conversation/{conversation}/admin
  • Path
  • firm, conversation path parameters Added
DELETE /api/v1/firm/{firm}/conversation/{conversation}/leave
  • Path
  • firm, conversation path parameters Added
DELETE /api/v1/firm/{firm}/conversation/{conversation}/messages/{id}
  • Path
  • firm, conversation, id path parameters Added
DELETE /api/v1/firm/{firm}/conversation/{conversation}/participants
  • Path
  • firm, conversation path parameters Added
DELETE /api/v1/firm/{firm}/conversation/{id}
  • Path
  • firm, id path parameters Added
DELETE /api/v1/firm/{firm}/employee/{id}
  • Path
  • firm, id path parameters Added
DELETE /api/v1/firm/{firm}/group/{group}/participants
  • Path
  • firm, group path parameters Added
DELETE /api/v1/firm/{firm}/group/{id}
  • Path
  • firm, id path parameters Added
DELETE /api/v1/firm/{id}
  • Path
  • id path parameter Added
DELETE /api/v1/network/{id}
  • Path
  • id path parameter Added
GET /api/v1/firm/{firm}/conversation/{conversation}/messages/{id}
  • Path
  • firm, conversation, id path parameters Added
GET /api/v1/firm/{firm}/conversation/{conversation}/messages
  • Path
  • firm, conversation path parameters Added
GET /api/v1/firm/{firm}/conversation/{conversation}/message/{message}/edits
  • Path
  • firm, conversation, message path parameters Added
GET /api/v1/firm/{firm}/conversation
  • Path
  • firm path parameter Added
GET /api/v1/firm/{firm}/client/{id}
  • Path
  • firm, id path parameters Added
GET /api/v1/firm/{firm}/client/{client}/linked-clients
  • Path
  • firm, client path parameters Added
GET /api/v1/firm/{firm}/client/{client}/groups
  • Path
  • firm, client path parameters Added
GET /api/v1/firm/{firm}/client/{client}/conversations
  • Path
  • firm, client path parameters Added
GET /api/v1/firm/{firm}/client/{client}/cases
  • Path
  • firm, client path parameters Added
GET /api/v1/firm/{firm}/client/{client}/address/{id}
  • Response
  • 401 response Removed
  • Path
  • firm, client, id path parameters Added
GET /api/v1/firm/{firm}/client/{client}/address
  • Response
  • 401 response Removed
  • Path
  • firm, client path parameters Added
GET /api/v1/firm/{firm}/client
  • Path
  • firm path parameter Added
GET /api/v1/firm/{firm}/cases/{id}
  • Path
  • firm, id path parameters Added
GET /api/v1/firm/{firm}/cases/{case}/conversations
  • Path
  • firm, case path parameters Added
GET /api/v1/firm/{firm}/cases
  • Path
  • firm path parameter Added
GET /api/v1/firm
  • Response
  • 401 response Removed
Added 2
GET /api/v1/firm/{firm}/audits/{model}/{modelUuid}
GET /api/v1/firm/{firm}/audits
4 structure changes including:
1 Breaking change
3 Additions
1 Removal
Removed 1 Breaking
GET /api/v1/user
Added 3
GET /api/v1/state
POST /api/v1/logout
POST /api/v1/user/switch-account
4 structure changes including:
2 Breaking changes
2 Modifications
2 Removals
Modified 2 Breaking
GET /api/v1/firm/{firm}/employee
  • Response
  • 401 response Removed
  • 200 response Added
  • Query
  • sort, include, per_page query parameters Added
POST /api/v1/firm/{firm}/employee
  • Response
  • 401 response Removed
  • 200 response Added
  • Body
  • content type Added
Removed 2 Breaking
GET /api/v1/firm/{firm}/employee/{id}
PUT /api/v1/firm/{firm}/employee/{id}
12 structure changes including:
12 Modifications
Modified 12 Breaking
GET /api/v1/firm/{firm}/cases
  • Query
  • perPage query parameter Removed
  • per_page query parameter Added
GET /api/v1/firm/{firm}/cases/{case}/conversations
  • Query
  • perPage query parameter Removed
  • per_page query parameter Added
GET /api/v1/firm/{firm}/client
  • Query
  • perPage query parameter Removed
  • per_page query parameter Added
GET /api/v1/firm/{firm}/client/{client}/cases
  • Query
  • perPage query parameter Removed
  • per_page query parameter Added
GET /api/v1/firm/{firm}/client/{client}/conversations
  • Query
  • perPage query parameter Removed
  • per_page query parameter Added
GET /api/v1/firm/{firm}/client/{client}/groups
  • Query
  • perPage query parameter Removed
  • per_page query parameter Added
GET /api/v1/firm/{firm}/conversation
  • Query
  • perPage query parameter Removed
  • per_page query parameter Added
GET /api/v1/firm/{firm}/conversation/{conversation}/messages
  • Query
  • perPage query parameter Removed
  • per_page query parameter Added
GET /api/v1/firm/{firm}/conversation/{id}
  • Response
  • 200 response Modified
    • belongs_to_case property Added
GET /api/v1/firm/{firm}/group
  • Query
  • perPage query parameter Removed
  • per_page query parameter Added
POST /api/v1/firm/{firm}/conversation
  • Response
  • 200 response Modified
    • belongs_to_case property Added
PUT /api/v1/firm/{firm}/conversation/{id}
  • Response
  • 200 response Modified
    • belongs_to_case property Added