lib/config/api.yml in yext-api-0.1.1 vs lib/config/api.yml in yext-api-0.1.3

- old
+ new

@@ -1,101 +1,90 @@ :administrative_api: :documentation: http://developer.yext.com/docs/administrative-api :objects: :account: :actions: - - :action: :create - :method: :post - :endpoint: https://api.yext.com/v2/accounts/{accountId}/newlocationaddrequests - :path_regex: v2/accounts/[^/]+?/newlocationaddrequests - :default_version: 20161012 - :documentation: http://developer.yext.com/docs/administrative-api/#operation/createNewLocationAddRequest - :comment: Request that a new location be added and services added to it. The location is created only if the request succeeds. - :sandbox_only: false - - :action: :add_services - :method: :post - :endpoint: https://api.yext.com/v2/accounts/{accountId}/existinglocationaddrequests - :path_regex: v2/accounts/[^/]+?/existinglocationaddrequests - :default_version: 20161012 - :documentation: http://developer.yext.com/docs/administrative-api/#operation/createExistingLocationAddRequest - :comment: Request that one or more available services be added to an existing location. - :sandbox_only: false - - :action: :change_status - :method: :post - :endpoint: https://api.yext.com/v2/accounts/{accountId}/processaddrequest - :path_regex: v2/accounts/[^/]+?/processaddrequest - :default_version: 20161012 - :documentation: http://developer.yext.com/docs/administrative-api/#operation/createProcessReviewAddRequest - :comment: Request that an add request in REVIEW be processed to COMPLETE, CANCELED, or FAILED. - :sandbox_only: true - :action: :index :method: :get # :endpoint: https://api.yext.com/v2/accounts # :path_regex: v2/accounts :default_version: 20161012 :documentation: http://developer.yext.com/docs/administrative-api/#operation/listAccounts - :comment: List all accounts that you have access to. Unless you are in Partner Portal mode, this will only be your own account. :sandbox_only: false - :action: :show :method: :get # :endpoint: https://api.yext.com/v2/accounts/{accountId} # :path_regex: v2/accounts/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/administrative-api/#operation/getAccount - :comment: Get details for an account. :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId} :path_regex: v2/accounts/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/administrative-api/#operation/updateAccount - :comment: Update an account's name or ID. :sandbox_only: false :add_request: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/addrequests :path_regex: v2/accounts/[^/]+?/addrequests :default_version: 20161012 :documentation: http://developer.yext.com/docs/administrative-api/#operation/listAddRequests - :comment: Get all of the add requests in the account. The response includes both New Location Add Requests and Existing Location Add Requests. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/addrequests/{addRequestId} - :path_regex: v2/accounts/[^/]+?/addrequests/[^/]+?? + :path_regex: v2/accounts/[^/]+?/addrequests/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/administrative-api/#operation/getAddRequest - :comment: Get status information about an add request previously created. :sandbox_only: false + - :action: :create + :method: :post + :endpoint: https://api.yext.com/v2/accounts/{accountId}/newlocationaddrequests + :path_regex: v2/accounts/[^/]+?/newlocationaddrequests + :default_version: 20161012 + :documentation: http://developer.yext.com/docs/administrative-api/#operation/createNewLocationAddRequest + :sandbox_only: false + - :action: :change_status + :method: :post + :endpoint: https://api.yext.com/v2/accounts/{accountId}/processaddrequest + :path_regex: v2/accounts/[^/]+?/processaddrequest + :default_version: 20161012 + :documentation: http://developer.yext.com/docs/administrative-api/#operation/createProcessReviewAddRequest + :sandbox_only: true + - :action: :add_services + :method: :post + :endpoint: https://api.yext.com/v2/accounts/{accountId}/existinglocationaddrequests + :path_regex: v2/accounts/[^/]+?/existinglocationaddrequests + :default_version: 20161012 + :documentation: http://developer.yext.com/docs/administrative-api/#operation/createExistingLocationAddRequest + :sandbox_only: false :service: :actions: - :action: :available :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/availableservices :path_regex: v2/accounts/[^/]+?/availableservices :default_version: 20161012 :documentation: http://developer.yext.com/docs/administrative-api/#operation/listAvailableServices - :comment: Return list of services available to you under your agreements. :sandbox_only: false - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/services :path_regex: v2/accounts/[^/]+?/services :default_version: 20161012 :documentation: http://developer.yext.com/docs/administrative-api/#operation/listServices - :comment: Retrieve a list of all services provisioned through this account. :sandbox_only: false - :action: :destroy :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/cancelservices :path_regex: v2/accounts/[^/]+?/cancelservices :default_version: 20161012 :documentation: http://developer.yext.com/docs/administrative-api/#operation/cancelServices - :comment: Cancel one or more active services. :sandbox_only: false :knowledge_api: :documentation: http://developer.yext.com/docs/api-reference/ :health_check: :objects: @@ -105,11 +94,10 @@ :method: :get :endpoint: https://api.yext.com/v2/healthy :path_regex: v2/healthy :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/healthCheck - :comment: The Health Check endpoint allows you to monitor the status of Yext's systems. :sandbox_only: false :knowledge_manager: :objects: :location: :has_many: language_profiles @@ -118,601 +106,530 @@ :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/locations :path_regex: v2/accounts/[^/]+?/locations :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getLocations - :comment: Get multiple Locations (primary profiles only). :sandbox_only: false - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/locations :path_regex: v2/accounts/[^/]+?/locations :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createLocation - :comment: Create a new Location. :sandbox_only: false - :action: :search :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/locationsearch :path_regex: v2/accounts/[^/]+?/locationsearch :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/searchLocations - :comment: Get multiple Locations (primary profiles only) that match provided filters. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId} - :path_regex: v2/accounts/[^/]+?/locations/[^/]+?? + :path_regex: v2/accounts/[^/]+?/locations/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getLocation - :comment: Gets the primary profile for a single Location. :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId} - :path_regex: v2/accounts/[^/]+?/locations/[^/]+?? + :path_regex: v2/accounts/[^/]+?/locations/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateLocation - :comment: Updates the primary profile for a Location. :sandbox_only: false :folder: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/folders :path_regex: v2/accounts/[^/]+?/folders :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getLocationFolders - :comment: Returns a list of Location Folders in an Account. :sandbox_only: false :menu: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/menus :path_regex: v2/accounts/[^/]+?/menus :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getMenus - :comment: Retrieve all Menus for an account. :sandbox_only: false - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/menus :path_regex: v2/accounts/[^/]+?/menus :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createMenu - :comment: Create a new Menu. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/menus/{listId} - :path_regex: v2/accounts/[^/]+?/menus/[^/]+?? + :path_regex: v2/accounts/[^/]+?/menus/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getMenu - :comment: Retrieve a specific Menu. :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/menus/{listId} - :path_regex: v2/accounts/[^/]+?/menus/[^/]+?? + :path_regex: v2/accounts/[^/]+?/menus/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateMenu - :comment: Update an existing Menu. :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/menus/{listId} - :path_regex: v2/accounts/[^/]+?/menus/[^/]+?? + :path_regex: v2/accounts/[^/]+?/menus/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteMenuList - :comment: Delete an existing Menu. :sandbox_only: false :bio: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/bios :path_regex: v2/accounts/[^/]+?/bios :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getBios - :comment: Retrieve all Bio Lists for an account. :sandbox_only: false - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/bios :path_regex: v2/accounts/[^/]+?/bios :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createBio - :comment: Create a new Bio List. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/bios/{listId} - :path_regex: v2/accounts/[^/]+?/bios/[^/]+?? + :path_regex: v2/accounts/[^/]+?/bios/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getBio - :comment: Retrieve a specific Bio List. :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/bios/{listId} - :path_regex: v2/accounts/[^/]+?/bios/[^/]+?? + :path_regex: v2/accounts/[^/]+?/bios/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateBio - :comment: Update an existing Bio List. :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/bios/{listId} - :path_regex: v2/accounts/[^/]+?/bios/[^/]+?? + :path_regex: v2/accounts/[^/]+?/bios/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteBioList - :comment: Delete an existing Bios List. :sandbox_only: false :product: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/products :path_regex: v2/accounts/[^/]+?/products :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getProducts - :comment: Retrieve all Product Lists for an account. :sandbox_only: false - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/products :path_regex: v2/accounts/[^/]+?/products :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createProduct - :comment: Create a new Product List. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/products/{listId} - :path_regex: v2/accounts/[^/]+?/products/[^/]+?? + :path_regex: v2/accounts/[^/]+?/products/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getProduct - :comment: Retrieve a specific Product List. :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/products/{listId} - :path_regex: v2/accounts/[^/]+?/products/[^/]+?? + :path_regex: v2/accounts/[^/]+?/products/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateProduct - :comment: Update an existing Product List. :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/products/{listId} - :path_regex: v2/accounts/[^/]+?/products/[^/]+?? + :path_regex: v2/accounts/[^/]+?/products/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteProductList - :comment: Delete an existing Products List. :sandbox_only: false :event: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/events :path_regex: v2/accounts/[^/]+?/events :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getEvents - :comment: Retrieve all Event Lists for an account. :sandbox_only: false - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/events :path_regex: v2/accounts/[^/]+?/events :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createEvent - :comment: Create a new Event List. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/events/{listId} - :path_regex: v2/accounts/[^/]+?/events/[^/]+?? + :path_regex: v2/accounts/[^/]+?/events/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getEvent - :comment: Retrieve a specific Event List. :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/events/{listId} - :path_regex: v2/accounts/[^/]+?/events/[^/]+?? + :path_regex: v2/accounts/[^/]+?/events/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateEvent - :comment: Update an existing Event List. :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/events/{listId} - :path_regex: v2/accounts/[^/]+?/events/[^/]+?? + :path_regex: v2/accounts/[^/]+?/events/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteEventList - :comment: Delete an existing Events List. :sandbox_only: false :category: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/categories :path_regex: v2/categories :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getBusinessCategories - :comment: Get available Categories. :sandbox_only: false :google_field: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/googlefields :path_regex: v2/googlefields :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getGoogleKeywords - :comment: > - Use the Google Fields endpoint to retrieve a complete list of Google's location attributes - for each business category. This list includes attributes that may not apply to all - Locations in an account. The set of attributes available to a Location depends on its - primary business category. You can view and edit the attributes of Locations in the - googleAttributes Location field. :sandbox_only: false :custom_field: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields :path_regex: v2/accounts/[^/]+?/customfields :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getCustomFields - :comment: Returns a list of Custom Fields in an Account. :sandbox_only: false - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields :path_regex: v2/accounts/[^/]+?/customfields :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createCustomField - :comment: Creates a new Custom Field in an Account. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields/{customFieldId} - :path_regex: v2/accounts/[^/]+?/customfields/[^/]+?? + :path_regex: v2/accounts/[^/]+?/customfields/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getCustomField - :comment: Gets a specific Custom Field in an Account. :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields/{customFieldId} - :path_regex: v2/accounts/[^/]+?/customfields/[^/]+?? + :path_regex: v2/accounts/[^/]+?/customfields/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateCustomField - :comment: Updates a single Custom Field in an Account. :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields/{customFieldId} - :path_regex: v2/accounts/[^/]+?/customfields/[^/]+?? + :path_regex: v2/accounts/[^/]+?/customfields/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteCustomField - :comment: Deletes a Custom Field in an Account. :sandbox_only: false :language_profile: :belongs_to: location :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles - :path_regex: v2/accounts/[^/]+?/locations/[^/]+??/profiles + :path_regex: v2/accounts/[^/]+?/locations/[^/]+?/profiles :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getLanguageProfiles - :comment: Get Language Profiles for a Location. :sandbox_only: false - :action: :create :alias: :update - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/{language_code} - :path_regex: v2/accounts/[^/]+?/locations/[^/]+??/profiles/[^/]+?? + :path_regex: v2/accounts/[^/]+?/locations/[^/]+?/profiles/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getLanguageProfile - :comment: Gets the the requested Language Profile for a given Location. :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/{language_code} - :path_regex: v2/accounts/[^/]+?/locations/[^/]+??/profiles/[^/]+?? + :path_regex: v2/accounts/[^/]+?/locations/[^/]+?/profiles/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateLanguageProfile - :comment: Creates and / or sets the fields for a Language Profile :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/{language_code} - :path_regex: v2/accounts/[^/]+?/locations/[^/]+??/profiles/[^/]+?? + :path_regex: v2/accounts/[^/]+?/locations/[^/]+?/profiles/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteLanguageProfile - :comment: Remove a Language Profile from a location. :sandbox_only: false :asset: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/assets :path_regex: v2/accounts/[^/]+?/assets :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getAssets - :comment: List assets in an account. :sandbox_only: false - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/assets :path_regex: v2/accounts/[^/]+?/assets :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createAsset - :comment: Creates a new Asset in an account. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/assets/{assetId} - :path_regex: v2/accounts/[^/]+?/assets/[^/]+?? + :path_regex: v2/accounts/[^/]+?/assets/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getAsset - :comment: Get a specific asset. :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/assets/{assetId} - :path_regex: v2/accounts/[^/]+?/assets/[^/]+?? + :path_regex: v2/accounts/[^/]+?/assets/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateAsset - :comment: Update a specific asset. :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/assets/{assetId} - :path_regex: v2/accounts/[^/]+?/assets/[^/]+?? + :path_regex: v2/accounts/[^/]+?/assets/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteAsset - :comment: Delete a specific asset. :sandbox_only: false :power_listings: + :module_name: PowerListings :objects: :publishser: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/publishers :path_regex: v2/accounts/[^/]+?/powerlistings/publishers :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/listPublishers - :comment: Retrieve a list of publishers included in an account's subscription. :sandbox_only: false :listing: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/listings :path_regex: v2/accounts/[^/]+?/powerlistings/listings :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/listListings - :comment: Retrieve all Listings matching the given criteria including status and reasons why a Listing may be unavailable. :sandbox_only: false - :action: :opt_in :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/listings/optin :path_regex: v2/accounts/[^/]+?/powerlistings/listings/optin :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/optInListings - :comment: Opts designated locations into designated publishers. :sandbox_only: false - :action: :opt_out :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/listings/optout :path_regex: v2/accounts/[^/]+?/powerlistings/listings/optout :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/optOutListings - :comment: Opts designated locations out of designated publishers. :sandbox_only: false :publisher_suggestion: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/publishersuggestions :path_regex: v2/accounts/[^/]+?/powerlistings/publishersuggestions :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/listPublisherSuggestions - :comment: Retrieve suggestions publishers have submitted for the Locations in an account. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/publishersuggestions/{suggestionId} - :path_regex: v2/accounts/[^/]+?/powerlistings/publishersuggestions/[^/]+?? + :path_regex: v2/accounts/[^/]+?/powerlistings/publishersuggestions/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getPublisherSuggestion - :comment: Fetches details of a specific Publisher Suggestion. :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/publishersuggestions/{suggestionId} - :path_regex: v2/accounts/[^/]+?/powerlistings/publishersuggestions/[^/]+?? + :path_regex: v2/accounts/[^/]+?/powerlistings/publishersuggestions/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updatePublisherSuggestion - :comment: Accept or reject a Publisher Suggestion. :sandbox_only: false :duplicate: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/duplicates :path_regex: v2/accounts/[^/]+?/powerlistings/duplicates :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/listDuplicates - :comment: Retrieve Duplicates for an account. :sandbox_only: false - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/duplicates :path_regex: v2/accounts/[^/]+?/powerlistings/duplicates :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createDuplicate - :comment: Creates a new Duplicate with status SUPPRESSION_REQUESTED. :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/duplicates/{duplicateId} - :path_regex: v2/accounts/[^/]+?/powerlistings/duplicates/[^/]+?? + :path_regex: v2/accounts/[^/]+?/powerlistings/duplicates/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteDuplicate - :comment: Indicates that a Duplicate should be ignored. :sandbox_only: false - :action: :suppress :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/duplicates/{duplicateId} - :path_regex: v2/accounts/[^/]+?/powerlistings/duplicates/[^/]+?? + :path_regex: v2/accounts/[^/]+?/powerlistings/duplicates/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/suppressDuplicate - :comment: Request suppression of a Duplicate. :sandbox_only: false :analytics: + :module_name: Analytics :objects: :max_date: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/analytics/maxdates :path_regex: v2/accounts/[^/]+?/analytics/maxdates :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getMaxDates - :comment: The dates through which reporting data is available. :sandbox_only: false :report: :actions: - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/analytics/reports :path_regex: v2/accounts/[^/]+?/analytics/reports :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createReports - :comment: Begins the process of producing a report. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/analytics/standardreports/{reportId} - :path_regex: v2/accounts/[^/]+?/analytics/standardreports/[^/]+?? + :path_regex: v2/accounts/[^/]+?/analytics/standardreports/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/reportStatus - :comment: Checks the status of a Report created with async=true. :sandbox_only: false :activity: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/analytics/activity :path_regex: v2/accounts/[^/]+?/analytics/activity :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/activityLog - :comment: Fetches account activity information. :sandbox_only: false :reviews: + :module_name: Reviews :objects: :review: :has_many: comments :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews :path_regex: v2/accounts/[^/]+?/reviews :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/listReviews - :comment: Retrieve all Reviews matching the given criteria. :sandbox_only: false - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews :path_regex: v2/accounts/[^/]+?/reviews :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createReview - :comment: Create a new External First Party Review. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews/{reviewId} - :path_regex: v2/accounts/[^/]+?/reviews/[^/]+?? + :path_regex: v2/accounts/[^/]+?/reviews/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getReview - :comment: Retrieve a specific Review. :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews/{reviewId} - :path_regex: v2/accounts/[^/]+?/reviews/[^/]+?? + :path_regex: v2/accounts/[^/]+?/reviews/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateReview - :comment: Updates an External First Party Review. :sandbox_only: false :comment: :belongs_to: review :actions: - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews/{reviewId}/comments - :path_regex: v2/accounts/[^/]+?/reviews/[^/]+??/comments + :path_regex: v2/accounts/[^/]+?/reviews/[^/]+?/comments :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createComment - :comment: Creates a new Comment on a Review. :sandbox_only: false :review_invitation: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/reviewinvites :path_regex: v2/accounts/[^/]+?/reviewinvites :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/listReviewInvitations - :comment: Retrieves all review invitations for an account. :sandbox_only: false - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/reviewinvites :path_regex: v2/accounts/[^/]+?/reviewinvites :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createReviewInvites - :comment: Sends review invitations to one or more consumers. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/reviewinvites/{invitationId} - :path_regex: v2/accounts/[^/]+?/reviewinvites/[^/]+?? + :path_regex: v2/accounts/[^/]+?/reviewinvites/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getReviewInvitation - :comment: Retrieve a specific review invitation. :sandbox_only: false :review_generation_setting: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews/settings/generation :path_regex: v2/accounts/[^/]+?/reviews/settings/generation :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getReviewGenerationSettings - :comment: Returns all current generation settings for a specified account. :sandbox_only: false - :action: :create :alias: :update - :action: :update :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews/settings/generation :path_regex: v2/accounts/[^/]+?/reviews/settings/generation :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateReviewGenerationSettings - :comment: > - Updates any generation settings specified in a specified account. Call may include any/all - settings available to the account. Settings not included will remain unchanged. :sandbox_only: false :social: :objects: :post: :has_many: comments @@ -721,380 +638,328 @@ :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/posts :path_regex: v2/accounts/[^/]+?/posts :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getPosts - :comment: Retrieve list of Posts. :sandbox_only: false - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/posts :path_regex: v2/accounts/[^/]+?/posts :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createPosts - :comment: Create a new Post. :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId} - :path_regex: v2/accounts/[^/]+?/posts/[^/]+?? + :path_regex: v2/accounts/[^/]+?/posts/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deletePost - :comment: Deletes an existing Post. :sandbox_only: false :comment: :belongs_to: post :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId}/comments - :path_regex: v2/accounts/[^/]+?/posts/[^/]+??/comments + :path_regex: v2/accounts/[^/]+?/posts/[^/]+?/comments :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getComments - :comment: Retrieve list of Comments for a Post. :sandbox_only: false - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId}/comments - :path_regex: v2/accounts/[^/]+?/posts/[^/]+??/comments + :path_regex: v2/accounts/[^/]+?/posts/[^/]+?/comments :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createComment - :comment: Create a new Comment in response to another Post / Comment. :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId}/comments/{commentId} - :path_regex: v2/accounts/[^/]+?/posts/[^/]+??/comments/[^/]+?? + :path_regex: v2/accounts/[^/]+?/posts/[^/]+?/comments/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateComment - :comment: Updates an existing Comment. :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId}/comments/{commentId} - :path_regex: v2/accounts/[^/]+?/posts/[^/]+??/comments/[^/]+?? + :path_regex: v2/accounts/[^/]+?/posts/[^/]+?/comments/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteComment - :comment: Deletes an existing Comment. :sandbox_only: false :linked_account: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/linkedaccounts :path_regex: v2/accounts/[^/]+?/linkedaccounts :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getLinkedAccounts - :comment: Retrieve all Linked Accounts and their last known statuses. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/linkedaccounts/{linkedAccountId} - :path_regex: v2/accounts/[^/]+?/linkedaccounts/[^/]+?? + :path_regex: v2/accounts/[^/]+?/linkedaccounts/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getLinkedAccount - :comment: Retrieve a specific Linked Account. :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/linkedaccounts/{linkedAccountId} - :path_regex: v2/accounts/[^/]+?/linkedaccounts/[^/]+?? + :path_regex: v2/accounts/[^/]+?/linkedaccounts/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateLinkedAccount - :comment: Assign or Unassign a Linked Account to one or more Locations. :sandbox_only: false :account_settings: + :module_name: AccountSettings :objects: :role: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/roles :path_regex: v2/accounts/[^/]+?/roles :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getRoles - :comment: Retrieves a list of the roles that users can have within a customer’s account. :sandbox_only: false :user: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/users :path_regex: v2/accounts/[^/]+?/users :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getUsers - :comment: Lists all Users in an account. :sandbox_only: false - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/users :path_regex: v2/accounts/[^/]+?/users :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createUser - :comment: Create a new User. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId} - :path_regex: v2/accounts/[^/]+?/users/[^/]+?? + :path_regex: v2/accounts/[^/]+?/users/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getUser - :comment: Retrieves details of a specific User. :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId} - :path_regex: v2/accounts/[^/]+?/users/[^/]+?? + :path_regex: v2/accounts/[^/]+?/users/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateUser - :comment: Updates an existing User. :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId} - :path_regex: v2/accounts/[^/]+?/users/[^/]+?? + :path_regex: v2/accounts/[^/]+?/users/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteUser - :comment: Deletes an existing User. :sandbox_only: false - :action: :change_password :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}/password - :path_regex: v2/accounts/[^/]+?/users/[^/]+??/password + :path_regex: v2/accounts/[^/]+?/users/[^/]+?/password :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateUserPassword - :comment: Updates a User's password. :sandbox_only: false :account: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts :path_regex: v2/accounts :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/listAccounts - :comment: > - List all accounts that you have access to. Unless you are in Partner Portal mode, - this will only be your own account. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId} :path_regex: v2/accounts/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getAccount - :comment: Get details for an account. :sandbox_only: false :optimization_tasks: + :module_name: OptimizationTasks :objects: :optimization_task: :actions: - :action: :index :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/optimizationtasks :path_regex: v2/accounts/[^/]+?/optimizationtasks :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getOptimizationTasks - :comment: List Optimization Tasks for the account, optionally filtered by task and location. :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/optimizationlink :path_regex: v2/accounts/[^/]+?/optimizationlink :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getLinkOptimizationTask - :comment: Retrieve a link to perform any pending Optimization Tasks given a set of Optimization Tasks and a location. :sandbox_only: false :live_api: :documentation: http://developer.yext.com/docs/live-api/ :objects: :menu: :actions: - :action: :show :method: :get :endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/menus/{listId} - :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/menus/[^/]+?? + :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/menus/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/getMenus - :comment: Retrieve a specific Menu. :sandbox_only: false :bio: :actions: - :action: :show :method: :get :endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/bios/{listId} - :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/bios/[^/]+?? + :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/bios/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/getBios - :comment: Retrieve a specific Bios ECL. :sandbox_only: false :product: :actions: - :action: :show :method: :get :endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/products/{listId} - :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/products/[^/]+?? + :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/products/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/getProducts - :comment: Retrieve a specific Products ECL. :sandbox_only: false :event: :actions: - :action: :show :method: :get :endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/events/{listId} - :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/events/[^/]+?? + :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/events/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/getEvents - :comment: Retrieve a specific Events ECL. :sandbox_only: false :language_profile: :belongs_to: location :has_many: language_profile_schema :actions: - :action: :index :method: :get :endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/ - :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+??/profiles/ + :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+?/profiles/ :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/listLanguageProfiles - :comment: Gets all Language Profiles for a Location. :sandbox_only: false - :action: :show :method: :get :endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/{languageCode} - :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+??/profiles/[^/]+?? + :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+?/profiles/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/getLanguageProfiles - :comment: Gets the requested Language Profile for a given Location. :sandbox_only: false :language_profile_schema: :belongs_to: language_profile :actions: - :action: :show :method: :get :endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId}/profiles/{languageCode}/schema - :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+??/profiles/[^/]+??/schema + :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+?/profiles/[^/]+?/schema :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/getLanguageProfilesSchema - :comment: > - Gets the schema.org compliant schema for the requested Language Profile of a given Location. - Schema will vary depending on the primary category of the Location. :sandbox_only: false + :location_schema: + :actions: + - :action: :show + :method: :get + :endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId}/schema + :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+?/schema + :default_version: 20161012 + :documentation: http://developer.yext.com/docs/live-api/#operation/getLocationSchema + :sandbox_only: false + - :action: :geo_search + :method: :get + :endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/geosearch + :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/geosearch + :default_version: 20161012 + :documentation: http://developer.yext.com/docs/live-api/#operation/geoSearch + :sandbox_only: false :location: :has_many: language_profile :has_many: location_schema :actions: - :action: :index :method: :get :endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/locationsList - :comment: > - Get multiple Locations (primary profile only). Filters are evaluated against all language - profiles as well as the primary profile. :sandbox_only: false - :action: :show :method: :get :endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId} - :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+?? + :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/getLocation - :comment: Gets the primary profile for a single Location. :sandbox_only: false - :location_schema: - :actions: - - :action: :show - :method: :get - :endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/{locationId}/schema - :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+??/schema - :default_version: 20161012 - :documentation: http://developer.yext.com/docs/live-api/#operation/getLocationSchema - :comment: > - Gets the schema.org compliant schema for the primary profile of a single Location. Schema - will vary depending on the primary category of the Location. - :sandbox_only: false - - :action: :geo_search - :method: :get - :endpoint: https://liveapi.yext.com/v2/accounts/{accountId}/locations/geosearch - :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/geosearch - :default_version: 20161012 - :documentation: http://developer.yext.com/docs/live-api/#operation/geoSearch - :comment: > - Gets multiple Locations (primary profile only) near a given location, ordered by proximity - to the location (if no other sort criteria are given) and restricted to a radius. Searches - through all language profiles, including the primary profile. - :sandbox_only: false :webhooks: :documentation: http://developer.yext.com/docs/webhooks/ :knowledge_manager: :location: :endpoint: https://[your_hostname]/[your_locations_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/locationsWebhook - :comment: Sends an updated Location to your server. :sandbox_only: false :menu: :endpoint: https://[your_hostname]/[your_menus_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/menusWebhook - :comment: Sends an updated Menu object to your server. :sandbox_only: false :bio: :endpoint: https://[your_hostname]/[your_bios_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/biosWebhook - :comment: Sends an updated Bios object to your server. :sandbox_only: false :product: :endpoint: https://[your_hostname]/[your_products_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/productsWebhook - :comment: Sends an updated Product List object to your server. :sandbox_only: false :event: :endpoint: https://[your_hostname]/[your_events_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/eventsWebhook - :comment: Sends an updated Events List (Calendar) object to your server. :sandbox_only: false :power_listings: :listing: :endpoint: https://[your_hostname]/[your_listings_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/listingsWebhook - :comment: Sends an updated Listing object to your server. :sandbox_only: false :duplicate: :endpoint: https://[your_hostname]/[your_duplicates_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/duplicatesWebhook - :comment: Sends an updated Duplicate object to your server. :sandbox_only: false :publisher_suggestion: :endpoint: https://[your_hostname]/[your_publisherSuggestions_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/publisherSuggestionsWebhook - :comment: Sends an updated Publisher Suggestion object to your server. :sandbox_only: false :reviews: :review: :endpoint: https://[your_hostname]/[your_reviews_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/reviewsWebhook - :comment: Sends an updated Review object to your server whenever a Review or one of its Comments are created or modified. :sandbox_only: false :app_directory: :review: :endpoint: https://[your_hostname]/[your_unlink_account_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/unlinkWebhook - :comment: Fired when an account uninstalls your App. :sandbox_only: false :agreements: :add_request_update: :endpoint: https://[your_hostname]/[your_add_request_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/addRequestWebhook - :comment: Fired when an Add Request is updated. :sandbox_only: false