UserData
Set scoped userdata
This function sets (creates or updates) a userdata key/value pair within the specified scope and returns the full updated mapping.
get/set_scoped_userdata
Query parameters
scopestring required
Example:example_scope
The scope name to modify.
jsonstring
Example:{"theme":"dark"}
A json string to save to the specified scope.
Note: The "json" argument cannot be used with the "key" or "value" arguments.
keystring
Example:theme
The userdata key to set.
Note: The "json" argument cannot be used with the "key" or "value" arguments.
valuestring
Example:dark
The value to assign to the key.
Note: The "json" argument cannot be used with the "key" or "value" arguments.
Response
HTTP Request was successful.
Example response
{
"data": {
"theme": "dark",
"items_per_page": "50"
},
"metadata": {
"command": "set_scoped_userdata",
"reason": "OK",
"result": 1,
"version": 1
}
}