curl --request POST \
--url https://app.pixie.ai/api/onboarding/approve-section \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"runFirstScan": true
}
'import requests
url = "https://app.pixie.ai/api/onboarding/approve-section"
payload = { "runFirstScan": True }
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({runFirstScan: true})
};
fetch('https://app.pixie.ai/api/onboarding/approve-section', 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://app.pixie.ai/api/onboarding/approve-section",
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([
'runFirstScan' => true
]),
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://app.pixie.ai/api/onboarding/approve-section"
payload := strings.NewReader("{\n \"runFirstScan\": true\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://app.pixie.ai/api/onboarding/approve-section")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"runFirstScan\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.pixie.ai/api/onboarding/approve-section")
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 \"runFirstScan\": true\n}"
response = http.request(request)
puts response.read_body{
"section": "<string>",
"approved": true,
"onboardingCompleted": true,
"signalScanTriggered": true
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Approve onboarding section
Mark an onboarding section as approved by the user. The legacy final approval step completes onboarding without starting legacy scans.
curl --request POST \
--url https://app.pixie.ai/api/onboarding/approve-section \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"runFirstScan": true
}
'import requests
url = "https://app.pixie.ai/api/onboarding/approve-section"
payload = { "runFirstScan": True }
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({runFirstScan: true})
};
fetch('https://app.pixie.ai/api/onboarding/approve-section', 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://app.pixie.ai/api/onboarding/approve-section",
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([
'runFirstScan' => true
]),
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://app.pixie.ai/api/onboarding/approve-section"
payload := strings.NewReader("{\n \"runFirstScan\": true\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://app.pixie.ai/api/onboarding/approve-section")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"runFirstScan\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.pixie.ai/api/onboarding/approve-section")
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 \"runFirstScan\": true\n}"
response = http.request(request)
puts response.read_body{
"section": "<string>",
"approved": true,
"onboardingCompleted": true,
"signalScanTriggered": true
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}pixie onboarding approve-section create --section <section>
pixie onboarding approve-section create --section <section> --run-first-scan
Overview
Mark an onboarding section as approved by the user. The legacy final approval step completes onboarding without starting legacy scans. This page documentspost /api/onboarding/approve-section. Use the request and response sections on this page for accepted parameters, payload fields, response fields, and authentication behavior.
AI agent notes
- Confirm the operation matches the user’s intent before calling it.
- For write operations, confirm the user intends to change state.
- Surface validation, permission, and not-found errors instead of retrying unchanged.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Mark a per-section onboarding draft as approved by the user. Idempotent: re-approving a section is a no-op.
Response
Section approved.
Result of approving an onboarding section.
Echo of the approved section key.
Always true on a 200. The section is approved (whether it was approved by this call or already approved).
Deprecated. Always false — call completeOnboarding to finish onboarding after all sections are approved.
Deprecated legacy Signals field. Always false because old scans are no longer triggered from onboarding.
Was this page helpful?