Save a custom prompt onto a sender profile
curl --request POST \
--url https://api.example.com/api/v1/personalize/save-prompt \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sender_profile_id": "<string>",
"prompt": "<string>",
"save_as_name": "saved"
}
'import requests
url = "https://api.example.com/api/v1/personalize/save-prompt"
payload = {
"sender_profile_id": "<string>",
"prompt": "<string>",
"save_as_name": "saved"
}
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({sender_profile_id: '<string>', prompt: '<string>', save_as_name: 'saved'})
};
fetch('https://api.example.com/api/v1/personalize/save-prompt', 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/api/v1/personalize/save-prompt",
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([
'sender_profile_id' => '<string>',
'prompt' => '<string>',
'save_as_name' => 'saved'
]),
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.example.com/api/v1/personalize/save-prompt"
payload := strings.NewReader("{\n \"sender_profile_id\": \"<string>\",\n \"prompt\": \"<string>\",\n \"save_as_name\": \"saved\"\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://api.example.com/api/v1/personalize/save-prompt")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sender_profile_id\": \"<string>\",\n \"prompt\": \"<string>\",\n \"save_as_name\": \"saved\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/personalize/save-prompt")
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 \"sender_profile_id\": \"<string>\",\n \"prompt\": \"<string>\",\n \"save_as_name\": \"saved\"\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Personalization
Save a custom prompt onto a sender profile
Upserts the given prompt into sender_data.prompts[] (named slot, default ‘saved’) AND mirrors it to sender_data.custom_prompt atomically. Used from the preview playground when a user wants future campaigns to use their iterated prompt.
POST
/
api
/
v1
/
personalize
/
save-prompt
Save a custom prompt onto a sender profile
curl --request POST \
--url https://api.example.com/api/v1/personalize/save-prompt \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sender_profile_id": "<string>",
"prompt": "<string>",
"save_as_name": "saved"
}
'import requests
url = "https://api.example.com/api/v1/personalize/save-prompt"
payload = {
"sender_profile_id": "<string>",
"prompt": "<string>",
"save_as_name": "saved"
}
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({sender_profile_id: '<string>', prompt: '<string>', save_as_name: 'saved'})
};
fetch('https://api.example.com/api/v1/personalize/save-prompt', 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/api/v1/personalize/save-prompt",
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([
'sender_profile_id' => '<string>',
'prompt' => '<string>',
'save_as_name' => 'saved'
]),
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.example.com/api/v1/personalize/save-prompt"
payload := strings.NewReader("{\n \"sender_profile_id\": \"<string>\",\n \"prompt\": \"<string>\",\n \"save_as_name\": \"saved\"\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://api.example.com/api/v1/personalize/save-prompt")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sender_profile_id\": \"<string>\",\n \"prompt\": \"<string>\",\n \"save_as_name\": \"saved\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/personalize/save-prompt")
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 \"sender_profile_id\": \"<string>\",\n \"prompt\": \"<string>\",\n \"save_as_name\": \"saved\"\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Required string length:
100 - 5000Named prompt slot to upsert into. Defaults to 'saved' so repeated playground saves update the same slot rather than accumulating entries. Collision with a reserved name returns 422.
Response
Successful Response
The response is of type Response Save Personalization Prompt Api V1 Personalize Save Prompt Post · object.
⌘I