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

Changelog

Last update:
Compare

🚨 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
43 structure changes including:
38 Breaking changes
3 Additions
39 Modifications
1 Removal

🚨 Breaking API change detected:

Added (28)

  • GET /bookmark/all
  • GET /call/auth
  • GET /profile/business
  • GET /schedule/all
  • GET /schedule/all/times/{provider}
  • GET /scope/account/activities
  • GET /scope/account/analysis
  • GET /scope/account/associates
  • GET /scope/account/calls
  • GET /scope/account/certificate
  • GET /scope/account/challenges
  • GET /scope/account/chart/account/status
  • GET /scope/account/chart/auth
  • GET /scope/account/chat/rooms
  • GET /scope/account/rating
  • GET /scope/account/referral
  • GET /scope/account/referrals
  • GET /scope/account/reports
  • GET /scope/account/sessions
  • GET /scope/account/shared/accounts
  • GET /scope/account/shared/links
  • GET /scope/account/shops
  • GET /scope/account/tickets
  • GET /scope/account/transactions
  • GET /scope/account/trips
  • GET /scope/account/wallet
  • PATCH /scope/auth/devices
  • PATCH /scope/auth/sessions

Modified (38)

  • GET /active/search
    • Query parameters added: page, size
  • GET /active/search/category
    • Query parameters added: page, size
  • GET /active/status/all
    • Query parameters added: page, size
  • GET /admin/profile
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Property modified: profile
  • GET /admin/team/all
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Property modified: admins
  • GET /business/associate/all
    • Query parameters added: page, size
  • [Breaking] GET /call/authentication
    • Path went from /call/auth to /call/authentication (same operationId) [Breaking]
    • [Breaking] Query parameter removed: channel
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
  • GET /call/history
    • Query parameters added: page, size
  • GET /company/speak_with_serch
    • Query parameters added: page, size
  • GET /guest/shared/links
    • Query parameters added: page, size
  • [Breaking] GET /profile
    • Path went from /profile/business to /profile (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: name, description, address, contact, logo, default_password
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Properties added: status, certificate, business_information
  • GET /rating/all
    • Query parameters added: page, size
  • GET /rating/all/bad
    • Query parameters added: page, size
  • GET /rating/all/good
    • Query parameters added: page, size
  • GET /referral/all
    • Query parameters added: page, size
  • [Breaking] GET /scope/account
    • Path went from /profile to /scope/account (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: category, image, gender, status, certificate, rating, more, specializations, phone_info, verification_status, business_information
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Properties added: details, active, organization, additional, delete, device, setting, verification, skills, created_at, updated_at, account_created_at, account_updated_at, profile_created_at, profile_updated_at, email_confirmed_at, password_updated_at, last_signed_in, app_rating, phone_information
    • Query parameter added: id
  • [Breaking] GET /scope/account/analysis/more
    • Path went from /scope/platform/account/analysis/more/{year} to /scope/account/analysis/more (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • [Breaking] Property modified: data
      • Type went from array[object] to object [Breaking]
      • Properties added: section, demographics, geographics, activities, overview, states, categories, countries
    • [Breaking] Path parameter removed: year
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
  • [Breaking] GET /scope/account/analysis/more/{year}
    • Path went from /scope/admin to /scope/account/analysis/more/{year} (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • [Breaking] Property modified: data
      • Type went from object to array[object] [Breaking]
      • [Breaking] Properties removed: profile, team, activities, auth, structure, mfa, challenges, sessions, analysis
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Property added: AccountScopeMoreAnalysisResponse
    • [Breaking] Query parameter removed: id
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Path parameter added: year
    • Query parameter added: role
  • [Breaking] GET /scope/account/auth
    • Path went from /call/authentication to /scope/account/auth (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • [Breaking] Property modified: data
      • Type went from string to object [Breaking]
      • Properties added: method, level, devices, mfa, has_mfa, must_have_mfa
    • Query parameters added: id, page, size
  • [Breaking] GET /scope/account/bookmarks
    • Path went from /bookmark/all to /scope/account/bookmarks (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: name, avatar, user, category, rating, last_signed_in
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Properties added: created_at, updated_at
    • Query parameters added: id, page, size
  • [Breaking] GET /scope/account/schedule/times
    • Path went from /schedule/all/times/{provider} to /scope/account/schedule/times (same operationId) [Breaking]
    • [Breaking] Path parameter removed: provider
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Query parameter added: id
  • [Breaking] GET /scope/account/schedules
    • Path went from /schedule/all to /scope/account/schedules (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: label, schedules
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Properties added: address, latitude, longitude, status, reason, id, closed_by, closed_at, closed_on_time, created_at, updated_at
    • Query parameters added: id, page, size
  • [Breaking] GET /scope/account/section
    • Path went from /scope/platform/account/section to /scope/account/section (same operationId) [Breaking]
  • [Breaking] GET /scope/account/section/metric
    • Path went from /scope/platform/account/analysis/more to /scope/account/section/metric (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: section, demographics, geographics, activities, overview, states, categories, countries
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Properties added: header, count, feature
  • [Breaking] GET /scope/account/section/search
    • Path went from /scope/payment/transaction/search to /scope/account/section/search (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • [Breaking] Property modified: data
      • Type went from array[object] to object [Breaking]
      • Properties added: accounts, total, total_pages
    • [Breaking] Query parameter removed: query
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Query parameters added: role, q
  • [Breaking] GET /scope/admin
    • Path went from /scope/platform/account/section/metric to /scope/admin (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: header, count, feature
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Properties added: profile, team, activities, auth, structure, mfa, challenges, sessions, analysis
    • [Breaking] Query parameter removed: role
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Query parameters added: id, page, size
  • GET /scope/admin/chart/account/status
    • Query parameter modified: year
    • Query parameter is no longer required
  • GET /scope/admin/chart/auth
    • Query parameter modified: year
    • Query parameter is no longer required
  • [Breaking] GET /scope/payment/transaction/search
    • Path went from /scope/platform/account/section/search to /scope/payment/transaction/search (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • [Breaking] Property modified: data
      • Type went from object to array[object] [Breaking]
      • [Breaking] Properties removed: accounts, total, total_pages
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Property added: PaymentApiResponseTransactionGroupScopeResponse
    • [Breaking] Query parameters removed: role, q
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Query parameter added: query
  • GET /shop
    • Query parameters added: page, size
  • GET /shop/search
    • Query parameters added: page, size
  • GET /specialty/all
    • Query parameters added: page, size
  • GET /specialty/search
    • Query parameters added: page, size
  • GET /trip/history
    • Query parameters added: page, size
  • GET /trip/invite
    • Query parameters added: page, size
  • GET /trip/search
    • Query parameters added: page, size
  • PATCH /admin/profile/update
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Property modified: profile
  • PATCH /admin/profile/upload
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Property modified: profile

Preview documentation

168 structure changes including:
40 Breaking changes
46 Additions
105 Modifications
17 Removals
118 structure changes including:
34 Breaking changes
18 Additions
83 Modifications
17 Removals
97 structure changes including:
30 Breaking changes
15 Additions
65 Modifications
17 Removals
4 structure changes including:
1 Addition
3 Modifications
3 structure changes including:
3 Modifications
39 structure changes including:
16 Breaking changes
23 Additions
16 Modifications
10 structure changes including:
2 Additions
8 Modifications
20 structure changes including:
4 Breaking changes
5 Additions
15 Modifications
1 structure change including:
1 Addition
Added 1
GET /server/openapi/generate