cURL

curl --request POST \
  --url https://api.example.com/v1/panel/notices/{code}/preview \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <x-csrf-token>' \
  --data '
{
  "body": "<string>"
}
'

import requests

url = "https://api.example.com/v1/panel/notices/{code}/preview"

payload = { "body": "<string>" }
headers = {
    "X-CSRF-Token": "<x-csrf-token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-CSRF-Token': '<x-csrf-token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({body: JSON.stringify('<string>')})
};

fetch('https://api.example.com/v1/panel/notices/{code}/preview', 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.example.com/v1/panel/notices/{code}/preview",
  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([
    'body' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-CSRF-Token: <x-csrf-token>"
  ],
]);

$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.example.com/v1/panel/notices/{code}/preview"

	payload := strings.NewReader("{\n  \"body\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-CSRF-Token", "<x-csrf-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.example.com/v1/panel/notices/{code}/preview")
  .header("X-CSRF-Token", "<x-csrf-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"body\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/panel/notices/{code}/preview")

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

request = Net::HTTP::Post.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"body\": \"<string>\"\n}"

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

{
  "rendered": "<string>",
  "placeholders": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

panel

Post v1panelnotices preview

Requires settings.write — a preview stores nothing, but it runs the renderer over caller-supplied text, and a read permission should not be a way to do that. Renders a body against the notice’s sample values, so an operator judges a message rather than a template. An empty body previews the shipped wording, which is what a customer would receive if nothing were saved. It refuses exactly what a save refuses, so a preview can never show something that could not then be stored.

POST

panel

notices

{code}

preview

cURL

curl --request POST \
  --url https://api.example.com/v1/panel/notices/{code}/preview \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <x-csrf-token>' \
  --data '
{
  "body": "<string>"
}
'

import requests

url = "https://api.example.com/v1/panel/notices/{code}/preview"

payload = { "body": "<string>" }
headers = {
    "X-CSRF-Token": "<x-csrf-token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-CSRF-Token': '<x-csrf-token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({body: JSON.stringify('<string>')})
};

fetch('https://api.example.com/v1/panel/notices/{code}/preview', 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.example.com/v1/panel/notices/{code}/preview",
  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([
    'body' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-CSRF-Token: <x-csrf-token>"
  ],
]);

$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.example.com/v1/panel/notices/{code}/preview"

	payload := strings.NewReader("{\n  \"body\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-CSRF-Token", "<x-csrf-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.example.com/v1/panel/notices/{code}/preview")
  .header("X-CSRF-Token", "<x-csrf-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"body\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/panel/notices/{code}/preview")

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

request = Net::HTTP::Post.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"body\": \"<string>\"\n}"

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

{
  "rendered": "<string>",
  "placeholders": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

Headers

X-CSRF-Token

string

required

Echoes the token from the current session. Required on every unsafe method.

Path Parameters

code

string

required

Body

application/json

locale

enum<string>

required

Available options:

en,

ru

body

string

Empty previews the shipped wording.

Maximum string length: 2000

Response

Preview

rendered

string

required

placeholders

string[]

What the body actually used, which is how an operator notices they deleted {days} from the expiry warning.

Start

Architecture

For customers

Commerce

Integrations

API reference

Operator panel

AI and MCP

Running Omniflow

Contributing

Post v1panelnotices preview

Headers

Path Parameters

Body

Response