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

Was this helpful?

  1. Whisk API Reference 2.0
  2. Users

Update User Settings using Post

PreviousUpdate User Settings using PatchNextOverview

Last updated 4 years ago

Was this helpful?

To get and configure the User profile you can use :

Update User Settings

POST https://api.whisk.com/user/v2/settings/patch

Update user preferences. Note: additional [POST] endpoint for services which don't support [PATCH]

Request Body

Name
Type
Description

Settings Model

object

See the meal planner settings model.

{
  "settings": {
    "personal_details": {
      "first_name": "string",
      "last_name": "string",
      "photo_url": "string",
      "gender": "GENDER_INVALID",
      "country": "string",
      "zipcode": "string",
      "language": "string",
      "activity_level": "ACTIVITY_LEVEL_INVALID",
      "age": 0,
      "height": {
        "value": 0,
        "unit": "UNIT_INVALID"
      },
      "weight": {
        "value": 0,
        "unit": "UNIT_INVALID"
      },
      "health_goals": {
        "list": [
          "HEALTH_GOAL_INVALID"
        ]
      },
      "year_of_birth": 0
    },
    "food_preferences": {
      "diets": {
        "list": [
          "DIET_INVALID"
        ]
      },
      "avoidance_list": {
        "list": [
          "AVOIDANCE_INVALID"
        ]
      },
      "disliked_ingredients": {
        "list": [
          {
            "name": "string",
            "canonical_name": "string"
          }
        ]
      },
      "organic_preference": "ORGANIC_PREFERENCE_INVALID",
      "nutrition_preferences": {
        "list": [
          "NUTRITION_INVALID"
        ]
      },
      "preferred_ingredients": {
        "list": [
          {
            "name": "string",
            "canonical_name": "string"
          }
        ]
      }
    },
    "cooking_preferences": {
      "household_adults": {
        "size": 0
      },
      "household_children": {
        "size": 0
      },
      "favourite_cuisines": {
        "list": [
          "CUISINE_INVALID"
        ]
      },
      "cooking_experience": "COOKING_EXPERIENCE_INVALID",
      "cooking_max_time": {
        "time": 0
      },
      "user_devices": {
        "list": {
          "device_type": "DEVICE_TYPE_INVALID",
          "custom_device": "DEVICE_TYPE_INVALID"
        }
      }
    },
    "shopping_preferences": {
      "preferred_retailers": {
        "retailers": [
          "string"
        ]
      },
      "budget_goal": "BUDGET_GOAL_INVALID",
      "ethical_preferences": {
        "list": [
          "ETHICAL_PREFERENCE_INVALID"
        ]
      }
    }
  },
  "mask": {
    "paths": [
      "string"
    ]
  }
}

This list of user profile preferences could impact the meal recommendation algorithm:

  • Age

  • Gender

  • Health goals

  • Height, Weight

  • Activity level

  • Dietary Preferences

  • Allergies and Intolerance

  • Disliked Ingredients

  • Cooking Preferences

Please see the .

these endpoints
meal planner setting model