Skip to main content
POST
Add a member to the workspace

Authorizations

Authorization
string
header
required

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Scopes

members:write

Invite and manage workspace members.

Headers

Sajn-Version
enum<string>

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Available options:
2026-09,
2026-10
Sajn-Workspace
string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Idempotency-Key
string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

Body

application/json

Body

Add an organization member to the workspace

email
string<email>
required

Email address of a member of the organization

Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
roleId
string
required

Workspace role ID. To list roles, call GET /api/v1/roles.

Response

Workspace member

Workspace member

id
string
required

User ID of the member. Address the member with it in /api/v1/members/{userId}.

email
string
required
name
string | null
required

Full name. Null when the user has no name.

role
object
required

Workspace role

status
enum<string>
required

ACTIVE once the member has signed in at least once

Available options:
ACTIVE,
INACTIVE
lastActiveAt
string<date-time> | null
required
joinedAt
string<date-time>
required

When the user was added to the workspace