Whisk Docs
Whisk HomeHelp CenterDeveloper Tools
v2.0.0
v2.0.0
  • The Whisk Platform
  • Whisk API Overview
    • Introduction
    • Integration
    • Authentication
      • Server Token
      • User Access Token
        • Auth Flow Example
      • Client Token
      • Anonymous Access from Client Apps
    • Whisk Sandbox
    • Getting Started
  • Whisk API Reference 2.0
    • Provisioning
      • Get provisioning
    • Autocomplete
    • Community
      • Get your Communities
      • Get Communities from a Topic
      • Discover Recommended Communities
      • Search Communities
      • Get a Community
      • Get Recipes from a Community
      • Add Recipes to a Community
      • Remove a Recipe from a Community
      • Join a Community
      • Leave a Community
    • Posts and Reviews
      • Get reviews for a recipe
      • Create or edit review
      • Create a Post
      • Get Post by id
      • Delete a Post
      • Edit a Post
      • Report a Post
      • Create a Post Reply
      • Get Post Replies
      • Delete a Post reply
      • Report a Post reply
      • Like a Post or Reply
      • Users who liked a Post or Reply
    • Public profiles
      • Hide recipe in Public profile
      • Get Recipes for Public Profile
      • Get User's public profile by user_id
      • Get User's public profile by username
    • Custom Label
    • Feed
      • Obtain a Recipe Feed
    • Food DB
      • Autocomplete
      • Search
      • Get Food
    • Food List
    • Food Log
    • Foodpairing
    • Healthy meal recommendations
      • Healthy recipe only recommendations for DA
      • Recipe recommendations for SH
      • Tailored Plan API request for Samsung TV
    • Meal Plan
      • Generate a Meal Plan
      • Meal Object
        • Get Meals
        • Delete Meal
        • Add a Meal
      • Meal Plan Settings Object
        • Get Meal Plan Settings
        • Update Meal Plan Settings
      • Meal Plan Batch
    • Recipe
      • Get a Recipe
      • Search a Recipe
      • User Recipes & Collections
        • Add User Recipe
        • Create A Recipe
        • Update External Recipe
        • Get All User Recipes
        • Update User Recipe
        • Remove Recipe from Favorites
        • Create Collection
        • Get All User Collections
        • Get Collection
        • Get Recipes from a Collection
        • Remove Collection
        • Get Smart Collection
        • Get Recipes from a Smart Collection
    • Shopping List
      • Get your Shopping Lists
      • Get a Shopping List
      • Create a Shopping List
      • Delete a Shopping List
      • Update basic details of a Shopping List
      • Move Items between Shopping Lists
      • Add Items to a Shopping List
      • Delete an Item from a Shopping List
      • Update an Item in a Shopping List
      • Clear Items from a Shopping List
    • Media
    • Store Item
    • Unit Conversion
    • Users
      • Get a User
      • Update User Settings using Patch
      • Update User Settings using Post
    • Try it out!
  • Shopping List SDK
    • Overview
    • Examples
      • Shoppable Recipes
      • Shoppable Products
      • Shoppable Media
    • Basic Setup
      • Basic Setup
      • Methods
      • Event Listeners
      • Widget
      • Subscriptions
      • Global Configuration
      • UTM Parameters
      • Using With SPA
  • Shopping List Mobile API
    • Overview
    • Examples
    • Reference
  • API Resources
    • Authentication Scopes
    • Errors and Troubleshooting
    • Cursor Pagination
    • Limits
    • Nutrients
    • Recipe Labels
    • Filtering Recipes using Custom Labels
    • Health Score, Glycemic Index, Glycemic Load
    • Whisk User Data
    • Integrated Retailers
    • Optimizing Image Load
    • Meal Plan
Powered by GitBook
On this page
  • Report existing post
  • Request body
  • Sample request and response

Was this helpful?

  1. Whisk API Reference 2.0
  2. Posts and Reviews

Report a Post

Endpoint allows to report a post

Report existing post

POST https://api.whisk.com/v2/posts/{post_id}/report

Method allows usser to report specific post or review. Review or post could be reported by post_id. Reported post will be hide from all pages. Report will be submitted to Whisk moderators team and could be accepted or rejected. If moderators team decide that post/review is not harmful they'll accept it and post will apper everuwhere automatically. If they'll reject it - post will be hidden forever.

Query Parameters

Name
Type
Description

post_id*

String

Post id to report

Headers

Name
Type
Description

Authorization*

String

User Access token to authorize the API usage. For more information, see Authentication

Request Body

Name
Type
Description

report_info*

Object

An object for report info

reason*

Enum

Reason for report, predefined.

REPORT_REASON_INVALID;

REPORT_REASON_SPAM;

REPORT_REASON_NSFW;

REPORT_REASON_IP_INFRINGEMENT;

email*

String

Reporter's email. So for moderators team it would be possible to contact him if needed

comment

String

Comment submitted by reporter

{}
{
  "code": "auth.tokenNotFound"
}
This is unexpected response, something is wrong on our side, please contact: [email protected]

Request body

{
  "report_info": {
    "reason": "REPORT_REASON_INVALID",
    "email": "string",
    "comment": "string"
  }
}

Sample request and response

curl -X POST "https://api.b2c.whisk-dev.com/v2/posts/ed4e8ddf1d9349c7b1c0695d9c4741ea/report" -H "accept: application/json" -H "Authorization: Bearer " -H "Content-Type: application/json" -d "{ "report_info": { "reason": "REPORT_REASON_SPAM", "email": "[email protected]", "comment": "test" }}"

{}

PreviousEdit a PostNextCreate a Post Reply

Last updated 2 years ago

Was this helpful?