:administrative_api: :documentation: http://developer.yext.com/docs/administrative-api :objects: :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/administrative-api/#operation/listAccounts :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 :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 :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 :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/addrequests/{addRequestId} :path_regex: v2/accounts/[^/]+?/addrequests/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/administrative-api/#operation/getAddRequest :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 :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 :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 :sandbox_only: false :knowledge_api: :documentation: http://developer.yext.com/docs/api-reference/ :health_check: :objects: :health: :actions: - :action: :show :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 :sandbox_only: false :knowledge_manager: :objects: :location: :has_many: language_profiles :actions: - :action: :index :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 :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 :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 :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId} :path_regex: v2/accounts/[^/]+?/locations/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getLocation :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/locations/{locationId} :path_regex: v2/accounts/[^/]+?/locations/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateLocation :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 :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 :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 :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/menus/{listId} :path_regex: v2/accounts/[^/]+?/menus/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getMenu :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/menus/{listId} :path_regex: v2/accounts/[^/]+?/menus/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateMenu :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/menus/{listId} :path_regex: v2/accounts/[^/]+?/menus/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteMenuList :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 :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 :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/bios/{listId} :path_regex: v2/accounts/[^/]+?/bios/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getBio :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/bios/{listId} :path_regex: v2/accounts/[^/]+?/bios/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateBio :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/bios/{listId} :path_regex: v2/accounts/[^/]+?/bios/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteBioList :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 :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 :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/products/{listId} :path_regex: v2/accounts/[^/]+?/products/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getProduct :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/products/{listId} :path_regex: v2/accounts/[^/]+?/products/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateProduct :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/products/{listId} :path_regex: v2/accounts/[^/]+?/products/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteProductList :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 :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 :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/events/{listId} :path_regex: v2/accounts/[^/]+?/events/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getEvent :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/events/{listId} :path_regex: v2/accounts/[^/]+?/events/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateEvent :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/events/{listId} :path_regex: v2/accounts/[^/]+?/events/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteEventList :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 :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 :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 :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 :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields/{customFieldId} :path_regex: v2/accounts/[^/]+?/customfields/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getCustomField :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields/{customFieldId} :path_regex: v2/accounts/[^/]+?/customfields/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateCustomField :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/customfields/{customFieldId} :path_regex: v2/accounts/[^/]+?/customfields/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteCustomField :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 :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getLanguageProfiles :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/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getLanguageProfile :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/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateLanguageProfile :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/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteLanguageProfile :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 :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 :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/assets/{assetId} :path_regex: v2/accounts/[^/]+?/assets/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getAsset :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/assets/{assetId} :path_regex: v2/accounts/[^/]+?/assets/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateAsset :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/assets/{assetId} :path_regex: v2/accounts/[^/]+?/assets/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteAsset :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 :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 :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 :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 :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 :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/publishersuggestions/{suggestionId} :path_regex: v2/accounts/[^/]+?/powerlistings/publishersuggestions/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getPublisherSuggestion :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/publishersuggestions/{suggestionId} :path_regex: v2/accounts/[^/]+?/powerlistings/publishersuggestions/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updatePublisherSuggestion :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 :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 :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/duplicates/{duplicateId} :path_regex: v2/accounts/[^/]+?/powerlistings/duplicates/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteDuplicate :sandbox_only: false - :action: :suppress :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/duplicates/{duplicateId} :path_regex: v2/accounts/[^/]+?/powerlistings/duplicates/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/suppressDuplicate :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 :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 :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/analytics/standardreports/{reportId} :path_regex: v2/accounts/[^/]+?/analytics/standardreports/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/reportStatus :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 :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 :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 :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews/{reviewId} :path_regex: v2/accounts/[^/]+?/reviews/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getReview :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/reviews/{reviewId} :path_regex: v2/accounts/[^/]+?/reviews/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateReview :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 :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createComment :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 :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 :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/reviewinvites/{invitationId} :path_regex: v2/accounts/[^/]+?/reviewinvites/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getReviewInvitation :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 :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 :sandbox_only: false :social: :objects: :post: :has_many: comments :actions: - :action: :index :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 :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 :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId} :path_regex: v2/accounts/[^/]+?/posts/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deletePost :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 :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getComments :sandbox_only: false - :action: :create :method: :post :endpoint: https://api.yext.com/v2/accounts/{accountId}/posts/{postId}/comments :path_regex: v2/accounts/[^/]+?/posts/[^/]+?/comments :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/createComment :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/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateComment :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/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteComment :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 :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/linkedaccounts/{linkedAccountId} :path_regex: v2/accounts/[^/]+?/linkedaccounts/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getLinkedAccount :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/linkedaccounts/{linkedAccountId} :path_regex: v2/accounts/[^/]+?/linkedaccounts/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateLinkedAccount :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 :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 :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 :sandbox_only: false - :action: :show :method: :get :endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId} :path_regex: v2/accounts/[^/]+?/users/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/getUser :sandbox_only: false - :action: :update :method: :put :endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId} :path_regex: v2/accounts/[^/]+?/users/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateUser :sandbox_only: false - :action: :destroy :method: :delete :endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId} :path_regex: v2/accounts/[^/]+?/users/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteUser :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 :default_version: 20161012 :documentation: http://developer.yext.com/docs/api-reference/#operation/updateUserPassword :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 :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 :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 :sandbox_only: false :optimization_link: :actions: - :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 :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/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/getMenus :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/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/getBios :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/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/getProducts :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/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/getEvents :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/ :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/listLanguageProfiles :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/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/getLanguageProfiles :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 :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/getLanguageProfilesSchema :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 :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/[^/]+? :default_version: 20161012 :documentation: http://developer.yext.com/docs/live-api/#operation/getLocation :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 :sandbox_only: false :menu: :endpoint: https://[your_hostname]/[your_menus_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/menusWebhook :sandbox_only: false :bio: :endpoint: https://[your_hostname]/[your_bios_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/biosWebhook :sandbox_only: false :product: :endpoint: https://[your_hostname]/[your_products_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/productsWebhook :sandbox_only: false :event: :endpoint: https://[your_hostname]/[your_events_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/eventsWebhook :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 :sandbox_only: false :duplicate: :endpoint: https://[your_hostname]/[your_duplicates_webhook_path] :default_version: 20161012 :documentation: http://developer.yext.com/docs/webhooks/#operation/duplicatesWebhook :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 :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 :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 :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 :sandbox_only: false