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

Nov 28, 2024

main
1.1.17
Compare
1.1.17

API structure has changed

118 structure changes including:
34 Breaking changes
18 Additions
83 Modifications
17 Removals
Modified 83 Breaking
PATCH /organization/update
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • admin property Modified
PATCH /company/speak_with_serch/{ticket}
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • issues property Modified
GET /trip/search
  • Path went from /specialty/search to /trip/search (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer(int64) to string(uuid)
            Breaking
        • special property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • name, rating, distance, status, more, business, specializations, distance_in_km, verification_status properties Added
  • Query
  • query query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • phone, lat, lng query parameters Added
GET /specialty/search
  • Path went from /scope/payment/transaction/search to /specialty/search (same operationId)
    Breaking
  • Query
  • query query parameter Modified
    • Query parameter is now required
      Breaking
  • page, size query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • status, title, total, transactions properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • id, special, category, image, avatar properties Added
GET /shop
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • link property Added
GET /scope/support/speak-with-serch/find
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • issues, assignedAdmin, resolvedBy, closedBy, user properties Modified
GET /scope/support/speak-with-serch
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • assigned, others properties Modified
GET /scope/support/complaint/all
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • complaints property Modified
GET /scope/support/complaint
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • complaints property Modified
GET /scope/support/chart/speak-with-serch
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • challenges, devices, sessions, users, providers, businesses, associates, guests properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /scope/support/chart/complaint
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • challenges, devices, sessions, users, providers, businesses, associates, guests properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /scope/support
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • complaintChart, speakWithSerchChart properties Modified
GET /scope/shop/find
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • shop, profile properties Modified
GET /scope/shop/chart
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • challenges, devices, sessions, users, providers, businesses, associates, guests properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /scope/shop/all
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • shop, profile properties Modified
GET /scope/shop
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • chart property Modified
GET /scope/sharing/request/overview
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • onlineChart, offlineChart properties Modified
GET /scope/sharing/request/chart/online
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • challenges, devices, sessions, users, providers, businesses, associates, guests properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /scope/sharing/request/chart/offline
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • challenges, devices, sessions, users, providers, businesses, associates, guests properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /scope/sharing/request/all/online
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • profile property Modified
GET /scope/sharing/request/all/offline
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • profile property Modified
GET /scope/sharing/provide/overview
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • chart property Modified
GET /scope/sharing/provide/chart
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • challenges, devices, sessions, users, providers, businesses, associates, guests properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /scope/platform/account/section/search
  • Path went from /location/search/place to /scope/platform/account/section/search (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • 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
        • accounts, total, total_pages properties Added
  • Query
  • id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • role, page, size, q query parameters Added
GET /scope/platform/account/section/metric
  • Path went from /scope/admin to /scope/platform/account/section/metric (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • profile, team, activities, auth, structure, mfa, challenges, sessions, analysis properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • header, count, feature properties Added
  • Query
  • id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • role query parameter Added
POST /shop/create/service
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • link property Added
POST /shop/create
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • link property Added
POST /scope/support/speak-with-serch/reply
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • issues, assignedAdmin, resolvedBy, closedBy, user properties Modified
POST /organization/add
  • Path went from /scope/countries-in-serch/launched/state to /organization/add (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • id, state 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
        • id, country, flag, emoji, code, dialCode, states, status, createdAt, updatedAt properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • OrganizationResponse property Added
POST /nearby/drive/search
  • Path went from /trip/search to /nearby/drive/search (same operationId)
    Breaking
  • Verb went from GET to POST (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from array[object] to string
          Breaking
  • Query
  • phone, lat, lng query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Body
  • application/json content type Added
POST /nearby/drive
  • Path went from /shop/search to /nearby/drive (same operationId)
    Breaking
  • Verb went from GET to POST (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from array[object] to string
          Breaking
  • Query
  • c, q, lng, lat, radius, scope query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Body
  • application/json content type Added
POST /company/speak_with_serch
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • issues property Modified
POST /business/associate/add
  • Path went from /scope/countries-in-serch/launched/country to /business/associate/add (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • country, emoji, flag, dialCode, code properties 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
        • id, country, flag, emoji, code, dialCode, states, createdAt, updatedAt properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • profile, chart, good, bad, verified properties Added
POST /bookmark/add
  • Path went from /organization/add to /bookmark/add (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • email_address, first_name, last_name, phone_number, username, avatar, instagram, twitter, linkedIn, position properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • user property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from array[object] to string
          Breaking
POST /auth/admin/invite
  • Path went from /business/associate/add to /auth/admin/invite (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • gender, category, specialties, consent, phone_information properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • role, position, department, scopes properties Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • Type went from array[object] to string
          Breaking
PATCH /specialty/add
  • Path went from /bookmark/add to /specialty/add (same operationId)
    Breaking
  • Verb went from POST 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
  • Body
  • application/json content type Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • specialty query parameter Added
PATCH /shop/update/weekday
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • link property Added
PATCH /shop/update/service
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • link property Added
PATCH /shop/update
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • link property Added
PATCH /shop/status/all
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • link property Added
PATCH /shop/status
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • link property Added
PATCH /scope/support/speak-with-serch/resolve
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • issues, assignedAdmin, resolvedBy, closedBy, user properties Modified
PATCH /scope/support/speak-with-serch/close
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • issues, assignedAdmin, resolvedBy, closedBy, user properties Modified
PATCH /scope/support/speak-with-serch/assign
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • issues, assignedAdmin, resolvedBy, closedBy, user properties Modified
PATCH /scope/support/complaint/resolve
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • complaints property Modified
PATCH /scope/payment/transaction/resolve
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • sender, recipient properties Modified
PATCH /scope/payment/payout/pay/batch
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • admin, user properties Modified
PATCH /scope/payment/payout/pay
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • transactions property Modified
PATCH /scope/payment/payout/cancel/batch
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • admin, user properties Modified
PATCH /scope/payment/payout/cancel
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • transactions property Modified
GET /scope/platform/account/analysis/more/{year}
  • Path went from /call to /scope/platform/account/analysis/more/{year} (same operationId)
    Breaking
  • 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
        • PlatformAccountScopeMoreAnalysisResponse property Added
  • Query
  • channel query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • role query parameter Added
  • Path
  • year path parameter Added
GET /scope/call/chart/performance
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • challenges, devices, sessions, users, providers, businesses, associates, guests properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /scope/call/all/voice
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • caller, called properties Modified
GET /scope/call/all/tip2fix
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • caller, called properties Modified
GET /scope/admin/chart/auth
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • challenges, devices, sessions, users, providers, businesses, associates, guests properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /scope/admin/chart/account/status
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • challenges, devices, sessions, users, providers, businesses, associates, guests properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /organization/all
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • admin property Modified
GET /company/speak_with_serch
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • issues property Modified
GET /business/associate/resend
  • Path went from /auth/admin/invite to /business/associate/resend (same operationId)
    Breaking
  • Verb went from POST to GET (same operationId)
    Breaking
  • Body
  • application/json content type Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • id query parameter Added
GET /admin/team/overview
  • Path went from /scope/call/overview to /admin/team/overview (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • years, tip2fixChart, voiceCallChart, tip2fixPerformance properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • teams, activities, structure properties Added
GET /active/search/category
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • shops property Modified
GET /active/search
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • shops property Modified
DELETE /shop/remove/weekday
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • link property Added
DELETE /shop/remove/service
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • link property Added
DELETE /shop/remove
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • link property Added
DELETE /organization/{id}
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • admin property Modified
POST /shop/create/weekday
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • link property Added
GET /scope/platform/account/analysis/more
  • Path went from /certificate to /scope/platform/account/analysis/more (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • isGenerated, reason, data, instructions properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • section, demographics, geographics, activities, overview, states, categories, countries properties Added
  • Query
  • role query parameter Added
GET /scope/payment/wallet/all
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • transactions property Modified
GET /scope/payment/wallet
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • profile property Modified
GET /scope/payment/transaction/search
  • Path went from /admin/permission/search 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, name, avatar, role, scopes 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
GET /scope/payment/transaction/resolved/search
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • transactions property Modified
GET /scope/payment/transaction/resolved/range
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • transactions property Modified
GET /scope/payment/transaction/resolved/find
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • transaction, admin properties Modified
GET /scope/payment/transaction/resolved
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • transactions property Modified
GET /scope/payment/transaction/filter
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • transactions property Modified
GET /scope/payment/transaction/all
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • transactions property Modified
GET /scope/payment/transaction
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • sender, recipient properties Modified
GET /scope/payment/payout/all
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • transactions property Modified
GET /scope/payment/payout
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • admin, user properties Modified
GET /scope/call/overview
  • Path went from /scope/countries-in-serch to /scope/call/overview (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • launchedCountryChart, launchedStateChart, requestedCountryChart, requestedStateChart, launchedMetrics, requestedMetrics properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • overview, tip2fixChart, voiceCallChart, tip2fixPerformance properties Added
GET /scope/call/chart/voice
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • challenges, devices, sessions, users, providers, businesses, associates, guests properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /scope/call/chart/tip2fix
  • Response
  • 200 response Modified
    • */* content type Modified
      • data property Modified
        • challenges, devices, sessions, users, providers, businesses, associates, guests properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
Removed 17 Breaking
GET /scope/countries-in-serch/launched/country/chart
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /scope/countries-in-serch/launched/state/chart
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /scope/countries-in-serch/requested
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /scope/countries-in-serch/requested/country/chart
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /scope/countries-in-serch/requested/state/chart
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /shop/drive/categories
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /scope/countries-in-serch/launched/country
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /specialty/add
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /company/countries/request
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /scope/countries-in-serch/launched
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /company/countries/verify
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /business/associate/resend
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /admin/team/overview
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /scope/countries-in-serch/requested/state
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /scope/countries-in-serch/requested/country
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /scope/countries-in-serch/launched/state
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /scope/countries-in-serch/launched/country
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 18
GET /admin/permission/search
GET /call
GET /certificate
GET /scope/admin
GET /scope/common/years
GET /scope/platform/account/analysis
GET /scope/platform/account/analysis/category
GET /scope/platform/account/analysis/certification
GET /scope/platform/account/analysis/country
GET /scope/platform/account/analysis/gender
GET /scope/platform/account/analysis/rating
GET /scope/platform/account/analysis/state
GET /scope/platform/account/analysis/status
GET /scope/platform/account/analysis/timezone
GET /scope/platform/account/analysis/trip
GET /scope/platform/account/section
GET /shop/search
POST /auth/nearby/register