Update Auto-Sync Preference
Turns the account-level background document sync on or off. Requires the `user:write` scope when called with an API key. This is the account-wide switch. It does not override a document's own `keepLocalOnly` flag — a document opted out individually stays local even with auto-sync on. Turning auto-sync off does not delete anything already synced; it only stops new local edits from being pushed. Defaults to `true` on a new account. A successful change invalidates the caller's cached session.
Your personal API key — vw_ followed by 64 hex characters. The same key is also accepted
as Authorization: Bearer vw_....
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PUT "https://example.com/api/v1/users/me/sync" \ -H "Content-Type: application/json" \ -d '{ "enabled": true }'{ "success": true, "message": "Auto sync preference updated successfully", "data": { "id": "cmnu7awv4000063lk18zpon2m", "name": "VeriWorkly User", "username": "veriworkly-user", "email": "[email protected]", "emailVerified": true, "autoSyncEnabled": true, "createdAt": "2026-04-11T10:37:35.584Z", "updatedAt": "2026-04-26T02:00:00.000Z", "_count": { "apiKeys": 2, "shareLinks": 4, "resumes": 4 } }}Check Username AvailabilityGET
Reports whether a username can be claimed. Intended to drive live feedback in a username picker before `PUT /users/me/username` is called. This route carries **no API-key scope gate**, unlike the rest of the Users module — but it is still not anonymous, so it needs an API key or a whitelisted first-party origin. The path segment is normalised the same way the update endpoint normalises it, and `normalizedUsername` echoes back the value that would actually be stored. A `200` with `available: false` is the normal negative answer — an unavailable name is not an error.
Master Profile
The single source of truth new resumes, cover letters, and portfolios are seeded from.