Skip to main content
POST
/
api
/
run
/
users
/
mutations
/
saveOnboarding
saveOnboarding
curl --request POST \
  --url https://connvo-dev.convex.cloud/api/run/users/mutations/saveOnboarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "args": {
    "age": 25,
    "gender": "prefer-not-to-say",
    "field": "Software",
    "jobTitle": "Engineer",
    "company": "Acme",
    "linkedinUrl": "https://linkedin.com/in/test",
    "bio": "Hello, I build things.",
    "interests": [
      {
        "id": "software-engineering",
        "name": "Software Engineering",
        "category": "industry"
      },
      {
        "id": "startups",
        "name": "Startups",
        "category": "personal"
      }
    ],
    "idempotencyKey": "onboarding-test-user"
  }
}'
{
  "status": "success",
  "errorMessage": "",
  "errorData": {},
  "value": {
    "userId": "user_9f3c2ab457",
    "profileId": "profiles_d4c1e87a90",
    "interestsCount": 2,
    "onboardingCompleted": true
  }
}

Authorizations

Authorization
string
header
required

Standard user authentication token issued via WorkOS. Provide as Authorization: Bearer <user-token>.

Body

application/json
args
object
required

Response

Convex executed your request and returned a result

status
enum<string>
required
Available options:
success,
error
errorMessage
string
errorData
object
value
object