Update User Settings using Patch

This API available only for user access-token integration

Endpoint allows updating fields in a User by its IDon the Graph or by externalUserId. In the JSON request body, include a JsonPatch patch object that specifies the operation to perform, one or more fields to update, and a new value for each updated field.

Note: To know more about JsonPatch take a look at JsonPatch website.

Update Recipe

PATCH https://api.whisk.com/user/v2/settings

Path Parameters

Name	Type	Description
id	string	User Id on the Graph or User external Id

Request Body

Name	Type	Description
op	string	The operation to perform: Add, Remove, Replace, Copy, Move, Test
path	string
from	string
value	string

200

{
  "id": "3d4fda8595114a3a9f7b12fd471a4169",
  "externalId": "1654732567",
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "displayName": "John Doe",
  "pictureUrl": "http://john.doe.picture.url.jpg",
  "updatedAt": 1524150524000,
  "createAt": 1524150524000,
  "preferences": {
    "diets": [
      "vegetarian",
      "vegan"
    ],
    "avoidances": [
      "egg",
      "celery"
    ],
    "dislikedIngredients": [
      {
        "name": "milk"
      }
    ],
    "householdSizeAdults": 2,
    "householdSizeChildren": 1,
    "gender": "male",
    "cookingSkill": "amateur",
    "language": "ko",
    "country": "kr"
  }
}

Sample Request

curl "https://graph.whisk.com/v1/users" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <Access-Token>" \
  -d '[
    {
      "op": "remove",
      "path": "/email"
    },
    {
      "op": "replace",
      "path": "/displayName",
      "value": "John Doe"
    },
    {
      "op": "add",
      "path": "/pictureUrl",
      "value": ""
    }
  ]'

Response

ATTRIBUTE	TYPE	DESCRIPTION
id*	string	The id of the User on Whisk Graph
externalUserId	string	The user id you have defined for the user. (Max limit of 255 UTF-8 characters, and should not have trailing or leading spaces)
email	string	The email you have defined for the user. (Max limit of 255 UTF-8 characters, and should not have trailing or leading spaces)
firstName	string	The first name of the user
lastName	string	The last name of the user
displayName	string	The display name of the user
createdAt*	timestamp	The time the user was added to Whisk
updatedAt*	timestamp	The last time the user was updated
pictureUrl	string	The profile picture url of a user
preferences	UserPreferences

UserPreferences

ATTRIBUTE	TYPE	DESCRIPTION
country	string	Country iso code. Examples: gb, kr, us...
zipcode	string	Postal code. Examples: 10001, 80333...
language	string	Language iso code. Examples: en, ko, fr...
cookingSkill	enum	Measure of a person’s competence in preparing and cooking foods Possible values: amateur, intermediate, advanced.
gender	enum	Possible values: female, male.
householdSizeChildren	integer	Number of children
householdSizeAdults	integer	Number of adults Default value: 1
dislikedIngredients	array [string]	Products and ingredients which will be excluded in search and feed APIs.
diets	array [string]	more about diets
avoidances	array [string]	more about avoidances