Publish the native chat sign-up forms
curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/settings/native-chat/signup-forms \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"version": 1,
"id": "form_newsletter",
"name": "Newsletter popup",
"enabled": true,
"display": {
"type": "popup",
"position": "center",
"delay_seconds": 5
},
"consent": {
"enabled": true,
"channel": "email"
},
"variants": [
{
"id": "v_a",
"name": "Variant A",
"weight": 1,
"headline": "Stay in the loop",
"fields": [
{
"id": "email",
"label": "Email",
"type": "email",
"required": true,
"maps_to": "email"
}
]
}
]
}
]
'import requests
url = "https://api.orbit.devotel.io/api/v1/settings/native-chat/signup-forms"
payload = [
{
"version": 1,
"id": "form_newsletter",
"name": "Newsletter popup",
"enabled": True,
"display": {
"type": "popup",
"position": "center",
"delay_seconds": 5
},
"consent": {
"enabled": True,
"channel": "email"
},
"variants": [
{
"id": "v_a",
"name": "Variant A",
"weight": 1,
"headline": "Stay in the loop",
"fields": [
{
"id": "email",
"label": "Email",
"type": "email",
"required": True,
"maps_to": "email"
}
]
}
]
}
]
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([
{
version: 1,
id: 'form_newsletter',
name: 'Newsletter popup',
enabled: true,
display: {type: 'popup', position: 'center', delay_seconds: 5},
consent: {enabled: true, channel: 'email'},
variants: [
{
id: 'v_a',
name: 'Variant A',
weight: 1,
headline: 'Stay in the loop',
fields: [{id: 'email', label: 'Email', type: 'email', required: true, maps_to: 'email'}]
}
]
}
])
};
fetch('https://api.orbit.devotel.io/api/v1/settings/native-chat/signup-forms', 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.orbit.devotel.io/api/v1/settings/native-chat/signup-forms",
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([
[
'version' => 1,
'id' => 'form_newsletter',
'name' => 'Newsletter popup',
'enabled' => true,
'display' => [
'type' => 'popup',
'position' => 'center',
'delay_seconds' => 5
],
'consent' => [
'enabled' => true,
'channel' => 'email'
],
'variants' => [
[
'id' => 'v_a',
'name' => 'Variant A',
'weight' => 1,
'headline' => 'Stay in the loop',
'fields' => [
[
'id' => 'email',
'label' => 'Email',
'type' => 'email',
'required' => true,
'maps_to' => 'email'
]
]
]
]
]
]),
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.orbit.devotel.io/api/v1/settings/native-chat/signup-forms"
payload := strings.NewReader("[\n {\n \"version\": 1,\n \"id\": \"form_newsletter\",\n \"name\": \"Newsletter popup\",\n \"enabled\": true,\n \"display\": {\n \"type\": \"popup\",\n \"position\": \"center\",\n \"delay_seconds\": 5\n },\n \"consent\": {\n \"enabled\": true,\n \"channel\": \"email\"\n },\n \"variants\": [\n {\n \"id\": \"v_a\",\n \"name\": \"Variant A\",\n \"weight\": 1,\n \"headline\": \"Stay in the loop\",\n \"fields\": [\n {\n \"id\": \"email\",\n \"label\": \"Email\",\n \"type\": \"email\",\n \"required\": true,\n \"maps_to\": \"email\"\n }\n ]\n }\n ]\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.orbit.devotel.io/api/v1/settings/native-chat/signup-forms")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"version\": 1,\n \"id\": \"form_newsletter\",\n \"name\": \"Newsletter popup\",\n \"enabled\": true,\n \"display\": {\n \"type\": \"popup\",\n \"position\": \"center\",\n \"delay_seconds\": 5\n },\n \"consent\": {\n \"enabled\": true,\n \"channel\": \"email\"\n },\n \"variants\": [\n {\n \"id\": \"v_a\",\n \"name\": \"Variant A\",\n \"weight\": 1,\n \"headline\": \"Stay in the loop\",\n \"fields\": [\n {\n \"id\": \"email\",\n \"label\": \"Email\",\n \"type\": \"email\",\n \"required\": true,\n \"maps_to\": \"email\"\n }\n ]\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/settings/native-chat/signup-forms")
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 {\n \"version\": 1,\n \"id\": \"form_newsletter\",\n \"name\": \"Newsletter popup\",\n \"enabled\": true,\n \"display\": {\n \"type\": \"popup\",\n \"position\": \"center\",\n \"delay_seconds\": 5\n },\n \"consent\": {\n \"enabled\": true,\n \"channel\": \"email\"\n },\n \"variants\": [\n {\n \"id\": \"v_a\",\n \"name\": \"Variant A\",\n \"weight\": 1,\n \"headline\": \"Stay in the loop\",\n \"fields\": [\n {\n \"id\": \"email\",\n \"label\": \"Email\",\n \"type\": \"email\",\n \"required\": true,\n \"maps_to\": \"email\"\n }\n ]\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"data": {
"forms": [
{}
]
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Settings
Publish the native chat sign-up forms
Publishes the tenant’s on-site sign-up forms — popups, flyouts, embeds and exit-intent teasers that grow the tenant’s own contact lists. The body is the FULL form set (max 50), replacing the stored set; each form carries display rules, an optional consent block, one to four A/B variants and a post-submit action. Omitted sections fall back to their documented defaults. Owner/admin only. Runtime validation stays with the handler’s Zod gate, which answers a malformed payload with the platform 422 envelope.
PUT
/
api
/
v1
/
settings
/
native-chat
/
signup-forms
Publish the native chat sign-up forms
curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/settings/native-chat/signup-forms \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"version": 1,
"id": "form_newsletter",
"name": "Newsletter popup",
"enabled": true,
"display": {
"type": "popup",
"position": "center",
"delay_seconds": 5
},
"consent": {
"enabled": true,
"channel": "email"
},
"variants": [
{
"id": "v_a",
"name": "Variant A",
"weight": 1,
"headline": "Stay in the loop",
"fields": [
{
"id": "email",
"label": "Email",
"type": "email",
"required": true,
"maps_to": "email"
}
]
}
]
}
]
'import requests
url = "https://api.orbit.devotel.io/api/v1/settings/native-chat/signup-forms"
payload = [
{
"version": 1,
"id": "form_newsletter",
"name": "Newsletter popup",
"enabled": True,
"display": {
"type": "popup",
"position": "center",
"delay_seconds": 5
},
"consent": {
"enabled": True,
"channel": "email"
},
"variants": [
{
"id": "v_a",
"name": "Variant A",
"weight": 1,
"headline": "Stay in the loop",
"fields": [
{
"id": "email",
"label": "Email",
"type": "email",
"required": True,
"maps_to": "email"
}
]
}
]
}
]
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([
{
version: 1,
id: 'form_newsletter',
name: 'Newsletter popup',
enabled: true,
display: {type: 'popup', position: 'center', delay_seconds: 5},
consent: {enabled: true, channel: 'email'},
variants: [
{
id: 'v_a',
name: 'Variant A',
weight: 1,
headline: 'Stay in the loop',
fields: [{id: 'email', label: 'Email', type: 'email', required: true, maps_to: 'email'}]
}
]
}
])
};
fetch('https://api.orbit.devotel.io/api/v1/settings/native-chat/signup-forms', 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.orbit.devotel.io/api/v1/settings/native-chat/signup-forms",
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([
[
'version' => 1,
'id' => 'form_newsletter',
'name' => 'Newsletter popup',
'enabled' => true,
'display' => [
'type' => 'popup',
'position' => 'center',
'delay_seconds' => 5
],
'consent' => [
'enabled' => true,
'channel' => 'email'
],
'variants' => [
[
'id' => 'v_a',
'name' => 'Variant A',
'weight' => 1,
'headline' => 'Stay in the loop',
'fields' => [
[
'id' => 'email',
'label' => 'Email',
'type' => 'email',
'required' => true,
'maps_to' => 'email'
]
]
]
]
]
]),
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.orbit.devotel.io/api/v1/settings/native-chat/signup-forms"
payload := strings.NewReader("[\n {\n \"version\": 1,\n \"id\": \"form_newsletter\",\n \"name\": \"Newsletter popup\",\n \"enabled\": true,\n \"display\": {\n \"type\": \"popup\",\n \"position\": \"center\",\n \"delay_seconds\": 5\n },\n \"consent\": {\n \"enabled\": true,\n \"channel\": \"email\"\n },\n \"variants\": [\n {\n \"id\": \"v_a\",\n \"name\": \"Variant A\",\n \"weight\": 1,\n \"headline\": \"Stay in the loop\",\n \"fields\": [\n {\n \"id\": \"email\",\n \"label\": \"Email\",\n \"type\": \"email\",\n \"required\": true,\n \"maps_to\": \"email\"\n }\n ]\n }\n ]\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.orbit.devotel.io/api/v1/settings/native-chat/signup-forms")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"version\": 1,\n \"id\": \"form_newsletter\",\n \"name\": \"Newsletter popup\",\n \"enabled\": true,\n \"display\": {\n \"type\": \"popup\",\n \"position\": \"center\",\n \"delay_seconds\": 5\n },\n \"consent\": {\n \"enabled\": true,\n \"channel\": \"email\"\n },\n \"variants\": [\n {\n \"id\": \"v_a\",\n \"name\": \"Variant A\",\n \"weight\": 1,\n \"headline\": \"Stay in the loop\",\n \"fields\": [\n {\n \"id\": \"email\",\n \"label\": \"Email\",\n \"type\": \"email\",\n \"required\": true,\n \"maps_to\": \"email\"\n }\n ]\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/settings/native-chat/signup-forms")
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 {\n \"version\": 1,\n \"id\": \"form_newsletter\",\n \"name\": \"Newsletter popup\",\n \"enabled\": true,\n \"display\": {\n \"type\": \"popup\",\n \"position\": \"center\",\n \"delay_seconds\": 5\n },\n \"consent\": {\n \"enabled\": true,\n \"channel\": \"email\"\n },\n \"variants\": [\n {\n \"id\": \"v_a\",\n \"name\": \"Variant A\",\n \"weight\": 1,\n \"headline\": \"Stay in the loop\",\n \"fields\": [\n {\n \"id\": \"email\",\n \"label\": \"Email\",\n \"type\": \"email\",\n \"required\": true,\n \"maps_to\": \"email\"\n }\n ]\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"data": {
"forms": [
{}
]
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
Required string length:
1 - 255Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
Available options:
true, false Body
application/json
The complete published sign-up form set.
Maximum array length:
50Form contract version; always 1.
Available options:
1 Stable form identifier.
Required string length:
1 - 64Operator-facing form name.
Required string length:
1 - 120Whether the form is live; disabled drafts are stored but never served to visitors.
Contact list captured subscribers join; omit to create list-less contacts.
How the form surfaces — type (embed, popup, flyout, exit_intent, inline_banner), position, delay_seconds, ANDed conditions and a per-visitor frequency cap.
Consent block — enabled, label, channel (email or sms) and require_double_opt_in to route SMS captures through the platform double-opt-in flow.
A/B variants — id, weight, headline, description, at least one field and submit_label.
Required array length:
1 - 4 elementsPost-submit behaviour — behavior (message or redirect), message and redirect_url.
Example:
[
{
"version": 1,
"id": "form_newsletter",
"name": "Newsletter popup",
"enabled": true,
"display": {
"type": "popup",
"position": "center",
"delay_seconds": 5
},
"consent": { "enabled": true, "channel": "email" },
"variants": [
{
"id": "v_a",
"name": "Variant A",
"weight": 1,
"headline": "Stay in the loop",
"fields": [
{
"id": "email",
"label": "Email",
"type": "email",
"required": true,
"maps_to": "email"
}
]
}
]
}
]