Memos unofficial
PATCH/api/v1/users/{user}/settings/{setting}

Update a user setting

Updates a user's setting. Supply the setting fields to change and use updateMask to specify which fields to update. The setting resource name follows the format users/{user}/settings/{setting}.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 parameters · 4 body fields
userstringrequired
The user ID whose setting you want to update.
settingstringrequired
The setting key in the resource name, such as `GENERAL`.
updateMaskstringoptional
Field mask listing the setting fields to update.

User setting fields and values to update.

namestringoptional
The name of the user setting. Format: users/{user}/settings/{setting}, {setting} is the key for the setting. For example, "users/steven/settings/GENERAL" for general settings.
generalSettingobjectoptional
General user settings configuration.
webhooksSettingobjectoptional
User webhooks configuration.
tagsSettingobjectoptional
User-specific tag metadata.

2 status codes
200Returns the updated user setting, including its resource name and configured general, webhook, or tag settings.
namestringoptional
The name of the user setting. Format: users/{user}/settings/{setting}, {setting} is the key for the setting. For example, "users/steven/settings/GENERAL" for general settings.
generalSettingobjectoptional
General user settings configuration.
webhooksSettingobjectoptional
User webhooks configuration.
tagsSettingobjectoptional
User-specific tag metadata.
defaultDefault error response
codeintegeroptional
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
messagestringoptional
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
detailsarray<object>optional
A list of messages that carry the error details. There is a common set of message types for APIs to use.

Error handling

The user path parameter must identify the user whose setting you want to update, and the setting path parameter identifies the setting key. The updateMask query parameter must be a field mask naming the fields to change; include the corresponding values in the request body.