Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

The workspace to add the member to (path).

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

Body

application/json

AddWorkspaceMemberRequest grants a profile access to a workspace. Provide exactly one of profile_id (an existing account profile) or email. When email is given, the backend resolves it to an existing account profile or invites a new one before linking it to the workspace via an actor.

profileId
string

An existing account profile to add. Mutually exclusive with email.

Example:

"profile_01HXKD2E5NQM3T9AYWCFS0AP08"

email
string

Email address to add (resolve-or-invite). Mutually exclusive with profile_id.

Response

OK

A member of a workspace: the profile granted access plus the actor row that links it to the workspace. Returned by member list/add operations.

profileId
string
required
read-only

The account profile that has access to the workspace.

Example:

"profile_01HXKD2E5NQM3T9AYWCFS0AP08"

actorId
string
required
read-only

The actor row linking the profile to the workspace (the junction record).

Example:

"actor_01HXKD2E5NQM3T9AYWCFKM4E2P"

name
string
read-only

Display name of the member's profile.

email
string
read-only

Email address of the member's profile.

addedAt
string<date-time>
read-only

When the member was added to the workspace.