Menu
Yotpo actions
Pick an action to see its parameters, request body and response fields.
78 actions
Generic Request · 5
Reviews & Ratings · 73
POSTAdd Metadata To An Existing Review
/v1/apps/{app_key}/reviews/{review_id}/metadata?utoken=utokenAdd metadata to an existing reviewPOSTBest Sentences/v1/reviews/best_sentencesBest SentencesPOSTCreate A New User Email In The System/usersCreate a New User in the SystemPOSTCreate Answer For Question/questions/{question_id}/answersCreate an answer to a questionPOSTCreate Images With Review Process/images/processCreate images with review processPOSTCreate Review/v1/widget/reviewsCreate reviewPOSTCreate Review Synchronous/reviews/dynamic_createCreate review (synchronous)POSTCreate Webhook/apps/{app_key}/webhooksCreate webhookPOSTCreating Reviews/v1/widget/reviews/#####REMOVE#THIS#PART######Creating Reviews (without metadata)POSTCreating Votes For A Review/reviews/{review_id}/vote/{type}Creating Votes for a ReviewGETData Exists/privacy/data/existsData existsPOSTDelete A Coupon Action/apps/{app_key}/coupons/unique/deleteDelete a dynamic coupon action's codesDELETEDelete Webhook/apps/{app_key}/webhooks/{id}Delete webhookPOSTDraft Create Question Without Sending Confirmation Email/questionsCreate question (without confirmation email)GETEmail Analytics/analytics/v1/emails/{app_key}/{metric_name}Email analyticsGETExport Email Analytics/analytics/v1/emails/{app_key}/export/csvExport email analyticsGETFetch User Data/privacy/dataUser dataGETFind If The Xxxxyotpome Subdomain Is Valid/apps/{app_key}/subomain_check/{subdomain}Find if your yotpo.me Subdomain is availableGETGet A Sign In Url For Yapyotpocom/users/yap_login.json?app_key={app_key}&secret={secret}Get a Sign-In URL for yap.yotpo.comGETGet A Users Profile Data/users/{user_id}Retrieve a User’s Profile DataGETGet Account Webhooks/apps/{app_key}/webhooksGet account webhooksGETGet Bottom Line Total Reviews And Average Score Fo/apps/{app_key}/bottom_linesRetrieve Bottom Line (Total Reviews and Average Score) for All ProductsGETGet Bottom Line Total Reviews And Average Score Old/products/{app_key}/{product_id}/bottomlineRetrieve bottom line (total reviews and average score) for a specific product (old)GETGet Custom Albums/albums/{app_key}Custom albumsGETGet Filters And Values/v1/order/{app_key}/{domain_key}/orders.jsonRetrieve review filters and valuesGETGet Media/v1/apps/{app_key}/images/export?utoken=Get mediaGETGet New Endpoint/new-endpointGETGet Review Metadata By Review Id/v1/apps/{app_key}/reviews/{review_id}/metadata?utoken=utokenGet review metadataGETGet Subscribed Webhook/apps/{app_key}/webhooks/{id}Get subscribed webhookGETGet V3storefrontstores{store Id}products{product Id}product Data?include=topics,reviews Summary,metadata/v3/storefront/stores/{storeId}/products/{productId}/productData?include=topics,reviewsSummary,metadataGETGet Webhook Events/webhook_eventsGet webhook eventsPOSTImport Images/v1/widget/{app_key}/images/create_batchImport imagesPOSTImport Videos/v1/media_upload/video_bulk_uploadImport videosGETPhotos By Album/v1/widget/{app_key}/albums/by_namePhotos by albumPOSTProduct Collections/insights/v1/topics/productsProduct collectionsGETProduct Images/v1/widget/{app_key}/albums/product/{product_id}Product imagesPOSTProduct Reviews/insights/v1/products/reviewsReviews per productPOSTProducts/insights/v1/productsProductsGETRaw Data/analytics/v1/emails/{app_key}/export/raw_dataRaw dataDELETERe Add Email Addresses To Email Distribution Lists/apps/:app_key/unsubscribers/mass_deleteRe-add email addresses to email distribution listsGETRecent 5 Star Reviews/apps/{app_key}/top_reviewsTop Three 5-Star ReviewsPOSTRemove A Set Of Email Addresses From Email Distrib/apps/:app_key/unsubscribers/mass_createRemove a set of email addresses from email distribution listsGETRetrieve A List Of Unsubscribers/apps/{app_key}/unsubscribersRetrieve a list of unsubscribersGETRetrieve A Review By Review Id/reviews/{review_id}Retrieve a review by review IDGETRetrieve All Questions/apps/{app_key}/questions.jsonRetrieve all questionsGETRetrieve All Reviews/v1/apps/{app_key}/reviewsRetrieve all reviewsGETRetrieve All Unique Coupon Codes/apps/{app_key}/coupons/uniqueRetrieve all dynamic coupon codesGETRetrieve Bottom Line For All Site Reviews/products/{app_key}/yotpo_site_reviews/bottomlineRetrieve bottom line (total reviews and average score) for all site reviewsGETRetrieve Detailed Review Information/reviews/{app_key}/search_drill_downRetrieve Detailed Review InformationGETRetrieve Email Statistics/apps/{app_key}/email_stats/{since_date}/{to_date}Retrieve Email Statistics (Deprecated)GETRetrieve Questions And Answers For A Product/products/{app_key}/{sku}/questionsRetrieve Q&A for a productGETRetrieve Reviews For A Specific User/products/{app_key}/yotpo_global_reviews/reviews.jsonRetrieve reviews for a user using external user reference IDGETRetrieve The Bottom Line For Questions And Answers/products/{app_key}/{sku}/qna_bottomlineRetrieve the bottom line for Q&AGETRetrieve Unique Code Statistics/apps/{app_key}/coupons/unique/statsRetrieve dynamic coupon code statisticsGETRetrieve Widget Reviews For A Specific Product/v1/widget/{app_key}/products/{product_id}/reviews.json####OLDCALL###Retrieve Widget Reviews for a Specific ProductGETRetrieve Your Reviewsme Url/v1/reviews_me/url/{app_key}/{product_id}Retrieve your reviews.me URLPOSTReviews/insights/v1/topics/reviewsReviews per topicGETReviews Search/reviews/{app_key}/searchSearching ReviewsPOSTSend Question Confirmation Mail/questions/send_confirmation_mailCreate question (with confirmation email)POSTSet The Ecommerce Platform That This Account Integ/apps/:app_key/account_platformSet the e-commerce platform that this account integrates withGETSummary/analytics/v1/emails/{app_key}&date_range.since=2017-07-01&date_range.until=2017-08-20OverviewPOSTTest Mail After Purchase/apps/{app_key}/reminders/send_test_emailAutomatic review request - test emailPOSTTopics/insights/v1/topicsTopicsPUTUpdate Account With Seo And Minisite Parameters/apps/{app_key}Update Your Account with SEO and Minisite ParametersPUTUpdate Existing Review Metadata/v1/apps/{app_key}/reviews/{review_id}/metadata?utoken=utokenUpdate existing review metadataPUTUpdate Incentive By Review Id 1/v1/apps/{app_key}/reviews/incentivized_badgeUpdate incentivized reviews by review IDPUTUpdate Subscribed Webhook/apps/{app_key}/webhooks/{id}Update subscribed webhookPOSTUpload Unique Coupon Codes/apps/:app_key/coupons/uniqueUpload dynamic coupon codesGETV1 Retrieve Bottom Line Total Reviews And Average Score For All Products Old/v1/apps/{app_key}/bottom_lines?count=5&page=5Retrieve bottom line (total reviews and average score) for all products (old)GETVideo Upload Errors/v1/media_upload/errorsVideo upload errorsPOSTVote On Answers/answers/{answer_id}/vote/{vote_type}Vote on answersPOSTVote On Reviews/reviews/{review_id}/vote/{vote_type}Upvote or downvote reviewsPOSTYotpo Authentication/oauth/tokenYotpo authentication