In-app
Update Placement
Rename a placement or change its size hints
PATCH
/
api
/
v1
/
in-app
/
placements
/
{key}
Update Placement
curl --request PATCH \
--url https://api.sequenzy.com/api/v1/in-app/placements/{key} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"width": {},
"height": {}
}
'import requests
url = "https://api.sequenzy.com/api/v1/in-app/placements/{key}"
payload = {
"name": "<string>",
"description": "<string>",
"width": {},
"height": {}
}
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({name: '<string>', description: '<string>', width: {}, height: {}})
};
fetch('https://api.sequenzy.com/api/v1/in-app/placements/{key}', 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.sequenzy.com/api/v1/in-app/placements/{key}",
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([
'name' => '<string>',
'description' => '<string>',
'width' => [
],
'height' => [
]
]),
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.sequenzy.com/api/v1/in-app/placements/{key}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"width\": {},\n \"height\": {}\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.sequenzy.com/api/v1/in-app/placements/{key}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"width\": {},\n \"height\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/in-app/placements/{key}")
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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"width\": {},\n \"height\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"placement": {
"key": "home_hero",
"name": "Home banner",
"description": "",
"width": 360,
"height": null,
"createdAt": "2026-11-07T10:00:00.000Z",
"updatedAt": "2026-11-07T11:00:00.000Z"
}
}
{
"error": "Provide at least one of name, description, width or height"
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: sequences:write"
}
{
"error": "Placement \"home_hero\" not found."
}
Changes a placement’s name, description or size hints. Send at least one field; fields you leave out keep their value, and
null clears a size hint. The key cannot change, because your app’s code uses it. What contacts see is unaffected. Requires the sequences:write scope.
Request
string
required
The placement key.
string
New name, up to 100 characters.
string
New description, up to 500 characters.
integer | null
Width hint in points, 1 to 4000, or
null to clear it.integer | null
Height hint in points, 1 to 4000, or
null to clear it.curl -X PATCH "https://api.sequenzy.com/api/v1/in-app/placements/home_hero" \
--header "Authorization: Bearer $SEQUENZY_API_KEY" \
--header "Content-Type: application/json" \
--data '{ "name": "Home banner", "height": null }'
{
"success": true,
"placement": {
"key": "home_hero",
"name": "Home banner",
"description": "",
"width": 360,
"height": null,
"createdAt": "2026-11-07T10:00:00.000Z",
"updatedAt": "2026-11-07T11:00:00.000Z"
}
}
{
"error": "Provide at least one of name, description, width or height"
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: sequences:write"
}
{
"error": "Placement \"home_hero\" not found."
}
⌘I
Update Placement
curl --request PATCH \
--url https://api.sequenzy.com/api/v1/in-app/placements/{key} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"width": {},
"height": {}
}
'import requests
url = "https://api.sequenzy.com/api/v1/in-app/placements/{key}"
payload = {
"name": "<string>",
"description": "<string>",
"width": {},
"height": {}
}
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({name: '<string>', description: '<string>', width: {}, height: {}})
};
fetch('https://api.sequenzy.com/api/v1/in-app/placements/{key}', 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.sequenzy.com/api/v1/in-app/placements/{key}",
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([
'name' => '<string>',
'description' => '<string>',
'width' => [
],
'height' => [
]
]),
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.sequenzy.com/api/v1/in-app/placements/{key}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"width\": {},\n \"height\": {}\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.sequenzy.com/api/v1/in-app/placements/{key}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"width\": {},\n \"height\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/in-app/placements/{key}")
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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"width\": {},\n \"height\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"placement": {
"key": "home_hero",
"name": "Home banner",
"description": "",
"width": 360,
"height": null,
"createdAt": "2026-11-07T10:00:00.000Z",
"updatedAt": "2026-11-07T11:00:00.000Z"
}
}
{
"error": "Provide at least one of name, description, width or height"
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: sequences:write"
}
{
"error": "Placement \"home_hero\" not found."
}