curl --request PUT \
--url https://api.getoneprofile.ai/onboarding-wizard/own-runs/current/segment/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"index": 1,
"switch": false,
"timezone": "<string>"
}
'import requests
url = "https://api.getoneprofile.ai/onboarding-wizard/own-runs/current/segment/"
payload = {
"index": 1,
"switch": False,
"timezone": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({index: 1, switch: false, timezone: '<string>'})
};
fetch('https://api.getoneprofile.ai/onboarding-wizard/own-runs/current/segment/', 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.getoneprofile.ai/onboarding-wizard/own-runs/current/segment/",
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([
'index' => 1,
'switch' => false,
'timezone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.getoneprofile.ai/onboarding-wizard/own-runs/current/segment/"
payload := strings.NewReader("{\n \"index\": 1,\n \"switch\": false,\n \"timezone\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.getoneprofile.ai/onboarding-wizard/own-runs/current/segment/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"index\": 1,\n \"switch\": false,\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/onboarding-wizard/own-runs/current/segment/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"index\": 1,\n \"switch\": false,\n \"timezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"build_error": "<string>",
"claimed": true,
"context": {
"company_description": "<string>",
"ideal_buyer_personas": "<string>",
"ideal_customer_profile": "<string>",
"interest_signals": "<string>",
"pilot_offer": "<string>",
"social_proof": "<string>"
},
"dns_issue": "no_dmarc",
"domain": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insights_error": "<string>",
"join_requested_at": "2023-11-07T05:31:56Z",
"launch_error": "<string>",
"launched_at": "2023-11-07T05:31:56Z",
"learnings": [
"<string>"
],
"messages": [
{
"email_body": "<string>",
"email_subject": "<string>",
"label": "<string>",
"linkedin_body": "<string>",
"looks_good": true,
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "writing"
}
],
"outlook_available": true,
"own_workspace": true,
"people": [
{
"company": "<string>",
"email": "<string>",
"email_status": "valid",
"in_preview": true,
"linkedin_url": "<string>",
"name": "<string>",
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"researched": true,
"title": "<string>",
"why": "<string>"
}
],
"people_table_ready": true,
"research": {
"error": "<string>",
"status": "pending",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
]
},
"segment_index": 123,
"segments": [
{
"batch": 123,
"companies": "<string>",
"counted": true,
"description": "<string>",
"index": 123,
"job_titles": [
"<string>"
],
"label": "<string>",
"matches": 123,
"reason": "<string>",
"too_small": true,
"wanted": "<string>"
}
],
"sender_name": "<string>",
"sender_source": "about_page",
"sender_title": "<string>",
"sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage": "researching",
"stalled": true,
"company_name": "<string>",
"connect_credits": 0,
"credits_left": 0,
"credits_per_person": 0,
"headline": "<string>",
"logo_path": "<string>",
"people_covered": 0,
"preview_settled": false,
"subheadline": "<string>",
"suggestions_full": false,
"switch_credits": 0
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Pick the audience of your own wizard run
Picks one of the audiences the signed-in person’s wizard run in their active workspace offers (the run GET /own-runs/ lists), as the wizard page’s pick does: finds 100 people of it, researches the top 10 and writes their first messages. Needs no session token: the sign-in finds the run, so an AI app connected to the workspace can pick it. 404 when the person has no run still to finish; 409 when the pick is refused where it stands (no such audience, too few people, people already found).
curl --request PUT \
--url https://api.getoneprofile.ai/onboarding-wizard/own-runs/current/segment/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"index": 1,
"switch": false,
"timezone": "<string>"
}
'import requests
url = "https://api.getoneprofile.ai/onboarding-wizard/own-runs/current/segment/"
payload = {
"index": 1,
"switch": False,
"timezone": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({index: 1, switch: false, timezone: '<string>'})
};
fetch('https://api.getoneprofile.ai/onboarding-wizard/own-runs/current/segment/', 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.getoneprofile.ai/onboarding-wizard/own-runs/current/segment/",
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([
'index' => 1,
'switch' => false,
'timezone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.getoneprofile.ai/onboarding-wizard/own-runs/current/segment/"
payload := strings.NewReader("{\n \"index\": 1,\n \"switch\": false,\n \"timezone\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.getoneprofile.ai/onboarding-wizard/own-runs/current/segment/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"index\": 1,\n \"switch\": false,\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/onboarding-wizard/own-runs/current/segment/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"index\": 1,\n \"switch\": false,\n \"timezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"build_error": "<string>",
"claimed": true,
"context": {
"company_description": "<string>",
"ideal_buyer_personas": "<string>",
"ideal_customer_profile": "<string>",
"interest_signals": "<string>",
"pilot_offer": "<string>",
"social_proof": "<string>"
},
"dns_issue": "no_dmarc",
"domain": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insights_error": "<string>",
"join_requested_at": "2023-11-07T05:31:56Z",
"launch_error": "<string>",
"launched_at": "2023-11-07T05:31:56Z",
"learnings": [
"<string>"
],
"messages": [
{
"email_body": "<string>",
"email_subject": "<string>",
"label": "<string>",
"linkedin_body": "<string>",
"looks_good": true,
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "writing"
}
],
"outlook_available": true,
"own_workspace": true,
"people": [
{
"company": "<string>",
"email": "<string>",
"email_status": "valid",
"in_preview": true,
"linkedin_url": "<string>",
"name": "<string>",
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"researched": true,
"title": "<string>",
"why": "<string>"
}
],
"people_table_ready": true,
"research": {
"error": "<string>",
"status": "pending",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
]
},
"segment_index": 123,
"segments": [
{
"batch": 123,
"companies": "<string>",
"counted": true,
"description": "<string>",
"index": 123,
"job_titles": [
"<string>"
],
"label": "<string>",
"matches": 123,
"reason": "<string>",
"too_small": true,
"wanted": "<string>"
}
],
"sender_name": "<string>",
"sender_source": "about_page",
"sender_title": "<string>",
"sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage": "researching",
"stalled": true,
"company_name": "<string>",
"connect_credits": 0,
"credits_left": 0,
"credits_per_person": 0,
"headline": "<string>",
"logo_path": "<string>",
"people_covered": 0,
"preview_settled": false,
"subheadline": "<string>",
"suggestions_full": false,
"switch_credits": 0
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Body
Pick one of the offered segments.
Response
Successful Response
A preview: everything the wizard's page shows.
Where a run stands, derived from what it holds. Never stored.
The frontend's five steps map onto these: researching and segments are step 1 and 2, finding is step 3, and writing is step 4 from the first message written (the page reads the messages themselves to tell).
researching, research_failed, segments, finding, finding_failed, writing, launched Was this page helpful?