v20

OpenAPI 3.1.0raw.githubusercontent.com2026-08-011984401.2 MB
My Organizations

Add an organization member

Adds a user to the organization with the ADMIN or MEMBER role. The caller (key owner) must be an organization admin or owner. Role ceilings and cascades are enforced exactly as in the web app. Requires orgs.roster:read-write and API writes access. Supports an optional Idempotency-Key header for safe retries.

post/orgs/{identifier}/members

Path parameters

identifierstring required

Organization slug or Convex organization ID.

Organization slug or Convex organization ID.

Request body

targetUserIdstring required

Convex user ID of the member to add.

role'ADMIN' | 'MEMBER' required

The role to assign to the new member. Ownership is set on creation.

Response

The member was added.

successtrue required
timestampstring required

Response generation time (ISO 8601).