PUT user/{userId}/progress/{key}

Related

Override a key-value in the progress store. Generally, you should first use the POST form of this method to avoid overwriting values which may have been set more recently from another client.

Example

PUT /api/v1/user/66a5db1f-2785-498d-9068-e24ddbba03f2/progress/adventure HTTP/1.1
Authorization: Bearer ...
Content-Type: application/json

{
  "key": "adventure",
  "value": { "some": "data" },
  "timestamp": 1554760285
}
----------------------------------------
HTTP/1.1 204 No Content
ETag: W/"a-bAsFyilMr4Ra1hIU5PyoyFRunpI"

Security

Authentication is required, and access is restricted to the user.

URL Parameters

NameDescriptionValue
userIdthe ID of the user as a GUID with dashesstring
keythe key of the key-value pair to returnstring

Request Body

NameDescriptionValue
keythe key of the progress data to store (this needs to match the key in the URL)string
valuethe data to store at this keyobject
timestampthe timestamp this data was written locally; a Unix timestamp in secondsnumber

Response

Successful responses are code 204. Error responses are standard.

Response Body

NONE