Personalization API

A two-sided surface:

Dashboard side (/api/v1/personalization/slots, this page) — owners and admins define content slots, variants, and rules.
SDK side (/sdk/personalize) — the customer’s website JS fetches the right variant for a given visitor / contact at runtime.

This page documents the dashboard side. Base path: /api/v1/personalization Authentication: Session JWT (owner / admin role).

Method	Path	Purpose
`GET`	`/api/v1/personalization/slots`	List slots
`POST`	`/api/v1/personalization/slots`	Create a slot
`GET`	`/api/v1/personalization/slots/{id}`	Get a slot
`PATCH`	`/api/v1/personalization/slots/{id}`	Update a slot
`DELETE`	`/api/v1/personalization/slots/{id}`	Delete a slot
`GET`	`/api/v1/personalization/slots/{slot}/preview`	Preview slot output for a sample contact

Create a slot variant

POST /api/v1/personalization/slots A variant is keyed on slot + segment_label + variant, and only one active variant may exist per combination — creating a duplicate returns 409, so edit or deactivate the existing one first. Omit segment_label to define the default content every visitor sees when no segment-specific variant matches. content accepts formatting HTML; scripts, iframes, and inline event handlers are rejected with 422 because the SDK injects the markup into your site.

curl -X POST "https://api.orbit.devotel.io/api/v1/personalization/slots" \
  -H "Authorization: Bearer $SESSION_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "slot": "hero-banner",
    "segment_label": "at_risk",
    "content": "<h2>We kept your cart warm</h2><p>Finish checkout today and take 15% off.</p>",
    "cta_url": "https://shop.example.com/cart",
    "cta_text": "Resume checkout",
    "variant": "b",
    "priority": 40,
    "active": true,
    "metadata": { "experiment": "winback-q3" }
  }'

{
  "data": {
    "id": "perso_01h4wka9fq",
    "slot": "hero-banner",
    "segment_label": "at_risk",
    "content": "<h2>We kept your cart warm</h2><p>Finish checkout today and take 15% off.</p>",
    "cta_url": "https://shop.example.com/cart",
    "cta_text": "Resume checkout",
    "variant": "b",
    "priority": 40,
    "active": true,
    "metadata": { "experiment": "winback-q3" },
    "created_at": "2026-08-25T10:00:00Z",
    "updated_at": "2026-08-25T10:00:00Z"
  },
  "meta": {
    "request_id": "req_slot_001",
    "timestamp": "2026-08-25T10:00:00Z"
  }
}

Update variants and rules

PATCH /api/v1/personalization/slots/{id} Partial update — send only the fields you want to change; at least one is required. Omitted fields keep their stored values. Set active: false to stop serving a variant without deleting it; priority is the tie-breaker when several variants match the same visitor (highest wins).

curl -X PATCH "https://api.orbit.devotel.io/api/v1/personalization/slots/perso_01h4wka9fq" \
  -H "Authorization: Bearer $SESSION_JWT" \
  -H "Content-Type: application/json" \
  -d '{ "priority": 80, "active": false }'

{
  "data": {
    "id": "perso_01h4wka9fq",
    "slot": "hero-banner",
    "segment_label": "at_risk",
    "priority": 80,
    "active": false,
    "updated_at": "2026-08-25T10:04:00Z"
  },
  "meta": {
    "request_id": "req_slot_002",
    "timestamp": "2026-08-25T10:04:00Z"
  }
}

Runtime fetching is via the SDK endpoint

The slot definitions above are what the SDK serves. At runtime the embedded website JS calls /sdk/personalize (unauthenticated, project-keyed) with the visitor’s slot keys and segment context, and Orbit returns the winning variant per slot — your page then injects the returned markup. The dashboard-side endpoints on this page never carry that traffic; the SDK path is cached and rate-limited for page-view volume. Preview any slot for a sample contact before shipping it with GET /api/v1/personalization/slots/{slot}/preview.

Using the SDKs

import { Orbit } from "@devotel-orbit/node";

const orbit = new Orbit({ apiKey: process.env.ORBIT_API_KEY! });

const res = await orbit.personalization.listSlots();

Python (same call via the SDK’s escape hatch):

from orbit_sdk import OrbitClient

client = OrbitClient.from_env()  # reads ORBIT_API_KEY

res = client.request("GET", "/personalization")

The Python SDK is core-scope — it wraps the 8 core resources (messaging, voice, contacts, campaigns, verify, numbers) and reaches everything else through the generic client.request() escape hatch above. See the Python SDK. Returns the typed ApiResponse envelope. See the SDK index at SDK quickstart.

API Reference

All Endpoints

Personalization API: web SDK content slot definitions

Personalization API

Create a slot variant

Update variants and rules

Runtime fetching is via the SDK endpoint

Using the SDKs

See also

​Personalization API

​Create a slot variant

​Update variants and rules

​Runtime fetching is via the SDK endpoint

​Using the SDKs

​See also

Personalization API

Create a slot variant

Update variants and rules

Runtime fetching is via the SDK endpoint

Using the SDKs

See also