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.
Permission required: member:manage_virtual
  • Changes that give someone an admin role, or that reduce what an admin can reach, also require the team owner or an admin.

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.