Add or update a sticker catalog entry
curl --request POST \
--url http://localhost:3000/api/v1/stickers/add \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"mediaPath": "<string>",
"agents": "<string>",
"avoid": "<string>",
"channels": "<string>",
"description": "<string>",
"disabled": true,
"label": "<string>",
"overwrite": true
}
'import requests
url = "http://localhost:3000/api/v1/stickers/add"
payload = {
"id": "<string>",
"mediaPath": "<string>",
"agents": "<string>",
"avoid": "<string>",
"channels": "<string>",
"description": "<string>",
"disabled": True,
"label": "<string>",
"overwrite": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
mediaPath: '<string>',
agents: '<string>',
avoid: '<string>',
channels: '<string>',
description: '<string>',
disabled: true,
label: '<string>',
overwrite: true
})
};
fetch('http://localhost:3000/api/v1/stickers/add', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/stickers/add",
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([
'id' => '<string>',
'mediaPath' => '<string>',
'agents' => '<string>',
'avoid' => '<string>',
'channels' => '<string>',
'description' => '<string>',
'disabled' => true,
'label' => '<string>',
'overwrite' => true
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:3000/api/v1/stickers/add"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"mediaPath\": \"<string>\",\n \"agents\": \"<string>\",\n \"avoid\": \"<string>\",\n \"channels\": \"<string>\",\n \"description\": \"<string>\",\n \"disabled\": true,\n \"label\": \"<string>\",\n \"overwrite\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:3000/api/v1/stickers/add")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"mediaPath\": \"<string>\",\n \"agents\": \"<string>\",\n \"avoid\": \"<string>\",\n \"channels\": \"<string>\",\n \"description\": \"<string>\",\n \"disabled\": true,\n \"label\": \"<string>\",\n \"overwrite\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/stickers/add")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"mediaPath\": \"<string>\",\n \"agents\": \"<string>\",\n \"avoid\": \"<string>\",\n \"channels\": \"<string>\",\n \"description\": \"<string>\",\n \"disabled\": true,\n \"label\": \"<string>\",\n \"overwrite\": true\n}"
response = http.request(request)
puts response.read_body{}stickers
Add or update a sticker catalog entry
POST
/
api
/
v1
/
stickers
/
add
Add or update a sticker catalog entry
curl --request POST \
--url http://localhost:3000/api/v1/stickers/add \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"mediaPath": "<string>",
"agents": "<string>",
"avoid": "<string>",
"channels": "<string>",
"description": "<string>",
"disabled": true,
"label": "<string>",
"overwrite": true
}
'import requests
url = "http://localhost:3000/api/v1/stickers/add"
payload = {
"id": "<string>",
"mediaPath": "<string>",
"agents": "<string>",
"avoid": "<string>",
"channels": "<string>",
"description": "<string>",
"disabled": True,
"label": "<string>",
"overwrite": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
mediaPath: '<string>',
agents: '<string>',
avoid: '<string>',
channels: '<string>',
description: '<string>',
disabled: true,
label: '<string>',
overwrite: true
})
};
fetch('http://localhost:3000/api/v1/stickers/add', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/stickers/add",
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([
'id' => '<string>',
'mediaPath' => '<string>',
'agents' => '<string>',
'avoid' => '<string>',
'channels' => '<string>',
'description' => '<string>',
'disabled' => true,
'label' => '<string>',
'overwrite' => true
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:3000/api/v1/stickers/add"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"mediaPath\": \"<string>\",\n \"agents\": \"<string>\",\n \"avoid\": \"<string>\",\n \"channels\": \"<string>\",\n \"description\": \"<string>\",\n \"disabled\": true,\n \"label\": \"<string>\",\n \"overwrite\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:3000/api/v1/stickers/add")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"mediaPath\": \"<string>\",\n \"agents\": \"<string>\",\n \"avoid\": \"<string>\",\n \"channels\": \"<string>\",\n \"description\": \"<string>\",\n \"disabled\": true,\n \"label\": \"<string>\",\n \"overwrite\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/stickers/add")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"mediaPath\": \"<string>\",\n \"agents\": \"<string>\",\n \"avoid\": \"<string>\",\n \"channels\": \"<string>\",\n \"description\": \"<string>\",\n \"disabled\": true,\n \"label\": \"<string>\",\n \"overwrite\": true\n}"
response = http.request(request)
puts response.read_body{}Body
application/json
Stable sticker id (lowercase, digits, dash or underscore)
Local sticker media file path
Agent allowlist (default: all agents)
When not to use this sticker
Channel allowlist (default: whatsapp)
Natural usage description for prompts
Add the sticker disabled
Human label shown to operators
Overwrite an existing sticker id
Response
Success — no @Returns schema declared; payload shape is loose.
The response is of type object.