Update note settings
PATCH/note-settings
Update the current user's settings for note generation.
Request
Responses
- 200
The new note settings.
Operation spec
{
"method": "patch",
"path": "/note-settings",
"operationId": "update-note-settings",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Only provide the fields you want to patch.",
"x-patch-properties": [
"note_template",
"note_template_key",
"note_locale"
],
"properties": {
"note_template_key": {
"type": "string",
"description": "Human-readable identifier for the user's current note template. Use [List note templates](/core-api/reference/next/user/list-note-settings-templates) to get available keys."
},
"note_locale": {
"type": "string",
"description": "Locale of the note.",
"enum": [
"ENGLISH_US",
"ENGLISH_UK",
"FRENCH_FR"
],
"example": "ENGLISH_US",
"title": "note_locale"
}
}
}
}
}
},
"responses": {
"200": {
"description": "The new note settings.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Settings that apply for all notes generated by the current user, e.g. through the [`/generate-note` endpoint](/core-api/reference/next/server/generate-note).",
"required": [
"note_template_key",
"note_locale"
],
"properties": {
"note_template_key": {
"type": "string",
"description": "Human-readable identifier for the user's current note template. Use [List note templates](/core-api/reference/next/user/list-note-settings-templates) to get available keys."
},
"note_locale": {
"type": "string",
"description": "Locale of the note.",
"enum": [
"ENGLISH_US",
"ENGLISH_UK",
"FRENCH_FR"
],
"example": "ENGLISH_US",
"title": "note_locale"
}
},
"title": "note_settings"
}
}
}
}
}
}