Update User System Preferences
Update User System Preferences
OVERVIEW
Overview
Update a user's System Preferences in Publisher
This API call is used to update a user's System Preferences in the system, by replacing the System Preferences with the provided System Preferences object.
Since v4.6
HTTP Request
PUT /api/2/users/<ID>/systempreferences
OR
PUT /api/2/users/<EMAIL>/systempreferences
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the user |
| The email address of the user |
HTTP Request Object
System Preferences object, either in JSON or XML format.
HTTP Headers
| HTTP Request Header | Description | Example |
|---|---|---|
| Authorization | The API Authorisation token. | "Bearer XXXXXXXXXXXXX" |
| Accept |
The format of the expected response.
If no parameter is set, JSON is the default response given. |
"application/xml" |
| Content-Type |
The format of the provided content.
If no parameter is set, JSON is the expected content by default. |
"application/json" |
HTTP Response
Success
HTTP response 200 with System Preferences summary object
(Example below)
Error
Example HTTP Request & Response
PUT http://example.com/context/api/2/users/3/systempreferences
JSON Request
{
"systempreferences": {
"language": "en_GB",
"metadatanodes": [
{
"node": "Countries",
"metadata": [
"Algeria",
"Angola",
"Benin"
]
},
{
"node": "American States",
"metadata": [
"Alabama",
"Alaska",
"Arizona"
]
}
]
}
}
JSON Response
{
"systempreferences": {
"userid": 3,
"link": "http://example.com/context/api/2/users/3/systempreferences"
}
}
Thank you
Your review has been submitted.
Comments
0 Comments