Memos unofficial
PATCH/api/v1/spaces/{space}

Update space metadata

Updates metadata for a space. Use updateMask to select title or description, and provide title as required by the request schema.

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

2 parameters · 6 body fields
spacestringrequired
The identifier of the space to update.
updateMaskstringoptional
Field mask selecting the space metadata to update: `title` or `description`.

Space metadata for the update. The request schema requires title; use updateMask to select the fields to change.

namestringoptional
The resource name of the space. Format: spaces/{space}.
titlestringrequired
Required. The human-readable title.
descriptionstringoptional
Optional. A description of the space.
currentUserRolestringoptional
Output only. The authenticated user's membership role in this space. ROLE_UNSPECIFIED when this Space is exposed as metadata-only.
Allowed:ROLE_UNSPECIFIEDADMINUSER
memberCountintegeroptional
Output only. The number of accepted members in this space. Pending invitations are excluded. Zero when this Space is exposed as metadata-only.
iconobjectoptional
Optional. Display icon. Omit when updating with the "icon" mask to reset to the default Space mark.

2 status codes
200Returns the updated space resource, including its title, description, and other available metadata.
namestringoptional
The resource name of the space. Format: spaces/{space}.
titlestringrequired
Required. The human-readable title.
descriptionstringoptional
Optional. A description of the space.
currentUserRolestringoptional
Output only. The authenticated user's membership role in this space. ROLE_UNSPECIFIED when this Space is exposed as metadata-only.
Allowed:ROLE_UNSPECIFIEDADMINUSER
memberCountintegeroptional
Output only. The number of accepted members in this space. Pending invitations are excluded. Zero when this Space is exposed as metadata-only.
iconobjectoptional
Optional. Display icon. Omit when updating with the "icon" mask to reset to the default Space mark.
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 space path parameter must identify the space to update. The updateMask query parameter selects title or description, and title is required by the request schema.