Update a personalization slot

curl --request PATCH \
  --url https://api.orbit.devotel.io/api/v1/personalization/slots/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "<h2>Still thinking it over?</h2><p>Your 15% off expires tonight.</p>",
  "cta_text": "Claim the discount",
  "active": false
}
'

import requests

url = "https://api.orbit.devotel.io/api/v1/personalization/slots/{id}"

payload = {
    "content": "<h2>Still thinking it over?</h2><p>Your 15% off expires tonight.</p>",
    "cta_text": "Claim the discount",
    "active": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    content: '<h2>Still thinking it over?</h2><p>Your 15% off expires tonight.</p>',
    cta_text: 'Claim the discount',
    active: false
  })
};

fetch('https://api.orbit.devotel.io/api/v1/personalization/slots/{id}', 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/personalization/slots/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'content' => '<h2>Still thinking it over?</h2><p>Your 15% off expires tonight.</p>',
    'cta_text' => 'Claim the discount',
    'active' => false
  ]),
  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/personalization/slots/{id}"

	payload := strings.NewReader("{\n  \"content\": \"<h2>Still thinking it over?</h2><p>Your 15% off expires tonight.</p>\",\n  \"cta_text\": \"Claim the discount\",\n  \"active\": false\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.orbit.devotel.io/api/v1/personalization/slots/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"content\": \"<h2>Still thinking it over?</h2><p>Your 15% off expires tonight.</p>\",\n  \"cta_text\": \"Claim the discount\",\n  \"active\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/personalization/slots/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"content\": \"<h2>Still thinking it over?</h2><p>Your 15% off expires tonight.</p>\",\n  \"cta_text\": \"Claim the discount\",\n  \"active\": false\n}"

response = http.request(request)
puts response.read_body

{
  "data": {},
  "meta": {}
}

{
  "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>"
  }
}

Personalization

Update a personalization slot

Update a personalization slot variant in place — send only the fields you want to change; at least one is required. Omitted fields keep their stored values, so editing the copy never silently re-ranks a variant or brings a paused one back. Set active to false to stop serving a variant without deleting it. Updated content is re-checked against the same markup rules as create. Owner or admin only; returns 404 when no variant with that id exists in this tenant.

PATCH

api

personalization

slots

{id}

Update a personalization slot

curl --request PATCH \
  --url https://api.orbit.devotel.io/api/v1/personalization/slots/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "<h2>Still thinking it over?</h2><p>Your 15% off expires tonight.</p>",
  "cta_text": "Claim the discount",
  "active": false
}
'

import requests

url = "https://api.orbit.devotel.io/api/v1/personalization/slots/{id}"

payload = {
    "content": "<h2>Still thinking it over?</h2><p>Your 15% off expires tonight.</p>",
    "cta_text": "Claim the discount",
    "active": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    content: '<h2>Still thinking it over?</h2><p>Your 15% off expires tonight.</p>',
    cta_text: 'Claim the discount',
    active: false
  })
};

fetch('https://api.orbit.devotel.io/api/v1/personalization/slots/{id}', 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/personalization/slots/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'content' => '<h2>Still thinking it over?</h2><p>Your 15% off expires tonight.</p>',
    'cta_text' => 'Claim the discount',
    'active' => false
  ]),
  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/personalization/slots/{id}"

	payload := strings.NewReader("{\n  \"content\": \"<h2>Still thinking it over?</h2><p>Your 15% off expires tonight.</p>\",\n  \"cta_text\": \"Claim the discount\",\n  \"active\": false\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.orbit.devotel.io/api/v1/personalization/slots/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"content\": \"<h2>Still thinking it over?</h2><p>Your 15% off expires tonight.</p>\",\n  \"cta_text\": \"Claim the discount\",\n  \"active\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/personalization/slots/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"content\": \"<h2>Still thinking it over?</h2><p>Your 15% off expires tonight.</p>\",\n  \"cta_text\": \"Claim the discount\",\n  \"active\": false\n}"

response = http.request(request)
puts response.read_body

{
  "data": {},
  "meta": {}
}

{
  "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

Authorization

string

header

required

Dashboard JWT token from Clerk

Headers

X-Test-Mode

enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. 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

Path Parameters

string

required

Slot-variant id (perso_ + 32 hex characters), as returned by create or list.

Body

application/json

slot

string

Move the variant to a different slot key.

Required string length: 1 - 100

Pattern: ^[a-z0-9-_]+$

segment_label

enum<string> | null

Retarget the variant at another segment, or null for the default content.

Available options:

champion,

high_value_engaged,

engaged,

new,

passive,

at_risk,

dormant,

lost,

null

content

string

Replacement markup or text for the slot.

Required string length: 1 - 5000

cta_url

string | null

New call-to-action destination (http or https), or null to clear.

Maximum string length: 500

cta_text

string | null

New call-to-action label, or null to clear.

Maximum string length: 200

variant

string | null

New variant name, or null to clear.

Maximum string length: 50

priority

integer

New tie-breaker rank (0–100) — highest wins.

Required range: 0 <= x <= 100

active

boolean

Set false to stop serving the variant, true to resume.

metadata

object | null

Replacement free-form key/value data.

Response

The updated slot variant.

data

object

API Reference

All Endpoints

Update a personalization slot

Authorizations

Headers

Path Parameters

Body

Response