Dynamic Images
Create dynamic image
Adds a dynamically-rendered image template that fills in per-contact data via a {{user_id}} URL. Use dynamicImages.list first to avoid duplicating an existing one.
POST
/
v1
/
dynamic-images
Create dynamic image
curl --request POST \
--url https://app.chatbotx.io/api/v1/dynamic-images \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"data": {
"width": 0,
"height": 0,
"elements": [
{
"id": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"type": "image",
"priority": false,
"url": "<string>",
"customFieldId": "<string>",
"imageStyle": "square"
}
]
},
"customFieldId": "<string>"
}
'import requests
url = "https://app.chatbotx.io/api/v1/dynamic-images"
payload = {
"name": "<string>",
"data": {
"width": 0,
"height": 0,
"elements": [
{
"id": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"type": "image",
"priority": False,
"url": "<string>",
"customFieldId": "<string>",
"imageStyle": "square"
}
]
},
"customFieldId": "<string>"
}
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({
name: '<string>',
data: {
width: 0,
height: 0,
elements: [
{
id: '<string>',
x: 123,
y: 123,
width: 123,
height: 123,
type: 'image',
priority: false,
url: '<string>',
customFieldId: '<string>',
imageStyle: 'square'
}
]
},
customFieldId: '<string>'
})
};
fetch('https://app.chatbotx.io/api/v1/dynamic-images', 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://app.chatbotx.io/api/v1/dynamic-images",
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([
'name' => '<string>',
'data' => [
'width' => 0,
'height' => 0,
'elements' => [
[
'id' => '<string>',
'x' => 123,
'y' => 123,
'width' => 123,
'height' => 123,
'type' => 'image',
'priority' => false,
'url' => '<string>',
'customFieldId' => '<string>',
'imageStyle' => 'square'
]
]
],
'customFieldId' => '<string>'
]),
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://app.chatbotx.io/api/v1/dynamic-images"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"data\": {\n \"width\": 0,\n \"height\": 0,\n \"elements\": [\n {\n \"id\": \"<string>\",\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"type\": \"image\",\n \"priority\": false,\n \"url\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"imageStyle\": \"square\"\n }\n ]\n },\n \"customFieldId\": \"<string>\"\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://app.chatbotx.io/api/v1/dynamic-images")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"data\": {\n \"width\": 0,\n \"height\": 0,\n \"elements\": [\n {\n \"id\": \"<string>\",\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"type\": \"image\",\n \"priority\": false,\n \"url\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"imageStyle\": \"square\"\n }\n ]\n },\n \"customFieldId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chatbotx.io/api/v1/dynamic-images")
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 \"name\": \"<string>\",\n \"data\": {\n \"width\": 0,\n \"height\": 0,\n \"elements\": [\n {\n \"id\": \"<string>\",\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"type\": \"image\",\n \"priority\": false,\n \"url\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"imageStyle\": \"square\"\n }\n ]\n },\n \"customFieldId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"customFieldId": "<string>",
"data": {
"width": 0,
"height": 0,
"elements": [
{
"id": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"type": "image",
"imageType": "url",
"priority": false,
"url": "<string>",
"customFieldId": "<string>",
"imageStyle": "square"
}
]
},
"enabled": true,
"backgroundUrl": "<string>",
"imageUrl": "<string>"
}{
"defined": true,
"code": "businessError",
"status": 400,
"message": "An error occurred while processing your request",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": "<unknown>"
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "You do not have permission to perform this action",
"data": "<unknown>"
}{
"defined": true,
"code": "invalidRequestData",
"status": 422,
"message": "Input validation failed",
"data": {
"issues": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}
}{
"defined": true,
"code": "tooManyRequests",
"status": 429,
"message": "Too many requests",
"data": "<unknown>"
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An unexpected error occurred",
"data": "<unknown>"
}Authorizations
bearerAuthdeveloperAccessTokentokenInSearchParams
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
OK
Show child attributes
Show child attributes
Public URL of the rendered static background.
Trigger URL to embed. Replace {{user_id}} with the contact's channel-side id to get a personalized render; without it the static background is served.
Was this page helpful?
⌘I
Create dynamic image
curl --request POST \
--url https://app.chatbotx.io/api/v1/dynamic-images \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"data": {
"width": 0,
"height": 0,
"elements": [
{
"id": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"type": "image",
"priority": false,
"url": "<string>",
"customFieldId": "<string>",
"imageStyle": "square"
}
]
},
"customFieldId": "<string>"
}
'import requests
url = "https://app.chatbotx.io/api/v1/dynamic-images"
payload = {
"name": "<string>",
"data": {
"width": 0,
"height": 0,
"elements": [
{
"id": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"type": "image",
"priority": False,
"url": "<string>",
"customFieldId": "<string>",
"imageStyle": "square"
}
]
},
"customFieldId": "<string>"
}
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({
name: '<string>',
data: {
width: 0,
height: 0,
elements: [
{
id: '<string>',
x: 123,
y: 123,
width: 123,
height: 123,
type: 'image',
priority: false,
url: '<string>',
customFieldId: '<string>',
imageStyle: 'square'
}
]
},
customFieldId: '<string>'
})
};
fetch('https://app.chatbotx.io/api/v1/dynamic-images', 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://app.chatbotx.io/api/v1/dynamic-images",
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([
'name' => '<string>',
'data' => [
'width' => 0,
'height' => 0,
'elements' => [
[
'id' => '<string>',
'x' => 123,
'y' => 123,
'width' => 123,
'height' => 123,
'type' => 'image',
'priority' => false,
'url' => '<string>',
'customFieldId' => '<string>',
'imageStyle' => 'square'
]
]
],
'customFieldId' => '<string>'
]),
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://app.chatbotx.io/api/v1/dynamic-images"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"data\": {\n \"width\": 0,\n \"height\": 0,\n \"elements\": [\n {\n \"id\": \"<string>\",\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"type\": \"image\",\n \"priority\": false,\n \"url\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"imageStyle\": \"square\"\n }\n ]\n },\n \"customFieldId\": \"<string>\"\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://app.chatbotx.io/api/v1/dynamic-images")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"data\": {\n \"width\": 0,\n \"height\": 0,\n \"elements\": [\n {\n \"id\": \"<string>\",\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"type\": \"image\",\n \"priority\": false,\n \"url\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"imageStyle\": \"square\"\n }\n ]\n },\n \"customFieldId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chatbotx.io/api/v1/dynamic-images")
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 \"name\": \"<string>\",\n \"data\": {\n \"width\": 0,\n \"height\": 0,\n \"elements\": [\n {\n \"id\": \"<string>\",\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"type\": \"image\",\n \"priority\": false,\n \"url\": \"<string>\",\n \"customFieldId\": \"<string>\",\n \"imageStyle\": \"square\"\n }\n ]\n },\n \"customFieldId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"customFieldId": "<string>",
"data": {
"width": 0,
"height": 0,
"elements": [
{
"id": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"type": "image",
"imageType": "url",
"priority": false,
"url": "<string>",
"customFieldId": "<string>",
"imageStyle": "square"
}
]
},
"enabled": true,
"backgroundUrl": "<string>",
"imageUrl": "<string>"
}{
"defined": true,
"code": "businessError",
"status": 400,
"message": "An error occurred while processing your request",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": "<unknown>"
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "You do not have permission to perform this action",
"data": "<unknown>"
}{
"defined": true,
"code": "invalidRequestData",
"status": 422,
"message": "Input validation failed",
"data": {
"issues": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}
}{
"defined": true,
"code": "tooManyRequests",
"status": 429,
"message": "Too many requests",
"data": "<unknown>"
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An unexpected error occurred",
"data": "<unknown>"
}