Skip to main content
POST
Set team memberships for a batch of users

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Body

application/json
email_addresses
string[]
required

Users, by email, whose explicit team memberships are being set. Each user's existing explicit memberships across all teams are replaced by those in this request.

Required array length: 1 - 100 elements
team_memberships
TeamMembershipUpdateV2 · object[]
required

The teams each listed user should explicitly belong to, and the role to grant on each. Any team not listed is removed from every listed user's explicit memberships.

Required array length: 1 - 100 elements

Response

Successful Response

items
TeamMembers · object[]
required
page_token
string | null

Opaque cursor for the next page; empty/absent on the last page.

row_count
integer | null

Best-effort total for the filtered result set; may be null when expensive.