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"
}
}
'import requests
url = "https://connvo-dev.convex.cloud/api/run/users/mutations/saveOnboarding"
payload = { "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"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
}
})
};
fetch('https://connvo-dev.convex.cloud/api/run/users/mutations/saveOnboarding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://connvo-dev.convex.cloud/api/run/users/mutations/saveOnboarding",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://connvo-dev.convex.cloud/api/run/users/mutations/saveOnboarding"
payload := strings.NewReader("{\n \"args\": {\n \"age\": 25,\n \"gender\": \"prefer-not-to-say\",\n \"field\": \"Software\",\n \"jobTitle\": \"Engineer\",\n \"company\": \"Acme\",\n \"linkedinUrl\": \"https://linkedin.com/in/test\",\n \"bio\": \"Hello, I build things.\",\n \"interests\": [\n {\n \"id\": \"software-engineering\",\n \"name\": \"Software Engineering\",\n \"category\": \"industry\"\n },\n {\n \"id\": \"startups\",\n \"name\": \"Startups\",\n \"category\": \"personal\"\n }\n ],\n \"idempotencyKey\": \"onboarding-test-user\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://connvo-dev.convex.cloud/api/run/users/mutations/saveOnboarding")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"args\": {\n \"age\": 25,\n \"gender\": \"prefer-not-to-say\",\n \"field\": \"Software\",\n \"jobTitle\": \"Engineer\",\n \"company\": \"Acme\",\n \"linkedinUrl\": \"https://linkedin.com/in/test\",\n \"bio\": \"Hello, I build things.\",\n \"interests\": [\n {\n \"id\": \"software-engineering\",\n \"name\": \"Software Engineering\",\n \"category\": \"industry\"\n },\n {\n \"id\": \"startups\",\n \"name\": \"Startups\",\n \"category\": \"personal\"\n }\n ],\n \"idempotencyKey\": \"onboarding-test-user\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://connvo-dev.convex.cloud/api/run/users/mutations/saveOnboarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"args\": {\n \"age\": 25,\n \"gender\": \"prefer-not-to-say\",\n \"field\": \"Software\",\n \"jobTitle\": \"Engineer\",\n \"company\": \"Acme\",\n \"linkedinUrl\": \"https://linkedin.com/in/test\",\n \"bio\": \"Hello, I build things.\",\n \"interests\": [\n {\n \"id\": \"software-engineering\",\n \"name\": \"Software Engineering\",\n \"category\": \"industry\"\n },\n {\n \"id\": \"startups\",\n \"name\": \"Startups\",\n \"category\": \"personal\"\n }\n ],\n \"idempotencyKey\": \"onboarding-test-user\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"errorMessage": "",
"errorData": {},
"value": {
"userId": "user_9f3c2ab457",
"profileId": "profiles_d4c1e87a90",
"interestsCount": 2,
"onboardingCompleted": true
}
}{}{}Users
saveOnboarding
Atomically persists a member’s onboarding payload – profile metadata, interest selections, and completion flags – while enforcing validation rules and idempotency. The mutation uses a scoped idempotency key so the same payload can be retried without duplicating interests or profiles.
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"
}
}
'import requests
url = "https://connvo-dev.convex.cloud/api/run/users/mutations/saveOnboarding"
payload = { "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"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
}
})
};
fetch('https://connvo-dev.convex.cloud/api/run/users/mutations/saveOnboarding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://connvo-dev.convex.cloud/api/run/users/mutations/saveOnboarding",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://connvo-dev.convex.cloud/api/run/users/mutations/saveOnboarding"
payload := strings.NewReader("{\n \"args\": {\n \"age\": 25,\n \"gender\": \"prefer-not-to-say\",\n \"field\": \"Software\",\n \"jobTitle\": \"Engineer\",\n \"company\": \"Acme\",\n \"linkedinUrl\": \"https://linkedin.com/in/test\",\n \"bio\": \"Hello, I build things.\",\n \"interests\": [\n {\n \"id\": \"software-engineering\",\n \"name\": \"Software Engineering\",\n \"category\": \"industry\"\n },\n {\n \"id\": \"startups\",\n \"name\": \"Startups\",\n \"category\": \"personal\"\n }\n ],\n \"idempotencyKey\": \"onboarding-test-user\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://connvo-dev.convex.cloud/api/run/users/mutations/saveOnboarding")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"args\": {\n \"age\": 25,\n \"gender\": \"prefer-not-to-say\",\n \"field\": \"Software\",\n \"jobTitle\": \"Engineer\",\n \"company\": \"Acme\",\n \"linkedinUrl\": \"https://linkedin.com/in/test\",\n \"bio\": \"Hello, I build things.\",\n \"interests\": [\n {\n \"id\": \"software-engineering\",\n \"name\": \"Software Engineering\",\n \"category\": \"industry\"\n },\n {\n \"id\": \"startups\",\n \"name\": \"Startups\",\n \"category\": \"personal\"\n }\n ],\n \"idempotencyKey\": \"onboarding-test-user\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://connvo-dev.convex.cloud/api/run/users/mutations/saveOnboarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"args\": {\n \"age\": 25,\n \"gender\": \"prefer-not-to-say\",\n \"field\": \"Software\",\n \"jobTitle\": \"Engineer\",\n \"company\": \"Acme\",\n \"linkedinUrl\": \"https://linkedin.com/in/test\",\n \"bio\": \"Hello, I build things.\",\n \"interests\": [\n {\n \"id\": \"software-engineering\",\n \"name\": \"Software Engineering\",\n \"category\": \"industry\"\n },\n {\n \"id\": \"startups\",\n \"name\": \"Startups\",\n \"category\": \"personal\"\n }\n ],\n \"idempotencyKey\": \"onboarding-test-user\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"errorMessage": "",
"errorData": {},
"value": {
"userId": "user_9f3c2ab457",
"profileId": "profiles_d4c1e87a90",
"interestsCount": 2,
"onboardingCompleted": true
}
}{}{}Authorizations
Standard user authentication token issued via WorkOS. Provide as Authorization: Bearer <user-token>.
Body
application/json
Show child attributes
Show child attributes
⌘I