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

Jun 10, 2022

main
1.0.0
Compare

API structure has changed

35 structure changes including:
5 Additions
30 Modifications
Modified 30 Breaking
DELETE /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/conversation
  • Response
  • 200 response Modified
    • case, participants_count, participants, messages_count properties Modified
    • files_count, tags, pinned properties Added
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/conversation/{conversation}/admin
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/conversation/{conversation}/archive
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/conversation/{conversation}/mentions
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
  • Response
  • 200 response Added
POST /api/v1/conversation/{conversation}/messages
  • Response
  • 200 response Modified
    • user property Added
POST /api/v1/conversation/{conversation}/notifications
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/conversation/{conversation}/participants
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/conversation/{conversation}/unarchive
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/document
  • Response
  • 201 response Modified
    • dependants, processed_html, latest_preview_pdf properties Added
POST /api/v1/document-template
  • Response
  • 201 response Modified
    • latest_preview_pdf property Added
POST /api/v1/document/{document}/build
  • Response
  • 200 response Modified
    • dependants, processed_html, latest_preview_pdf properties Added
PUT /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
PUT /api/v1/conversation/{conversation}/messages/{id}
  • Response
  • 200 response Modified
    • user property Added
PUT /api/v1/conversation/{id}
  • Response
  • 200 response Modified
    • case, participants_count, participants, messages_count properties Modified
    • files_count, tags, pinned properties Added
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/document-template/{documentTemplate}
  • Response
  • 200 response Modified
    • latest_preview_pdf property Added
PUT /api/v1/document/{id}
  • Response
  • 200 response Modified
    • dependants, processed_html, latest_preview_pdf properties Added
DELETE /api/v1/conversation/{conversation}/admin
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/conversation/{conversation}/leave
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/conversation/{conversation}/participants
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/conversation/{id}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/automation-blueprints/{automationBlueprint}/blueprint-steps/{blueprintStep}
  • Path
  • $automationBlueprint path parameter Modified
GET /api/v1/conversation
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/conversation/{conversation}/documents
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/conversation/{conversation}/messages/{id}
  • Response
  • 200 response Modified
    • user property Added
GET /api/v1/conversation/{id}
  • Response
  • 200 response Modified
    • case, participants_count, participants, messages_count properties Modified
    • files_count, tags, pinned properties Added
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/document-template/{documentTemplate}
  • Response
  • 200 response Modified
    • latest_preview_pdf property Added
GET /api/v1/document/{id}
  • Response
  • 200 response Modified
    • dependants, processed_html, latest_preview_pdf properties Added
POST /api/v1/account/{account}/login
  • Body
  • content type Modified
    • write, receives_unread_notifications_email properties Modified
Added 5
PUT /api/v1/file/{file}/restore
POST /api/v1/firm/{firm}/settings
POST /api/v1/conversation/{conversation}/pin
GET /api/v1/file/bin
DELETE /api/v1/file/{file}/forceDelete