Do not miss any PlannrCRM API changes, ever again

Subscribe to the PlannrCRM API changelog to be up to date on recent changes.

RSS

about 3 hours ago

main
v1.122.0
Compare
v1.122.0

API structure has changed

Next change
38 structure changes including:
2 Breaking changes
36 Modifications
2 Removals
Modified 36 Breaking
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/business-units/{business_unit_uuid}/members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/circles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/client/{client_uuid}/owners
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/client/{client_uuid}/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
GET /api/v1/client/{client}/shared-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/group/{group_uuid}/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • joint_account_circle, circles properties Modified
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v1/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
GET /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
GET /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v2/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
GET /api/v2/plans/line-graph
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • visible_to_circles property Modified
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /api/v1/circles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
  • 409 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • joint_account_circle property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/plans/{plan_uuid}/ownership
  • Response
  • 200 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
  • 409 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
  • 409 response Modified
    • application/json content type Modified
      • visible_to_circles property Modified
        • has_portal_access, portal_access_status, engagement_rating, last_login, portal_login_count_30d, portal_login_count_90d, portal_login_count_365d properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
Removed 2 Breaking
GET /api/v1/portal-engagement/summary
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/static/portal-access-statuses
  • Removing a resource is always breaking unless it was deprecated before
    Breaking