<% user.full_name %>
<% util.level ? util.level.title : '' %>
Explorer Pioneer Apollo Viking Voyager Pathfinder Orion
Points
<% user.points ? user.points.toLocaleString() : 0 %>
Badges
<% util.badgeCount %>
Streaks
Congratulations You've <% util.newestBadge.isCurriculum ? 'completed' : 'earned' %> the
<% util.newestBadge.title %> <% util.newestBadge.isCurriculum ? 'curriculum' : 'badge' %>!
previous
next
Share to Social Media
Linked In Facebook
Status
<% util.level ? util.level.title : '' %>
<% util.level ? util.level.points : '' %>
<% util.nextLevel ? util.nextLevel.title : '' %>
<% util.nextLevel ? util.nextLevel.points : '' %>
Level up! <% util.levelPointsRemaining %> points to go
Level up! <% util.levelPointsRemaining %> points to go
Badges
Completed Hitchhikers Track Completed Content Track Completed Pages Track Completed Page Builder Track Completed Search Backend Track Completed Search Frontend Theme Track Completed Search UI React Track Completed Solution Templates and the Admin Console Track Completed Technical Skills Track Completed Platform Basics Track Completed Listings Track Completed Reviews Track Completed Industry Overview Track Completed Analytics Track Completed Industry Overview & Product Basics Track Completed Multi-Language Experiences Track Completed Chat Track
<% util.expandBadges ? 'Less' : 'More' %>
Playground Accounts
New +
No Playground Accounts
Create Playground +
View Profile
Log Out loading
Mission Complete! 🚀
Congratulations, you’ve completed your first module!

We hope you enjoy exploring the rest of the site. Please don’t forget to leave us feedback - we are constantly looking to improve. Happy Hitchhiking!
Home
Welcome to Hitchhikers! 👋
To learn more about the platform we encourage you to get started by completing the Hitchhikers Program Track and earning your first badge!
Start Here
Close notification
Guide
Migrating from v1 to v2
Arrow Back
Completed
Introduction
Introduction
completed
Completed 1
Step 1
Subscriptions Replaced with Services
completed
Completed 2
Step 2
Consolidated API Workflow
completed
Completed 3
Step 3
Detailed Agreement API Endpoint Changes
completed
home

Step 3: Detailed Agreement API Endpoint Changes

Note that in all v2 requests below, accountId is the account ID you are provisioning from. For Portal partners, this account is generally your top-level account.

Get Available Offers for a customer/account

Old API Request:

  • Offers List – GET https://api.yextapis.com/v1/offers
  • Response: List of Offers

New API Request:

  • Available Services: List – GET https://api.yextapis.com/v2/accounts/{accountId}/availableservices
  • Response: List of Available Services

Key Change:

  • Offer id is replaced with sku

Get existing customers/accounts

Old API Request:

  • Customers List – GET https://api.yextapis.com/v1/customers
  • Response: List of Customers

New API Request:

  • Accounts: List – GET https://api.yextapis.com/v2/accounts/
  • Response: List of Accounts

Create Customer Request with Single Location and Subscribe Location

Old API Request:

  • POST https://api.yextapis.com/v1/customers/
  • Response: 201 or 202 Success Response

New API Request:

  • Add Requests: Create (New Location) – POST https://api.yextapis.com/v2/accounts/{accountId}/newlocationaddrequests
  • Response: Add Service Request Object

Create Customer Request Multiple Location and Subscribe Locations

Old API Request:

  • POST https://api.yextapis.com/v1/customers/
    • Response: 201 or 202 Success Response

New API Request:

  • Multiple Add Requests: Create (New Location) – POST https://api.yextapis.com/v2/accounts/{accountId}/newlocationaddrequests
  • Note you will need to issue one call per location
  • Response: Add Service Request Object

Key Change:

  • You cannot create a multi-location account with a single API request

Subscribe an Existing Location

Old API Request:

  • PUT https://api.yextapis.com/v1/customers/customerId/subscriptions/subscriptionId/locationIds/locationId
  • Response: 201 or 202 Success Response

New API Request:

  • Multiple Add Requests: Create (Existing Location) – POST https://api.yextapis.com/v2/accounts/{accountId}/existinglocationaddrequests
  • Note you will need to issue one call per location
  • Response: Add Service Request Object

Check Order Status

Old API Request:

  • GET https://api.yextapis.com/v1/ofers/orderId
  • Response: Order Object

New API Request:

  • Add Requests: Get – GET https://api.yextapis.com/v2/accounts/{accountId}/addRequests/[addRequestId]
  • Response: Add Service Request Object

Cancel Subscription

Old API Request:

  • PUT https://api.yextapis.com/v1/customers/customerId/subscriptions/subscriptionId/locationIds/locationId
  • Response: 200 Response

New API Request:

  • Services: Cancel – POST https://api.yextapis.com/v2/accounts/{accountId}/cancelservices
  • Response: List of Service Objects

Uncancel Subscription

Old API Request:

  • PUT https://api.yextapis.com/v1/customers/customerId/subscriptions/subscriptionId/locationIds
  • Response: 200 Response

New API Request:

  • This functionality is not explicitly supported in v2. Create a new Service using Add Request: Create (Existing Location).

Update Customer Information

Old API Request:

  • PUT https://api.yextapis.com/v1/customers/customerId
  • Response: 201 or 202 Success Response

New API Request:

  • Update request not supported in v2
<% elem.innerText %>