Skip to main content
POST
Add a team member

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

team_id
string
required

Body

application/json
type
enum<string>
required

Whether to add an individual user or an SSO group.

Available options:
user,
sso_group
identifier
string
required

Email address for a user, or group name for an SSO group.

role
enum<string>
default:editor

The member's role within the team.

Available options:
editor,
viewer

Response

Successful Response

A user or SSO group granted membership on a team.

id
string
required
read-only

The unique identifier of this membership.

type
enum<string>
required

Whether the member is an individual user or an SSO group.

Available options:
user,
sso_group
identifier
string
required

Email address for a user, or group name for an SSO group.

role
enum<string>
required

The member's role within the team.

Available options:
editor,
viewer
create_time
string
required
read-only

When the member was added to the team — RFC 3339 UTC.

etag
string
required
read-only

Opaque strong ETag for optimistic concurrency.