Claim the preview after signing in
curl --request POST \
--url https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/claim/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"mailbox": "gmail"
}
'import requests
url = "https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/claim/"
payload = { "mailbox": "gmail" }
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({mailbox: 'gmail'})
};
fetch('https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/claim/', 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/runs/{run_id}/claim/",
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([
'mailbox' => 'gmail'
]),
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.getoneprofile.ai/onboarding-wizard/runs/{run_id}/claim/"
payload := strings.NewReader("{\n \"mailbox\": \"gmail\"\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://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/claim/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"mailbox\": \"gmail\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/claim/")
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 \"mailbox\": \"gmail\"\n}"
response = http.request(request)
puts response.read_body{
"colleague_org_id": "<string>",
"colleague_org_name": "<string>",
"gmail_needed": true,
"mail_grant_needed": true,
"mailbox": "gmail",
"org_id": "<string>",
"sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"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>"
}onboarding-wizard
Claim the preview after signing in
Makes the person who just signed in (Google or Microsoft, mailbox) the owner of the preview’s workspace, then connects their Gmail or Outlook and starts the sequence in the background. When colleagues at the company already have a workspace, the campaign waits and colleague_org_id names it. When the sign-in has not allowed mail yet, nothing launches and mail_grant_needed says so: ask the provider for send and read, then claim again. Work accounts at the previewed company only.
POST
/
onboarding-wizard
/
runs
/
{run_id}
/
claim
/
Claim the preview after signing in
curl --request POST \
--url https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/claim/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"mailbox": "gmail"
}
'import requests
url = "https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/claim/"
payload = { "mailbox": "gmail" }
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({mailbox: 'gmail'})
};
fetch('https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/claim/', 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/runs/{run_id}/claim/",
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([
'mailbox' => 'gmail'
]),
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.getoneprofile.ai/onboarding-wizard/runs/{run_id}/claim/"
payload := strings.NewReader("{\n \"mailbox\": \"gmail\"\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://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/claim/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"mailbox\": \"gmail\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/claim/")
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 \"mailbox\": \"gmail\"\n}"
response = http.request(request)
puts response.read_body{
"colleague_org_id": "<string>",
"colleague_org_name": "<string>",
"gmail_needed": true,
"mail_grant_needed": true,
"mailbox": "gmail",
"org_id": "<string>",
"sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"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>"
}Authorizations
HTTPBearerAPIKeyHeader
Body
application/json
Response
Successful Response
What a sign-in made of the preview.
Was this page helpful?