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

Register

Create an account with email and password, plus its personal workspace.

POST/v1/auth/registerTry it
Session token

Creates an account, a personal workspace that you own, and a browser session. A verification email goes to the address straight away; registration still succeeds if that email can't be sent.

Note

Public — no credential needed. Any plan.

Request Body

NameDescription
email:stringbodyRequired
The account's email address. Must not belong to another account.
name:stringbodyRequired
Your name, 2–100 characters.
password:stringbodyRequired
8–128 characters.
orgName:stringbody
The personal workspace's name, 2–100 characters. Defaults to "<name>'s Org".
acceptedTerms:booleanbody
true when the person ticked the Terms of Service and Privacy Policy box. Recorded only together with termsVersion.
termsVersion:stringbody
The version of the Terms the sign-up form showed, 1–64 letters, digits, ., _ or -. Each acceptance is kept with its version, time and IP address.
marketingConsent:booleanbody
The optional "email me tips and news" box. How it's stored depends on country — see Marketing consent.
timezone:stringbody
The browser's IANA timezone, e.g. Europe/London. Used to send email at a sensible local time. An invalid value is ignored, not rejected.
country:stringbody
The browser's ISO 3166-1 alpha-2 country code, e.g. GB (case doesn't matter). Decides the marketing consent rule. An invalid value is ignored, not rejected.
inviteToken:stringbody
The invitation token, when sign-up started from an invitation link. It records that the account came from an invitation if the token names a pending invitation to the same email address. It does not join the workspace — call Accept Invitation for that.
Note

Terms acceptance will become required. Today acceptedTerms and termsVersion are optional: when both are sent the acceptance is recorded, and when they aren't, the account is created anyway. Once the requirement is switched on, a request without acceptedTerms: true and a termsVersion returns 400 terms_required. Send both now so nothing changes for you then.

The UK, the EU and the rest of the EEA (Iceland, Liechtenstein, Norway) need an explicit opt-in before marketing email. Elsewhere, a soft opt-in applies: you're subscribed unless you say no, and every email lets you leave.

countrymarketingConsent: truemarketingConsent: falseOmitted
UK, EU or EEAOpted inNot opted inNot opted in
Not sent, or invalidOpted inNot opted inNot opted in
Anywhere elseOpted inNot opted inSoft opt-in

An unknown country gets the stricter rule. The dashboard's sign-up forms don't send country, so everyone who signs up there gets the opt-in rule: unticked means not opted in. Consent only ever affects marketing email — account, security, build and billing email is sent either way. Change it later with Update Email Preferences; see Email from Syntext.

Error Responses

400 Bad Request

terms_required — only once the Terms requirement is on: acceptedTerms isn't true, or termsVersion is missing.

json
{
"error": {
"code": "terms_required",
"message": "Accept the Terms of Service and Privacy Policy to create an account.",
"details": { "traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10" }
}
}

validation_error — a missing or invalid field, such as a short password or a termsVersion with other characters. Each problem is in details.issues.

409 Conflict

conflict — an account with this email already exists ("Email already registered").

Was this page helpful? Yes No
Previous
Next
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl -X POST https://api.syntext.dev/v1/auth/register \
-H "Content-Type: application/json" \
-d '{
"email": "alex@example.com",
"name": "Alex Rivera",
"password": "a much longer passphrase",
"acceptedTerms": true,
"termsVersion": "2026-11-01",
"marketingConsent": false,
"timezone": "Europe/London",
"country": "GB"
}'
Responseapplication/json
201Created
{
"data": {
"user": { "id": "0b7e4c2d-9a1f-4d3e-8c56-2f1a7b9e0d48", "email": "alex@example.com", "name": "Alex Rivera" },
"organization": { "id": "9c2e7a14-5b3d-4f86-a1e0-7d4b2c9f6e31", "name": "Alex Rivera's Org", "slug": "alex-rivera" },
"accessToken": "eyJhbGciOiJIUzI1NiIs...",
"refreshToken": "2f8c1e9a7b...",
"expiresIn": 3600
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext