Create a preference group for this user

Authorization

BearerAuth

AuthorizationBearer <token>

JWT Bearer token authentication

In: header

Path Parameters

user_id*string

Owner of the preferences. This is the record the preferences belong to, NOT the caller — an actor with the right record permission reads and writes another user's preferences through the same route.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Optional internal name for the group

title*

Multi-lingual title for the group

description?

Multi-lingual title for the group

active?boolean

Whether users can see this group (false = admin only)

enabled?boolean

Whether preferences in this group can be used

Response Body

`application/json`

curl -X POST "https://example.com/v1/user-preferences/497f6eca-6276-4993-bfeb-53cbbbba6f08/groups" \  -H "Content-Type: application/json" \  -d '{    "title": {      "en": "Notifications",      "property1": "string",      "property2": "string"    }  }'

{
  "id": "1d4c2f4e-9b8b-4c36-b22c-dfe93c51dca5",
  "title": "Accounts",
  "description": "Account notification settings",
  "active": true,
  "enabled": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Empty