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

Jan 2, 2025

main
1.2.0
Compare
1.2.0

API structure has changed

Next Change

🚨 Breaking API change detected:

Added (12)

  • GET /chat/room/{room}
  • GET /company/speak_with_serch/issues/{ticket}
  • GET /rating/bad/{id}
  • GET /rating/chart/{id}
  • GET /rating/good/{id}
  • GET /schedule/history/active
  • GET /schedule/history/requested
  • GET /trip/history/active
  • GET /trip/history/requested
  • GET /trip/history/shared
  • PATCH /account/update/e2ee
  • POST /auth/email/verify/pending

Modified (39)

  • DELETE /business/associate/delete
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: chart, good, bad
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
  • GET /account/dashboard/business
    • Query parameters added: page, size
  • [Breaking] GET /bookmark
    • Path went from /bookmark/all to /bookmark (same operationId) [Breaking]
  • [Breaking] GET /business/associate
    • Path went from /business/associate/all to /business/associate (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: chart, good, bad
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Query parameter added: q
  • GET /chat/room
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Property modified: groups
      • Properties added: total, type, public_encryption_key
  • [Breaking] GET /chat/room/{room}/messages
    • Path went from /chat/room/{room} to /chat/room/{room}/messages (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • [Breaking] Property modified: data
      • Type went from object to array[object] [Breaking]
      • [Breaking] Properties removed: room, roommate, name, avatar, category, image, label, message, status, count, bookmark, trip, schedule, groups, is_active, message_id, last_seen, is_bookmarked, sent_at
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Property added: ChatGroupMessageResponse
    • Query parameters added: page, size
  • GET /chat/rooms
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Property modified: groups
      • Properties added: total, type, public_encryption_key
    • Query parameters added: page, size
  • GET /company/speak_with_serch
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Properties added: total, has_serch_message
  • [Breaking] GET /rating/bad
    • Path went from /rating/all/bad to /rating/bad (same operationId) [Breaking]
  • [Breaking] GET /rating/good
    • Path went from /rating/all/good to /rating/good (same operationId) [Breaking]
  • [Breaking] GET /referral
    • Path went from /referral/all to /referral (same operationId) [Breaking]
  • [Breaking] GET /schedule/history
    • Path went from /trip/history to /schedule/history (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: id, mode, snt, skill, car, category, image, audio, problem, amount, address, placeId, latitude, longitude, status, type, provider, user, shared, timelines, quotations, authentication, location, show_cancel, show_auth, show_end, show_share, show_grant, show_deny, show_leave, show_notify_on_my_way, show_notify_arrival, requested_id, is_provider, waiting_for_quotation_response, try_service_payment_again, service_fee, user_share_fee, pending_payment_data, try_payment_again, shopping_location, shopping_items, total_amount, total_shopping_amount, total_amount_spent_in_shopping, created_at, updated_at
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Properties added: time, schedules
    • [Breaking] Query parameters removed: guest, link
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Query parameters added: status, category, date_time
  • GET /scope/account/user/rating
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Properties added: createdAt, updatedAt
  • GET /scope/support/speak-with-serch
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Properties modified: assigned, others
  • GET /scope/support/speak-with-serch/find
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Properties added: total, has_serch_message
  • [Breaking] GET /trip/history
    • Path went from /trip/invite to /trip/history (same operationId) [Breaking]
    • Query parameters added: shared, category, date_time
  • GET /wallet/transactions
    • Query parameters added: page, size
  • [Breaking] PATCH /account/update/fcm
    • Path went from /account/fcm/update to /account/update/fcm (same operationId) [Breaking]
  • [Breaking] PATCH /account/update/timezone
    • Path went from /account/update to /account/update/timezone (same operationId) [Breaking]
    • [Breaking] Query parameter removed: timezone
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Query parameter added: zone
  • PATCH /business/associate/activate
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: chart, good, bad
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
  • PATCH /business/associate/deactivate
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: chart, good, bad
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
  • PATCH /company/speak_with_serch/{ticket}
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Properties added: total, has_serch_message
  • [Breaking] PATCH /guest/update/fcm
    • Path went from /guest/fcm/update to /guest/update/fcm (same operationId) [Breaking]
  • [Breaking] PATCH /guest/update/timezone
    • Path went from /guest/update to /guest/update/timezone (same operationId) [Breaking]
    • [Breaking] Query parameter removed: timezone
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Query parameter added: zone
  • PATCH /scope/support/speak-with-serch/assign
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Properties added: total, has_serch_message
  • PATCH /scope/support/speak-with-serch/close
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Properties added: total, has_serch_message
  • PATCH /scope/support/speak-with-serch/resolve
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Properties added: total, has_serch_message
  • PATCH /shop/update/service
    • Content type modified: application/json
    • Properties added: id, shop, service
    • [Breaking] Query parameters removed: id, shop
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
  • POST /auth/business/category
    • Content type modified: application/json
    • [Breaking] Property removed: emailAddress
      • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Property added: token
    • Response modified: 200
    • Content type modified: */*
      • [Breaking] Property modified: data
      • Type went from string to object [Breaking]
      • Properties added: token, message, error_code
  • POST /auth/business/profile
    • Response modified: 200
    • Content type modified: */*
      • [Breaking] Property modified: data
      • Type went from string to object [Breaking]
      • Properties added: token, message, error_code
  • POST /auth/business/signup
    • Content type modified: application/json
    • [Breaking] Property removed: email_address
      • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Property added: token
  • POST /auth/provider/category
    • Content type modified: application/json
    • [Breaking] Property removed: emailAddress
      • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Property added: token
    • Response modified: 200
    • Content type modified: */*
      • [Breaking] Property modified: data
      • Type went from string to object [Breaking]
      • Properties added: token, message, error_code
  • POST /auth/provider/profile
    • Response modified: 200
    • Content type modified: */*
      • [Breaking] Property modified: data
      • Type went from string to object [Breaking]
      • Properties added: token, message, error_code
  • POST /auth/provider/signup
    • Content type modified: application/json
    • [Breaking] Property removed: email_address
      • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Property added: token
  • POST /business/associate/add
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: chart, good, bad
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
  • POST /company/speak_with_serch
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Properties added: total, has_serch_message
  • POST /scope/support/speak-with-serch/reply
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Properties added: total, has_serch_message
  • POST /shop/create/service
    • Content type modified: application/json
    • Properties added: id, service
    • [Breaking] Query parameter removed: shop
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
  • [Breaking] POST /shop/create/weekday/{id}
    • Path went from /shop/create/weekday to /shop/create/weekday/{id} (same operationId) [Breaking]
    • [Breaking] Query parameter removed: shop
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Path parameter added: id

Removed (2)

  • [Breaking] GET /schedule/all
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
  • [Breaking] GET /schedule/all/active
    • Removing a resource is always breaking unless it was deprecated before [Breaking]

Preview documentation

Powered by Bump.sh

53 structure changes including:
15 Breaking changes
12 Additions
39 Modifications
2 Removals
Modified 39 Breaking
POST /shop/create/weekday/{id}
  • Path went from /shop/create/weekday to /shop/create/weekday/{id} (same operationId)
    Breaking
  • Query
  • shop query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • id path parameter Added
GET /rating/good
  • Path went from /rating/all/good to /rating/good (same operationId)
    Breaking
GET /referral
  • Path went from /referral/all to /referral (same operationId)
    Breaking
GET /schedule/history
  • Path went from /trip/history to /schedule/history (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • id, mode, snt, skill, car, category, image, audio, problem, amount, address, placeId, latitude, longitude, status, type, provider, user, shared, timelines, quotations, authentication, location, show_cancel, show_auth, show_end, show_share, show_grant, show_deny, show_leave, show_notify_on_my_way, show_notify_arrival, requested_id, is_provider, waiting_for_quotation_response, try_service_payment_again, service_fee, user_share_fee, pending_payment_data, try_payment_again, shopping_location, shopping_items, total_amount, total_shopping_amount, total_amount_spent_in_shopping, created_at, updated_at properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • time, schedules properties Added
  • Query
  • guest, link query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • status, category, date_time query parameters Added
GET /scope/account/user/rating
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • createdAt, updatedAt properties Added
GET /scope/support/speak-with-serch
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • assigned, others properties Modified
GET /scope/support/speak-with-serch/find
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • total, has_serch_message properties Added
GET /trip/history
  • Path went from /trip/invite to /trip/history (same operationId)
    Breaking
  • Query
  • shared, category, date_time query parameters Added
GET /wallet/transactions
  • Query
  • page, size query parameters Added
PATCH /account/update/fcm
  • Path went from /account/fcm/update to /account/update/fcm (same operationId)
    Breaking
PATCH /account/update/timezone
  • Path went from /account/update to /account/update/timezone (same operationId)
    Breaking
  • Query
  • timezone query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • zone query parameter Added
PATCH /business/associate/activate
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • chart, good, bad properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PATCH /business/associate/deactivate
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • chart, good, bad properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PATCH /company/speak_with_serch/{ticket}
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • total, has_serch_message properties Added
PATCH /guest/update/fcm
  • Path went from /guest/fcm/update to /guest/update/fcm (same operationId)
    Breaking
PATCH /guest/update/timezone
  • Path went from /guest/update to /guest/update/timezone (same operationId)
    Breaking
  • Query
  • timezone query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • zone query parameter Added
PATCH /scope/support/speak-with-serch/assign
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • total, has_serch_message properties Added
PATCH /scope/support/speak-with-serch/close
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • total, has_serch_message properties Added
PATCH /scope/support/speak-with-serch/resolve
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • total, has_serch_message properties Added
PATCH /shop/update/service
  • Body
  • application/json content type Modified
    • id, shop, service properties Added
  • Query
  • id, shop query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /auth/business/category
  • Body
  • application/json content type Modified
    • emailAddress property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • token property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from string to object
          Breaking
        • token, message, error_code properties Added
POST /shop/create/service
  • Body
  • application/json content type Modified
    • id, service properties Added
  • Query
  • shop query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /scope/support/speak-with-serch/reply
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • total, has_serch_message properties Added
POST /company/speak_with_serch
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • total, has_serch_message properties Added
POST /business/associate/add
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • chart, good, bad properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /auth/provider/signup
  • Body
  • application/json content type Modified
    • email_address property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • token property Added
POST /auth/provider/profile
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from string to object
          Breaking
        • token, message, error_code properties Added
POST /auth/provider/category
  • Body
  • application/json content type Modified
    • emailAddress property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • token property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from string to object
          Breaking
        • token, message, error_code properties Added
POST /auth/business/signup
  • Body
  • application/json content type Modified
    • email_address property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • token property Added
POST /auth/business/profile
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from string to object
          Breaking
        • token, message, error_code properties Added
DELETE /business/associate/delete
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • chart, good, bad properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /account/dashboard/business
  • Query
  • page, size query parameters Added
GET /bookmark
  • Path went from /bookmark/all to /bookmark (same operationId)
    Breaking
GET /business/associate
  • Path went from /business/associate/all to /business/associate (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • chart, good, bad properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
  • Query
  • q query parameter Added
GET /chat/room
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • groups property Modified
        • total, type, public_encryption_key properties Added
GET /chat/room/{room}/messages
  • Path went from /chat/room/{room} to /chat/room/{room}/messages (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from object to array[object]
          Breaking
        • room, roommate, name, avatar, category, image, label, message, status, count, bookmark, trip, schedule, groups, is_active, message_id, last_seen, is_bookmarked, sent_at properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • ChatGroupMessageResponse property Added
  • Query
  • page, size query parameters Added
GET /chat/rooms
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • groups property Modified
        • total, type, public_encryption_key properties Added
  • Query
  • page, size query parameters Added
GET /company/speak_with_serch
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • total, has_serch_message properties Added
GET /rating/bad
  • Path went from /rating/all/bad to /rating/bad (same operationId)
    Breaking
Removed 2 Breaking
GET /schedule/all
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /schedule/all/active
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 12
POST /auth/email/verify/pending
PATCH /account/update/e2ee
GET /trip/history/shared
GET /trip/history/requested
GET /trip/history/active
GET /schedule/history/requested
GET /schedule/history/active
GET /rating/good/{id}
GET /rating/chart/{id}
GET /rating/bad/{id}
GET /company/speak_with_serch/issues/{ticket}
GET /chat/room/{room}