Sign in

v56

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01142337440.5 KB
WorkspaceAdminService
Workspace Admin

Add a member to a workspace

Grants a profile access to the workspace by creating (or reactivating) the actor that links the profile to the workspace. Accepts either an existing profile_id or an email to resolve-or-invite. Idempotent for an already-active member. Admin only.

post/v1/account/workspaces/{workspaceId}/members

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

The workspace to add the member to (path).

Request body

workspaceIdstring

The workspace to add the member to (path).

profileIdstring

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

emailstring

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

Example request

{
  "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
  "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
}

Response

OK

profileIdstring required

The account profile that has access to the workspace.

actorIdstring required

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

namestring

Display name of the member's profile.

emailstring

Email address of the member's profile.

addedAtstring date-time

When the member was added to the workspace.

Example response

{
  "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
  "actorId": "actor_01HXKD2E5NQM3T9AYWCFKM4E2P"
}