CorebanqCorebanq Developer Docs
User Preferencesv1

Replace a preference group

PUT
/v1/user-preferences/{user_id}/groups/{group_id}

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.

group_id*string

Identifier of the preference group.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/v1/user-preferences/497f6eca-6276-4993-bfeb-53cbbbba6f08/groups/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "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
Empty
Empty
Empty

POSTCreate this user's default preferences

Seeds the owner's groups, preferences and options from the default preferences configuration. Note the customer-side equivalent of this route is registered nowhere — it is commented out in the route table — so this is the only setup-defaults there is.

PUTReplace an option