Skip to content
Embabel Worlds

Set this user's greeting and login-hints preferences

PUT
/api/v1/profile/preferences
curl --request PUT \
  --url http://localhost:11044/api/v1/profile/preferences \
  --header 'Content-Type: application/json' \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>' \
  --data '{ "boltMode": "example", "greetingEnabled": true, "hintsEnabled": true }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

The whole preference set, not a patch: an omitted greetingEnabled is stored as false and an omitted hintsEnabled as true. boltMode is the exception: omitted leaves it as it is, blank clears it to the Bolt port’s default, and otherwise it is virtual or persisted, case-insensitive (400 for anything else)

Media typeapplication/json

Preferences to store, the body of PUT /profile/preferences. Both flags are always written, so an absent one takes its default

object
boltMode

virtual or persisted, in any case: the surface a Bolt connection gets when it names no database. Absent leaves the choice as it is; blank clears it back to the port’s default

string
greetingEnabled
required

Greet the user when they sign in. Absent means false

boolean
hintsEnabled
required

Show the login hints popup. Absent means true

boolean

Example generated

{
  "boltMode": "example",
  "greetingEnabled": true,
  "hintsEnabled": true
}

Responses

Section titled “Responses”

400

Section titled “400”

BoltMode is a value the Bolt port does not offer. Send it blank to clear the choice back to the port’s default

Media type*/*

The body the servlet error dispatch answers for a status raised by an exception rather than written by the endpoint. Every failure except 404, which answers the not-found HTML page

object
error
required

The status’s standard reason phrase, such as Bad Request or Forbidden

string
path
required

The request path that failed

string
status
required

The HTTP status code, repeated from the status line

integer format: int32