Update User Onboarding State
curl --request PUT \
--url https://api.eesi.ai/v1/user/onboarding-state \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"completed_at": "2023-11-07T05:31:56Z",
"skipped": true,
"seen_tooltips": [
"<string>"
],
"completed_actions": [
"<string>"
]
}
'import requests
url = "https://api.eesi.ai/v1/user/onboarding-state"
payload = {
"completed_at": "2023-11-07T05:31:56Z",
"skipped": True,
"seen_tooltips": ["<string>"],
"completed_actions": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
completed_at: '2023-11-07T05:31:56Z',
skipped: true,
seen_tooltips: ['<string>'],
completed_actions: ['<string>']
})
};
fetch('https://api.eesi.ai/v1/user/onboarding-state', 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://api.eesi.ai/v1/user/onboarding-state",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'completed_at' => '2023-11-07T05:31:56Z',
'skipped' => true,
'seen_tooltips' => [
'<string>'
],
'completed_actions' => [
'<string>'
]
]),
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://api.eesi.ai/v1/user/onboarding-state"
payload := strings.NewReader("{\n \"completed_at\": \"2023-11-07T05:31:56Z\",\n \"skipped\": true,\n \"seen_tooltips\": [\n \"<string>\"\n ],\n \"completed_actions\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.eesi.ai/v1/user/onboarding-state")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"completed_at\": \"2023-11-07T05:31:56Z\",\n \"skipped\": true,\n \"seen_tooltips\": [\n \"<string>\"\n ],\n \"completed_actions\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eesi.ai/v1/user/onboarding-state")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"completed_at\": \"2023-11-07T05:31:56Z\",\n \"skipped\": true,\n \"seen_tooltips\": [\n \"<string>\"\n ],\n \"completed_actions\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"completed_at": "2023-11-07T05:31:56Z",
"skipped": false,
"seen_tooltips": [
"<string>"
],
"completed_actions": [
"<string>"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}main
Update User Onboarding State
PUT
/
v1
/
user
/
onboarding-state
Update User Onboarding State
curl --request PUT \
--url https://api.eesi.ai/v1/user/onboarding-state \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"completed_at": "2023-11-07T05:31:56Z",
"skipped": true,
"seen_tooltips": [
"<string>"
],
"completed_actions": [
"<string>"
]
}
'import requests
url = "https://api.eesi.ai/v1/user/onboarding-state"
payload = {
"completed_at": "2023-11-07T05:31:56Z",
"skipped": True,
"seen_tooltips": ["<string>"],
"completed_actions": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
completed_at: '2023-11-07T05:31:56Z',
skipped: true,
seen_tooltips: ['<string>'],
completed_actions: ['<string>']
})
};
fetch('https://api.eesi.ai/v1/user/onboarding-state', 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://api.eesi.ai/v1/user/onboarding-state",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'completed_at' => '2023-11-07T05:31:56Z',
'skipped' => true,
'seen_tooltips' => [
'<string>'
],
'completed_actions' => [
'<string>'
]
]),
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://api.eesi.ai/v1/user/onboarding-state"
payload := strings.NewReader("{\n \"completed_at\": \"2023-11-07T05:31:56Z\",\n \"skipped\": true,\n \"seen_tooltips\": [\n \"<string>\"\n ],\n \"completed_actions\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.eesi.ai/v1/user/onboarding-state")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"completed_at\": \"2023-11-07T05:31:56Z\",\n \"skipped\": true,\n \"seen_tooltips\": [\n \"<string>\"\n ],\n \"completed_actions\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eesi.ai/v1/user/onboarding-state")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"completed_at\": \"2023-11-07T05:31:56Z\",\n \"skipped\": true,\n \"seen_tooltips\": [\n \"<string>\"\n ],\n \"completed_actions\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"completed_at": "2023-11-07T05:31:56Z",
"skipped": false,
"seen_tooltips": [
"<string>"
],
"completed_actions": [
"<string>"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
BearerAuthApiKeyHeader
An EESI API key (sk-eesi-...) or a Clerk session token.
Body
application/json
Partial update merged into the stored state.
Scalars overwrite when supplied; list entries are unioned into the stored lists, so concurrent updates (e.g. two tabs marking different tooltips) don't drop each other's items.
Response
Successful Response
Per-user onboarding state, stored under UserConfigurationKey.ONBOARDING.
Server-authoritative replacement for the browser-localStorage onboarding store, so the post-signup gate and one-time tooltips hold across devices.