/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Add Member

Add Member

Add an existing Syntext user to a workspace directly, without an invitation.

POST/v1/orgs/{orgId}/membersTry it
Session token

Adds someone who already has a Syntext account to the workspace straight away — no email, nothing to accept. To invite someone who may not have an account yet, use Create Invitation.

Note

Requires the admin or owner role and a session JWT. API keys are rejected with 401. Any plan, but each plan caps the number of seats — see plan seat limit below.

Path Parameters

NameDescription
orgId:stringpathRequired
The organization ID.

Request Body

NameDescription
email:stringbodyRequired
The email address of the Syntext account to add.
role:stringbody
admin or member.
Default"member"

Response — 201 Created

id is the new membership id — the one Update Member Role and Remove Member take. The addition is recorded in the audit log as org.member.added.

Error Responses

400 Bad Request

validation_error — an invalid email or unknown role. details.issues lists each problem — see Validation errors.

401 Unauthorized

unauthorized for a missing, invalid or expired token (or an API key); session_revoked when the session has been signed out.

402 Payment Required

USAGE_LIMIT_EXCEEDED — the plan's seat limit is reached, and nobody is added. This is the same check, status and body as Create Invitation: seats are current members plus invitations that can still be accepted (pending and not expired). Free allows 2, Starter 5, Pro 20, Enterprise unlimited. When two requests race for the last seat, one gets 201 and the other gets this error.

json
{
"error": {
"code": "USAGE_LIMIT_EXCEEDED",
"message": "Your free plan allows up to 2 team members. Upgrade to add more.",
"details": {
"limit": "members",
"max": 2,
"tier": "free",
"traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10"
}
}
}

403 Forbidden

forbidden ("Only admins can invite members") — you are a member, or you don't belong to the workspace. This route doesn't include requiredRole/currentRole.

404 Not Found

not_found ("User not found. They must register first.") — no Syntext account has that email. Invite them instead.

409 Conflict

conflict ("User is already a member of this organization").

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl -X POST https://api.syntext.dev/v1/orgs/3f9c2a1e-6b4d-4e8a-a1c7-5d2e9f0b7c13/members \
-H "Authorization: Bearer $SYNTEXT_JWT" \
-H "Content-Type: application/json" \
-d '{ "email": "alex@example.com", "role": "member" }'
Responseapplication/json
201Created
{
"data": {
"id": "7d2c4e6a-1b3f-4a5d-9c8e-0f2a4b6c8d13",
"userId": "0b7e4c2d-9a1f-4d3e-8c56-2f1a7b9e0d48",
"email": "alex@example.com",
"name": "Alex Kim",
"role": "member"
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext