Jump to: navigation, search

Create Settings Group

This operation is part of the User Settings API section of the Web Services API.

Overview

Creates a new settings group for the specified user.

Request URL /users/{user id}/settings
or

/me/settings

HTTP Method POST
Required Features api-provisioning-write

Parameters

Parameter Value
displayName A user-friendly name describing the settings group.
name A URI-compatible name for the settings group. This name is used as part of the URI to access the group. For example, GET /settings/my-settings-group.
key Specifies an attribute that Web Services uses to identify the settings in this group if they are modified. The value of the "key" attribute must be unique for every setting and is read-only after the setting is created. This parameter is mandatory.

Samples

Request

POST /api/v2/me/settings
{  
   "displayName":"My Setting Group",
   "name":"my-setting-group",
   "key":"name"   //specifies that each setting in this group must have a "name" attribute with a unique value
}

HTTP Response

{
 "statusCode": 0
}

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on January 22, 2016, at 11:57.