USusememos
SpaceService

PATCH /api/spaces/{space}

Changed on

UpdateSpace updates space metadata. Only a space administrator can update a space.

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

spacestring required

The space id.

Query parameters

updateMaskstring field-mask

Required. The fields to update. Supported paths: title, description, icon.

Request body

namestring

Identifier. The resource name of the space. Format: spaces/{space}

titlestring required

Required. The human-readable title.

descriptionstring

Optional. A description of the space.

currentUserRole'ROLE_UNSPECIFIED' | 'ADMIN' | 'USER' enum

Output only. The authenticated user's membership role in this space. ROLE_UNSPECIFIED when this space is exposed as metadata only.

memberCountinteger

Output only. The number of accepted members in this space. Pending invitations are excluded. Zero when this space is exposed as metadata only.

Response

OK

namestring

Identifier. The resource name of the space. Format: spaces/{space}

titlestring required

Required. The human-readable title.

descriptionstring

Optional. A description of the space.

currentUserRole'ROLE_UNSPECIFIED' | 'ADMIN' | 'USER' enum

Output only. The authenticated user's membership role in this space. ROLE_UNSPECIFIED when this space is exposed as metadata only.

memberCountinteger

Output only. The number of accepted members in this space. Pending invitations are excluded. Zero when this space is exposed as metadata only.

Changes