Claim onboarding
curl --request POST \
--url https://sitegpt.ai/api/v2/onboarding/workspaces/{workspaceId}/claim \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "user@example.com",
"plan": "GROWTH",
"interval": "MONTH"
}
'import requests
url = "https://sitegpt.ai/api/v2/onboarding/workspaces/{workspaceId}/claim"
payload = {
"email": "user@example.com",
"plan": "GROWTH",
"interval": "MONTH"
}
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({email: 'user@example.com', plan: 'GROWTH', interval: 'MONTH'})
};
fetch('https://sitegpt.ai/api/v2/onboarding/workspaces/{workspaceId}/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://sitegpt.ai/api/v2/onboarding/workspaces/{workspaceId}/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([
'email' => 'user@example.com',
'plan' => 'GROWTH',
'interval' => 'MONTH'
]),
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://sitegpt.ai/api/v2/onboarding/workspaces/{workspaceId}/claim"
payload := strings.NewReader("{\n \"email\": \"user@example.com\",\n \"plan\": \"GROWTH\",\n \"interval\": \"MONTH\"\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://sitegpt.ai/api/v2/onboarding/workspaces/{workspaceId}/claim")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"user@example.com\",\n \"plan\": \"GROWTH\",\n \"interval\": \"MONTH\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sitegpt.ai/api/v2/onboarding/workspaces/{workspaceId}/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 \"email\": \"user@example.com\",\n \"plan\": \"GROWTH\",\n \"interval\": \"MONTH\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"data": {
"workspace": {
"id": "workspace-id",
"chatbotId": "chatbot-id",
"sourceUrl": "https://example.com/",
"normalizedDomain": "example.com",
"status": "CREATED",
"expiresAt": "2026-05-20T00:00:00.000Z",
"claim": {
"status": "CHECKOUT_PENDING",
"email": "user@example.com",
"plan": "GROWTH",
"interval": "MONTH",
"checkoutUrl": "https://sitegpt.ai/pricing?_ptxn=txn_xxxxxxxxx"
}
},
"checkoutUrl": "https://sitegpt.ai/pricing?_ptxn=txn_xxxxxxxxx",
"paddleTransactionId": "txn_xxxxxxxxx",
"onboardingUrl": "https://sitegpt.ai/onboarding/preview/workspace-id",
"statusUrl": "https://sitegpt.ai/api/v2/onboarding/workspaces/workspace-id",
"claimUrl": "https://sitegpt.ai/api/v2/onboarding/workspaces/workspace-id/claim"
},
"meta": {
"requestId": "request-id"
}
}{
"ok": true,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"requestId": "<string>"
}
}{
"ok": true,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"requestId": "<string>"
}
}{
"ok": true,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"requestId": "<string>"
}
}{
"ok": true,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"requestId": "<string>"
}
}{
"ok": true,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"requestId": "<string>"
}
}Onboarding
Claim onboarding
Create checkout for an onboarding workspace claim.
Required scope: account:read.
POST
/
api
/
v2
/
onboarding
/
workspaces
/
{workspaceId}
/
claim
Claim onboarding
curl --request POST \
--url https://sitegpt.ai/api/v2/onboarding/workspaces/{workspaceId}/claim \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "user@example.com",
"plan": "GROWTH",
"interval": "MONTH"
}
'import requests
url = "https://sitegpt.ai/api/v2/onboarding/workspaces/{workspaceId}/claim"
payload = {
"email": "user@example.com",
"plan": "GROWTH",
"interval": "MONTH"
}
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({email: 'user@example.com', plan: 'GROWTH', interval: 'MONTH'})
};
fetch('https://sitegpt.ai/api/v2/onboarding/workspaces/{workspaceId}/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://sitegpt.ai/api/v2/onboarding/workspaces/{workspaceId}/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([
'email' => 'user@example.com',
'plan' => 'GROWTH',
'interval' => 'MONTH'
]),
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://sitegpt.ai/api/v2/onboarding/workspaces/{workspaceId}/claim"
payload := strings.NewReader("{\n \"email\": \"user@example.com\",\n \"plan\": \"GROWTH\",\n \"interval\": \"MONTH\"\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://sitegpt.ai/api/v2/onboarding/workspaces/{workspaceId}/claim")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"user@example.com\",\n \"plan\": \"GROWTH\",\n \"interval\": \"MONTH\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sitegpt.ai/api/v2/onboarding/workspaces/{workspaceId}/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 \"email\": \"user@example.com\",\n \"plan\": \"GROWTH\",\n \"interval\": \"MONTH\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"data": {
"workspace": {
"id": "workspace-id",
"chatbotId": "chatbot-id",
"sourceUrl": "https://example.com/",
"normalizedDomain": "example.com",
"status": "CREATED",
"expiresAt": "2026-05-20T00:00:00.000Z",
"claim": {
"status": "CHECKOUT_PENDING",
"email": "user@example.com",
"plan": "GROWTH",
"interval": "MONTH",
"checkoutUrl": "https://sitegpt.ai/pricing?_ptxn=txn_xxxxxxxxx"
}
},
"checkoutUrl": "https://sitegpt.ai/pricing?_ptxn=txn_xxxxxxxxx",
"paddleTransactionId": "txn_xxxxxxxxx",
"onboardingUrl": "https://sitegpt.ai/onboarding/preview/workspace-id",
"statusUrl": "https://sitegpt.ai/api/v2/onboarding/workspaces/workspace-id",
"claimUrl": "https://sitegpt.ai/api/v2/onboarding/workspaces/workspace-id/claim"
},
"meta": {
"requestId": "request-id"
}
}{
"ok": true,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"requestId": "<string>"
}
}{
"ok": true,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"requestId": "<string>"
}
}{
"ok": true,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"requestId": "<string>"
}
}{
"ok": true,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"requestId": "<string>"
}
}{
"ok": true,
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"requestId": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Customer email that should own the chatbot after checkout starts the trial.
Maximum string length:
254SiteGPT plan selected by the user.
Available options:
STARTER, GROWTH, SCALE Billing interval selected by the user.
Available options:
MONTH, YEAR Was this page helpful?
⌘I