Memos unofficial
PATCH/api/v1/instance/{instance}/*

Update an instance setting

Updates configuration for an instance setting. Supply the setting resource in the request body and use updateMask to specify which fields to update; storageType and accessMode accept only their documented enum values.

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

2 parameters · 8 body fields
instancestringrequired
The identifier of the instance whose setting you want to update.
updateMaskstringoptional
A field mask identifying the setting fields to update.

The instance setting resource containing the configuration to update.

namestringoptional
The name of the instance setting. Format: instance/settings/{setting}
generalSettingobjectoptional
General instance settings configuration.
storageSettingobjectoptional
Storage configuration settings for instance attachments.
memoRelatedSettingobjectoptional
Memo-related instance settings and policies.
tagsSettingobjectoptional
Tag metadata configuration. Active tag metadata is stored in per-user tag settings. This message remains for backward compatibility with existing clients and migrations.
notificationSettingobjectoptional
Notification transport configuration.
aiSettingobjectoptional
AI provider configuration settings.
accessSettingobjectoptional
Access policy configuration for the instance.

2 status codes
200Returns the updated instance setting resource, including its name and applicable configuration fields.
namestringoptional
The name of the instance setting. Format: instance/settings/{setting}
generalSettingobjectoptional
General instance settings configuration.
storageSettingobjectoptional
Storage configuration settings for instance attachments.
memoRelatedSettingobjectoptional
Memo-related instance settings and policies.
tagsSettingobjectoptional
Tag metadata configuration. Active tag metadata is stored in per-user tag settings. This message remains for backward compatibility with existing clients and migrations.
notificationSettingobjectoptional
Notification transport configuration.
aiSettingobjectoptional
AI provider configuration settings.
accessSettingobjectoptional
Access policy configuration for the instance.
defaultReturned when the request fails; includes an error code, a developer-facing message, and optional error details.
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 instance path parameter must identify the instance, and the setting name must follow the instance/settings/{setting} format. Use updateMask to identify the fields to update; storageType must be one of STORAGE_TYPE_UNSPECIFIED, DATABASE, LOCAL, or S3, and accessMode must be one of INSTANCE_ACCESS_MODE_UNSPECIFIED, INSTANCE_ACCESS_MODE_PRIVATE, or INSTANCE_ACCESS_MODE_PUBLIC.