/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Accept Invitation

Accept Invitation

Join a workspace from an invitation.

POST/v1/invites/{token}/acceptTry it
Session token

Joins the workspace with the role the invitation grants. You must be signed in with the email address the invitation was sent to.

Note

Requires a session JWT for the invited account. API keys are rejected with 401. Any plan.

Email verification

The invitation email is proof that you own the address, so for invitations sent by the current version of Syntext you don't need to verify your email first. Accepting one with an unverified account marks the address as verified.

Invitations created before that change may have been visible to other workspace members, so they still need an account whose email is already verified. Those return 403 email_unverified until you verify. Resending an older invitation doesn't change this — ask an admin for a new invitation instead.

Note

For self-hosted deployments: the cutoff is the INVITE_EMAIL_PROOF_SINCE environment variable, an ISO-8601 timestamp with a time zone (for example 2026-11-10T12:00:00Z). Invitations created at or after it count as proof of the address. When it is unset, the cutoff is the time the API server process started, so a restart makes earlier invitations require a verified email again. An invalid value stops the server from starting.

Path Parameters

NameDescription
token:stringpathRequired
The invitation token from the link in the invitation email.

Response — 200 OK

Accepting also closes any other pending invitations to the same address in that workspace. It is recorded in the audit log as org.invite.accepted, with emailVerifiedByInvite: true in the metadata when the invitation verified your address.

Error Responses

400 Bad Request

bad_request — the invitation can't be used:

•
"This invitation has already been used or revoked" — it was accepted, declined or revoked, or another accept got there first.
•
"This invitation has expired. Ask the admin to send a new one." — the invitation is marked expired at the same time.

401 Unauthorized

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

403 Forbidden

invite_email_mismatch — you are signed in with a different address than the invitation's. The comparison ignores case and surrounding whitespace:

json
{
"error": {
"code": "invite_email_mismatch",
"message": "This invitation was sent to a different email address.",
"details": { "traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10" }
}
}

email_unverified — only for invitations created before the cutoff described in Email verification, when your account's email isn't verified:

json
{
"error": {
"code": "email_unverified",
"message": "Verify your email address before accepting this invitation. Check your inbox for the verification link, then try again.",
"details": { "traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10" }
}
}

404 Not Found

not_found ("Invitation not found") — no invitation has this token.

409 Conflict

conflict ("You are already a member of this organization"). The invitation is marked accepted so it can't be used again.

See also Invitation errors.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl -X POST https://api.syntext.dev/v1/invites/4e7a9c1b-3d5f-4a8c-b2e4-6f8a0c2e4b67/accept \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
200OK
{
"data": {
"orgId": "3f9c2a1e-6b4d-4e8a-a1c7-5d2e9f0b7c13",
"orgName": "Acme",
"role": "member"
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext