/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Save Onboarding Answers

Save Onboarding Answers

Save your About you answers: what you'll document, your role and your team size.

PUT/v1/me/onboarding/profileTry it
Session token

Saves your answers to the About you step of setup and marks it done. The dashboard uses them to start your first project in the right place — a help centre answer opens the Help centre template, for example.

Note

Requires a session JWT — a dashboard session or an stx login token. API keys are rejected with 401. Any plan. Works before your email address is verified.

Saving again replaces your earlier answers. Answering after you skipped is fine too — the skip is cleared.

Request Body

Any key not listed here is a 400 validation_error.

NameDescription
documenting:string[]bodyRequired
What you'll document — one or more of help_center, product_guides, api_docs, handbook and other, each at most once.
role:stringbodyRequired
One of founder, engineer, technical_writer, product, support and other.
teamSize:stringbodyRequired
One of solo, 2_10, 11_50 and 51_plus.
heardFrom:stringbody
How you heard about Syntext, up to 200 characters. Trimmed; blank is stored as nothing.

Response — 200 OK

Your onboarding state, in the same shape as Get Onboarding, with the profile step done:

Error Responses

400 Bad Request

validation_error — a required answer is missing, a value isn't one of those listed, documenting is empty or lists a value twice, heardFrom is over 200 characters, or the body has another key. details.issues lists each problem.

401 Unauthorized

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

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl -X PUT https://api.syntext.dev/v1/me/onboarding/profile \
-H "Authorization: Bearer $SYNTEXT_JWT" \
-H "Content-Type: application/json" \
-d '{
"documenting": ["help_center", "api_docs"],
"role": "engineer",
"teamSize": "2_10",
"heardFrom": "A friend"
}'
Responseapplication/json
200OK
{
"data": {
"required": true,
"steps": [
{ "id": "verify", "status": "done", "skippable": false },
{ "id": "profile", "status": "done", "skippable": true },
{ "id": "project", "status": "current", "skippable": false },
{ "id": "publish", "status": "todo", "skippable": false }
],
"answers": {
"documenting": ["help_center", "api_docs"],
"role": "engineer",
"teamSize": "2_10",
"heardFrom": "A friend"
}
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext