Skip to main content
The spaces module includes a full set of membership management functions. Use these to build admin tools, automate onboarding flows, or enforce membership policies server-side.

joinSpace

Adds a user to a space. If the space requires approval (requireJoinApproval: true), the membership is created in a pending state.
const result = await replyke.spaces.joinSpace({
  spaceId: "spc_abc123",
  userId: "usr_abc123",
});
spaceId
string
required
The Replyke space ID.
userId
string
required
The Replyke user ID to add.
ReturnsPromise<JoinSpaceResponse>

leaveSpace

Removes a user from a space.
const result = await replyke.spaces.leaveSpace({
  spaceId: "spc_abc123",
  userId: "usr_abc123",
});
spaceId
string
required
The Replyke space ID.
userId
string
required
The Replyke user ID to remove.
ReturnsPromise<LeaveSpaceResponse>

checkMyMembership

Returns the membership status of a user in a space.
const result = await replyke.spaces.checkMyMembership({
  spaceId: "spc_abc123",
  userId: "usr_abc123",
});
spaceId
string
required
The Replyke space ID.
userId
string
required
The Replyke user ID to check.
ReturnsPromise<CheckMyMembershipResponse>

fetchSpaceMembers

Returns a paginated list of approved members in a space.
const result = await replyke.spaces.fetchSpaceMembers({
  spaceId: "spc_abc123",
  page: 1,
  limit: 20,
});
spaceId
string
required
The Replyke space ID.
page
number
Page number (1-indexed). Defaults to 1.
limit
number
Results per page. Defaults to 20.
ReturnsPromise<SpaceMembersResponse>

fetchSpaceTeam

Returns the admin and moderator members of a space (the “team”).
const result = await replyke.spaces.fetchSpaceTeam({ spaceId: "spc_abc123" });
spaceId
string
required
The Replyke space ID.
ReturnsPromise<SpaceTeamResponse>

updateMemberRole

Updates a member’s role within a space.
const result = await replyke.spaces.updateMemberRole({
  spaceId: "spc_abc123",
  memberId: "mem_xyz789",
  role: "moderator",
});
spaceId
string
required
The Replyke space ID.
memberId
string
required
The Replyke space member ID (not the user ID).
role
string
required
The new role to assign: "admin", "moderator", or "member".
ReturnsPromise<UpdateMemberRoleResponse>

approveMembership

Approves a pending membership request. Only relevant when the space has requireJoinApproval: true.
const result = await replyke.spaces.approveMembership({
  spaceId: "spc_abc123",
  memberId: "mem_xyz789",
});
spaceId
string
required
The Replyke space ID.
memberId
string
required
The Replyke space member ID of the pending member.
ReturnsPromise<ApproveMemberResponse>

declineMembership

Declines and removes a pending membership request.
const result = await replyke.spaces.declineMembership({
  spaceId: "spc_abc123",
  memberId: "mem_xyz789",
});
spaceId
string
required
The Replyke space ID.
memberId
string
required
The Replyke space member ID of the pending member.
ReturnsPromise<DeclineMemberResponse>

banMember

Bans a member from a space, preventing them from rejoining.
const result = await replyke.spaces.banMember({
  spaceId: "spc_abc123",
  memberId: "mem_xyz789",
});
spaceId
string
required
The Replyke space ID.
memberId
string
required
The Replyke space member ID to ban.
ReturnsPromise<BanMemberResponse>

unbanMember

Removes a ban, allowing the user to rejoin the space.
const result = await replyke.spaces.unbanMember({
  spaceId: "spc_abc123",
  memberId: "mem_xyz789",
});
spaceId
string
required
The Replyke space ID.
memberId
string
required
The Replyke space member ID to unban.
ReturnsPromise<UnbanMemberResponse>