Method: spaces.members.create

Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space.

Supports the following types of authentication:

  • App authentication with administrator approval in Developer Preview and the authorization scope:

    • https://www.googleapis.com/auth/chat.app.memberships

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (to add the calling app to the space)
    • https://www.googleapis.com/auth/chat.import (import mode spaces only)
    • User authentication grants administrator privileges when an administrator account authenticates, useAdminAccess is true, and the following authorization scope is used:
      • https://www.googleapis.com/auth/chat.admin.memberships

For example usage, see:

HTTP request

POST https://chat.googleapis.com/v1/{parent=spaces/*}/members

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the space for which to create the membership.

Format: spaces/{space}

Query parameters

Parameters
useAdminAccess

boolean

Optional. When true, the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

Requires the chat.admin.memberships OAuth 2.0 scope.

Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.

Request body

The request body contains an instance of Membership.

Response body

If successful, the response body contains a newly created instance of Membership.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

For more information, see the Authorization guide.