Change Updates

Do not miss any Platform API changes, ever again

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

RSS

Oct 25, 2024

main
1.0.8
Compare
1.0.8

API structure has changed

39 structure changes including:
16 Breaking changes
23 Additions
16 Modifications
Modified 16 Breaking
DELETE /organization/{id}
  • Path went from /business/associate/delete to /organization/{id} (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • profile, chart, good, bad, verified, status properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • id, username, avatar, instagram, linkedIn, twitter, position, admin, first_name, last_name, email_address, phone_number, qr_code properties Added
  • Query
  • id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • id path parameter Added
DELETE /trip/shared/cancel
  • Path went from /trip/invite/cancel/quote-{id} to /trip/shared/cancel (same operationId)
    Breaking
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /location/search/place
  • Path went from /admin/permission/search to /location/search/place (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • name, avatar, role, scopes properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • place, country, state, city, latitude, longitude, local_government_area, street_number, street_name properties Added
GET /scope/payment/transaction/search
  • Path went from /location/search/place to /scope/payment/transaction/search (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from object to array[object]
          Breaking
        • id, place, country, state, city, latitude, longitude, local_government_area, street_number, street_name properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • PaymentApiResponseTransactionGroupScopeResponse property Added
  • Query
  • id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • page, size, query query parameters Added
PATCH /admin/permission/cancel
  • Path went from /trip/invite/cancel to /admin/permission/cancel (same operationId)
    Breaking
  • Verb went from DELETE to PATCH (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from string to array[object]
          Breaking
        • PermissionRequestGroupResponse property Added
  • Body
  • application/json content type Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • id query parameter Added
PATCH /admin/profile/update
  • Path went from /account/settings/update to /admin/profile/update (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • gender, show_only_verified, show_only_certified properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • firstName, lastName properties Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • gender, show_only_verified, show_only_certified properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • profile, team, activities properties Added
PATCH /call/update
  • Path went from /admin/profile/update to /call/update (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • firstName, lastName properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • channel, duration, status, time properties Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • profile, team, activities properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • app, status, channel, name, type, user, category, image, avatar, error, session, snt, is_caller, error_code properties Added
PATCH /organization/update
  • Path went from /call/update to /organization/update (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • channel, duration, status, time properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • email_address, first_name, last_name, phone_number, username, avatar, instagram, twitter, linkedIn, position properties Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from object to array[object]
          Breaking
        • app, status, channel, name, type, user, category, image, avatar, error, session, snt, is_caller, error_code properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • OrganizationResponse property Added
  • Query
  • id query parameter Added
PATCH /schedule/cancel/{id}
  • Path went from /trip/shared/cancel to /schedule/cancel/{id} (same operationId)
    Breaking
  • Verb went from DELETE to PATCH (same operationId)
    Breaking
  • Body
  • application/json content type Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • id path parameter Added
PATCH /scope/payment/payout/cancel
  • Path went from /schedule/cancel/{id} to /scope/payment/payout/cancel (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from string to array[object]
          Breaking
        • PaymentApiResponsePayoutScopeResponse property Added
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • page, size, id query parameters Added
PATCH /scope/payment/payout/cancel/batch
  • Path went from /admin/permission/cancel to /scope/payment/payout/cancel/batch (same operationId)
    Breaking
  • Query
  • id query parameter Modified
    • Type went from integer(int64) to string
      Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from array[object] to object
          Breaking
        • id, admin, user, status, type, transaction, event, amount, updated_at, bank_name, account_name, account_number properties Added
PATCH /specialty/add
  • Path went from /business/associate/resend to /specialty/add (same operationId)
    Breaking
  • Verb went from GET to PATCH (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from string to object
          Breaking
        • id, special, category, image, avatar properties Added
  • Query
  • id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • specialty query parameter Added
POST /auth/admin/invite
  • Path went from /specialty/add to /auth/admin/invite (same operationId)
    Breaking
  • Verb went from PATCH to POST (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from object to string
          Breaking
        • id, special, category, image, avatar properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
  • Query
  • specialty query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Body
  • application/json content type Added
POST /bookmark/add
  • Path went from /auth/admin/invite to /bookmark/add (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • role, position, department, scopes, first_name, last_name, email_address properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • user property Added
POST /business/associate/add
  • Path went from /bookmark/add to /business/associate/add (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • user property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • gender, category, specialties, consent, first_name, last_name, email_address, phone_information properties Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from string to array[object]
          Breaking
        • BusinessAssociateResponse property Added
POST /organization/add
  • Path went from /business/associate/add to /organization/add (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • first_name, last_name properties Modified
      • Properties are now required
        Breaking
    • gender, category, specialties, consent, phone_information properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • phone_number, username, avatar, instagram, twitter, linkedIn, position properties Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • profile, chart, good, bad, verified, status properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • id, username, avatar, instagram, linkedIn, twitter, position, admin, first_name, last_name, email_address, phone_number, qr_code properties Added
Added 23
PATCH /scope/payment/transaction/resolve
PATCH /scope/payment/payout/pay/batch
PATCH /scope/payment/payout/pay
DELETE /business/associate/delete
DELETE /trip/invite/cancel
DELETE /trip/invite/cancel/quote-{id}
GET /admin/permission/search
GET /business/associate/resend
GET /organization
GET /organization/all
GET /scope/payment/payout
GET /scope/payment/payout/all
GET /scope/payment/transaction
GET /scope/payment/transaction/all
GET /scope/payment/transaction/filter
GET /scope/payment/transaction/resolved
GET /scope/payment/transaction/resolved/find
GET /scope/payment/transaction/resolved/range
GET /scope/payment/transaction/resolved/search
GET /scope/payment/transaction/types
GET /scope/payment/wallet
GET /scope/payment/wallet/all
PATCH /account/settings/update