Skip to main content
Creates a VIRTUAL member — a login-less managed identity that appears in the roster, holds a role, and acts only through API keys issued for it (POST /api-keys with member_principal_id). Human members join through invitations only. A virtual member cannot hold an admin-level role (see GET /roles, admin_grant_only) — 400 ROLE_NOT_FOR_VIRTUAL_MEMBER, whoever asks.
Permission required: member:manage_virtual

Headers

string
Optional. Retrying with the same value replays the first result.

Request Body

string
required
Display name of the virtual member
string
required
Role: tenant_admin, tenant_member, or a custom role key of this team. The owner role cannot be assigned.

Response

object

Errors

Errors answer with success: false, a message and an error_code. See Error Codes for every code.