Create inbox
curl --request POST \
--url https://api.nuvia.ai/v1/inboxes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"webhook_url": "<string>",
"number": "<string>",
"default_agent": "<string>",
"test_mode": {
"enabled": true,
"test_numbers": [
"<string>"
]
},
"coexistence_enabled": "<unknown>",
"disable_inbound_ai": true,
"pdf_local_text_extraction": true,
"default_owner": "<string>",
"webchat_config": {
"allowed_domains": [
"<string>"
],
"allow_mobile_webview": true,
"paused": true,
"privacy_notice": {
"enabled": true,
"message": "<string>",
"link_url": "<string>"
},
"prechat": {
"enabled": true,
"title": "<string>",
"helper_text": "<string>",
"fields": [
{
"enabled": true,
"placeholder": "<string>",
"required": true,
"label": "<string>"
}
]
},
"proactive_enabled": true,
"triggers": [
{
"id": "<string>",
"message": "<string>",
"enabled": true,
"rules": [
{
"value": "<string>"
}
]
}
],
"attachments": {
"enabled": true,
"media": true,
"documents": true,
"audio": true
},
"cta": {
"enabled": true,
"items": [
{
"id": "<string>",
"label": "<string>",
"url": "<string>"
}
]
},
"away_after_seconds": 1815,
"appearance": {
"display_name": "<string>",
"subtitle": "<string>",
"welcome_title": "<string>",
"welcome_description": "<string>",
"welcome_message": "<string>",
"brand_color": "<string>",
"button_spacing_x": 60,
"button_spacing_y": 60,
"locale": "<string>"
}
}
}
'import requests
url = "https://api.nuvia.ai/v1/inboxes"
payload = {
"name": "<string>",
"webhook_url": "<string>",
"number": "<string>",
"default_agent": "<string>",
"test_mode": {
"enabled": True,
"test_numbers": ["<string>"]
},
"coexistence_enabled": "<unknown>",
"disable_inbound_ai": True,
"pdf_local_text_extraction": True,
"default_owner": "<string>",
"webchat_config": {
"allowed_domains": ["<string>"],
"allow_mobile_webview": True,
"paused": True,
"privacy_notice": {
"enabled": True,
"message": "<string>",
"link_url": "<string>"
},
"prechat": {
"enabled": True,
"title": "<string>",
"helper_text": "<string>",
"fields": [
{
"enabled": True,
"placeholder": "<string>",
"required": True,
"label": "<string>"
}
]
},
"proactive_enabled": True,
"triggers": [
{
"id": "<string>",
"message": "<string>",
"enabled": True,
"rules": [{ "value": "<string>" }]
}
],
"attachments": {
"enabled": True,
"media": True,
"documents": True,
"audio": True
},
"cta": {
"enabled": True,
"items": [
{
"id": "<string>",
"label": "<string>",
"url": "<string>"
}
]
},
"away_after_seconds": 1815,
"appearance": {
"display_name": "<string>",
"subtitle": "<string>",
"welcome_title": "<string>",
"welcome_description": "<string>",
"welcome_message": "<string>",
"brand_color": "<string>",
"button_spacing_x": 60,
"button_spacing_y": 60,
"locale": "<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>',
webhook_url: '<string>',
number: '<string>',
default_agent: '<string>',
test_mode: {enabled: true, test_numbers: ['<string>']},
coexistence_enabled: '<unknown>',
disable_inbound_ai: true,
pdf_local_text_extraction: true,
default_owner: '<string>',
webchat_config: {
allowed_domains: ['<string>'],
allow_mobile_webview: true,
paused: true,
privacy_notice: {enabled: true, message: '<string>', link_url: '<string>'},
prechat: {
enabled: true,
title: '<string>',
helper_text: '<string>',
fields: [{enabled: true, placeholder: '<string>', required: true, label: '<string>'}]
},
proactive_enabled: true,
triggers: [
{
id: '<string>',
message: '<string>',
enabled: true,
rules: [{value: '<string>'}]
}
],
attachments: {enabled: true, media: true, documents: true, audio: true},
cta: {enabled: true, items: [{id: '<string>', label: '<string>', url: '<string>'}]},
away_after_seconds: 1815,
appearance: {
display_name: '<string>',
subtitle: '<string>',
welcome_title: '<string>',
welcome_description: '<string>',
welcome_message: '<string>',
brand_color: '<string>',
button_spacing_x: 60,
button_spacing_y: 60,
locale: '<string>'
}
}
})
};
fetch('https://api.nuvia.ai/v1/inboxes', 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.nuvia.ai/v1/inboxes",
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>',
'webhook_url' => '<string>',
'number' => '<string>',
'default_agent' => '<string>',
'test_mode' => [
'enabled' => true,
'test_numbers' => [
'<string>'
]
],
'coexistence_enabled' => '<unknown>',
'disable_inbound_ai' => true,
'pdf_local_text_extraction' => true,
'default_owner' => '<string>',
'webchat_config' => [
'allowed_domains' => [
'<string>'
],
'allow_mobile_webview' => true,
'paused' => true,
'privacy_notice' => [
'enabled' => true,
'message' => '<string>',
'link_url' => '<string>'
],
'prechat' => [
'enabled' => true,
'title' => '<string>',
'helper_text' => '<string>',
'fields' => [
[
'enabled' => true,
'placeholder' => '<string>',
'required' => true,
'label' => '<string>'
]
]
],
'proactive_enabled' => true,
'triggers' => [
[
'id' => '<string>',
'message' => '<string>',
'enabled' => true,
'rules' => [
[
'value' => '<string>'
]
]
]
],
'attachments' => [
'enabled' => true,
'media' => true,
'documents' => true,
'audio' => true
],
'cta' => [
'enabled' => true,
'items' => [
[
'id' => '<string>',
'label' => '<string>',
'url' => '<string>'
]
]
],
'away_after_seconds' => 1815,
'appearance' => [
'display_name' => '<string>',
'subtitle' => '<string>',
'welcome_title' => '<string>',
'welcome_description' => '<string>',
'welcome_message' => '<string>',
'brand_color' => '<string>',
'button_spacing_x' => 60,
'button_spacing_y' => 60,
'locale' => '<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://api.nuvia.ai/v1/inboxes"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"number\": \"<string>\",\n \"default_agent\": \"<string>\",\n \"test_mode\": {\n \"enabled\": true,\n \"test_numbers\": [\n \"<string>\"\n ]\n },\n \"coexistence_enabled\": \"<unknown>\",\n \"disable_inbound_ai\": true,\n \"pdf_local_text_extraction\": true,\n \"default_owner\": \"<string>\",\n \"webchat_config\": {\n \"allowed_domains\": [\n \"<string>\"\n ],\n \"allow_mobile_webview\": true,\n \"paused\": true,\n \"privacy_notice\": {\n \"enabled\": true,\n \"message\": \"<string>\",\n \"link_url\": \"<string>\"\n },\n \"prechat\": {\n \"enabled\": true,\n \"title\": \"<string>\",\n \"helper_text\": \"<string>\",\n \"fields\": [\n {\n \"enabled\": true,\n \"placeholder\": \"<string>\",\n \"required\": true,\n \"label\": \"<string>\"\n }\n ]\n },\n \"proactive_enabled\": true,\n \"triggers\": [\n {\n \"id\": \"<string>\",\n \"message\": \"<string>\",\n \"enabled\": true,\n \"rules\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"attachments\": {\n \"enabled\": true,\n \"media\": true,\n \"documents\": true,\n \"audio\": true\n },\n \"cta\": {\n \"enabled\": true,\n \"items\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n },\n \"away_after_seconds\": 1815,\n \"appearance\": {\n \"display_name\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"welcome_title\": \"<string>\",\n \"welcome_description\": \"<string>\",\n \"welcome_message\": \"<string>\",\n \"brand_color\": \"<string>\",\n \"button_spacing_x\": 60,\n \"button_spacing_y\": 60,\n \"locale\": \"<string>\"\n }\n }\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.nuvia.ai/v1/inboxes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"number\": \"<string>\",\n \"default_agent\": \"<string>\",\n \"test_mode\": {\n \"enabled\": true,\n \"test_numbers\": [\n \"<string>\"\n ]\n },\n \"coexistence_enabled\": \"<unknown>\",\n \"disable_inbound_ai\": true,\n \"pdf_local_text_extraction\": true,\n \"default_owner\": \"<string>\",\n \"webchat_config\": {\n \"allowed_domains\": [\n \"<string>\"\n ],\n \"allow_mobile_webview\": true,\n \"paused\": true,\n \"privacy_notice\": {\n \"enabled\": true,\n \"message\": \"<string>\",\n \"link_url\": \"<string>\"\n },\n \"prechat\": {\n \"enabled\": true,\n \"title\": \"<string>\",\n \"helper_text\": \"<string>\",\n \"fields\": [\n {\n \"enabled\": true,\n \"placeholder\": \"<string>\",\n \"required\": true,\n \"label\": \"<string>\"\n }\n ]\n },\n \"proactive_enabled\": true,\n \"triggers\": [\n {\n \"id\": \"<string>\",\n \"message\": \"<string>\",\n \"enabled\": true,\n \"rules\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"attachments\": {\n \"enabled\": true,\n \"media\": true,\n \"documents\": true,\n \"audio\": true\n },\n \"cta\": {\n \"enabled\": true,\n \"items\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n },\n \"away_after_seconds\": 1815,\n \"appearance\": {\n \"display_name\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"welcome_title\": \"<string>\",\n \"welcome_description\": \"<string>\",\n \"welcome_message\": \"<string>\",\n \"brand_color\": \"<string>\",\n \"button_spacing_x\": 60,\n \"button_spacing_y\": 60,\n \"locale\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nuvia.ai/v1/inboxes")
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 \"webhook_url\": \"<string>\",\n \"number\": \"<string>\",\n \"default_agent\": \"<string>\",\n \"test_mode\": {\n \"enabled\": true,\n \"test_numbers\": [\n \"<string>\"\n ]\n },\n \"coexistence_enabled\": \"<unknown>\",\n \"disable_inbound_ai\": true,\n \"pdf_local_text_extraction\": true,\n \"default_owner\": \"<string>\",\n \"webchat_config\": {\n \"allowed_domains\": [\n \"<string>\"\n ],\n \"allow_mobile_webview\": true,\n \"paused\": true,\n \"privacy_notice\": {\n \"enabled\": true,\n \"message\": \"<string>\",\n \"link_url\": \"<string>\"\n },\n \"prechat\": {\n \"enabled\": true,\n \"title\": \"<string>\",\n \"helper_text\": \"<string>\",\n \"fields\": [\n {\n \"enabled\": true,\n \"placeholder\": \"<string>\",\n \"required\": true,\n \"label\": \"<string>\"\n }\n ]\n },\n \"proactive_enabled\": true,\n \"triggers\": [\n {\n \"id\": \"<string>\",\n \"message\": \"<string>\",\n \"enabled\": true,\n \"rules\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"attachments\": {\n \"enabled\": true,\n \"media\": true,\n \"documents\": true,\n \"audio\": true\n },\n \"cta\": {\n \"enabled\": true,\n \"items\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n },\n \"away_after_seconds\": 1815,\n \"appearance\": {\n \"display_name\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"welcome_title\": \"<string>\",\n \"welcome_description\": \"<string>\",\n \"welcome_message\": \"<string>\",\n \"brand_color\": \"<string>\",\n \"button_spacing_x\": 60,\n \"button_spacing_y\": 60,\n \"locale\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"number": "<string>",
"company": "<unknown>",
"channel": "<string>",
"status": "ACTIVE",
"_id": "<string>",
"webhook_url": "<string>",
"test_mode": {
"enabled": true,
"test_numbers": [
"<string>"
]
},
"default_agent": "<unknown>",
"api_wap_config": {
"phone_number_id": "<string>",
"business_id": "<string>",
"business_token": "<string>",
"waba_id": "<string>"
},
"evolution_api_config": {
"base_url": "<string>",
"api_key": "<string>",
"instance_name": "<string>"
},
"linkedin_config": {
"account_id": "<string>",
"provider": "<string>",
"display_name": "<string>",
"profile_url": "<string>",
"public_identifier": "<string>"
},
"general_config": {
"include_operator_name_on_message": true
},
"coexistence_enabled": true,
"disable_inbound_ai": true,
"pdf_local_text_extraction": true,
"default_owner": "<string>",
"createdAt": "<unknown>",
"updatedAt": "<unknown>"
}Caixas de Entrada
Create inbox
Creates a new inbox (support channel) to receive and send messages. Supports multiple channels: WhatsApp Business API, Evolution API, etc.
POST
/
v1
/
inboxes
Create inbox
curl --request POST \
--url https://api.nuvia.ai/v1/inboxes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"webhook_url": "<string>",
"number": "<string>",
"default_agent": "<string>",
"test_mode": {
"enabled": true,
"test_numbers": [
"<string>"
]
},
"coexistence_enabled": "<unknown>",
"disable_inbound_ai": true,
"pdf_local_text_extraction": true,
"default_owner": "<string>",
"webchat_config": {
"allowed_domains": [
"<string>"
],
"allow_mobile_webview": true,
"paused": true,
"privacy_notice": {
"enabled": true,
"message": "<string>",
"link_url": "<string>"
},
"prechat": {
"enabled": true,
"title": "<string>",
"helper_text": "<string>",
"fields": [
{
"enabled": true,
"placeholder": "<string>",
"required": true,
"label": "<string>"
}
]
},
"proactive_enabled": true,
"triggers": [
{
"id": "<string>",
"message": "<string>",
"enabled": true,
"rules": [
{
"value": "<string>"
}
]
}
],
"attachments": {
"enabled": true,
"media": true,
"documents": true,
"audio": true
},
"cta": {
"enabled": true,
"items": [
{
"id": "<string>",
"label": "<string>",
"url": "<string>"
}
]
},
"away_after_seconds": 1815,
"appearance": {
"display_name": "<string>",
"subtitle": "<string>",
"welcome_title": "<string>",
"welcome_description": "<string>",
"welcome_message": "<string>",
"brand_color": "<string>",
"button_spacing_x": 60,
"button_spacing_y": 60,
"locale": "<string>"
}
}
}
'import requests
url = "https://api.nuvia.ai/v1/inboxes"
payload = {
"name": "<string>",
"webhook_url": "<string>",
"number": "<string>",
"default_agent": "<string>",
"test_mode": {
"enabled": True,
"test_numbers": ["<string>"]
},
"coexistence_enabled": "<unknown>",
"disable_inbound_ai": True,
"pdf_local_text_extraction": True,
"default_owner": "<string>",
"webchat_config": {
"allowed_domains": ["<string>"],
"allow_mobile_webview": True,
"paused": True,
"privacy_notice": {
"enabled": True,
"message": "<string>",
"link_url": "<string>"
},
"prechat": {
"enabled": True,
"title": "<string>",
"helper_text": "<string>",
"fields": [
{
"enabled": True,
"placeholder": "<string>",
"required": True,
"label": "<string>"
}
]
},
"proactive_enabled": True,
"triggers": [
{
"id": "<string>",
"message": "<string>",
"enabled": True,
"rules": [{ "value": "<string>" }]
}
],
"attachments": {
"enabled": True,
"media": True,
"documents": True,
"audio": True
},
"cta": {
"enabled": True,
"items": [
{
"id": "<string>",
"label": "<string>",
"url": "<string>"
}
]
},
"away_after_seconds": 1815,
"appearance": {
"display_name": "<string>",
"subtitle": "<string>",
"welcome_title": "<string>",
"welcome_description": "<string>",
"welcome_message": "<string>",
"brand_color": "<string>",
"button_spacing_x": 60,
"button_spacing_y": 60,
"locale": "<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>',
webhook_url: '<string>',
number: '<string>',
default_agent: '<string>',
test_mode: {enabled: true, test_numbers: ['<string>']},
coexistence_enabled: '<unknown>',
disable_inbound_ai: true,
pdf_local_text_extraction: true,
default_owner: '<string>',
webchat_config: {
allowed_domains: ['<string>'],
allow_mobile_webview: true,
paused: true,
privacy_notice: {enabled: true, message: '<string>', link_url: '<string>'},
prechat: {
enabled: true,
title: '<string>',
helper_text: '<string>',
fields: [{enabled: true, placeholder: '<string>', required: true, label: '<string>'}]
},
proactive_enabled: true,
triggers: [
{
id: '<string>',
message: '<string>',
enabled: true,
rules: [{value: '<string>'}]
}
],
attachments: {enabled: true, media: true, documents: true, audio: true},
cta: {enabled: true, items: [{id: '<string>', label: '<string>', url: '<string>'}]},
away_after_seconds: 1815,
appearance: {
display_name: '<string>',
subtitle: '<string>',
welcome_title: '<string>',
welcome_description: '<string>',
welcome_message: '<string>',
brand_color: '<string>',
button_spacing_x: 60,
button_spacing_y: 60,
locale: '<string>'
}
}
})
};
fetch('https://api.nuvia.ai/v1/inboxes', 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.nuvia.ai/v1/inboxes",
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>',
'webhook_url' => '<string>',
'number' => '<string>',
'default_agent' => '<string>',
'test_mode' => [
'enabled' => true,
'test_numbers' => [
'<string>'
]
],
'coexistence_enabled' => '<unknown>',
'disable_inbound_ai' => true,
'pdf_local_text_extraction' => true,
'default_owner' => '<string>',
'webchat_config' => [
'allowed_domains' => [
'<string>'
],
'allow_mobile_webview' => true,
'paused' => true,
'privacy_notice' => [
'enabled' => true,
'message' => '<string>',
'link_url' => '<string>'
],
'prechat' => [
'enabled' => true,
'title' => '<string>',
'helper_text' => '<string>',
'fields' => [
[
'enabled' => true,
'placeholder' => '<string>',
'required' => true,
'label' => '<string>'
]
]
],
'proactive_enabled' => true,
'triggers' => [
[
'id' => '<string>',
'message' => '<string>',
'enabled' => true,
'rules' => [
[
'value' => '<string>'
]
]
]
],
'attachments' => [
'enabled' => true,
'media' => true,
'documents' => true,
'audio' => true
],
'cta' => [
'enabled' => true,
'items' => [
[
'id' => '<string>',
'label' => '<string>',
'url' => '<string>'
]
]
],
'away_after_seconds' => 1815,
'appearance' => [
'display_name' => '<string>',
'subtitle' => '<string>',
'welcome_title' => '<string>',
'welcome_description' => '<string>',
'welcome_message' => '<string>',
'brand_color' => '<string>',
'button_spacing_x' => 60,
'button_spacing_y' => 60,
'locale' => '<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://api.nuvia.ai/v1/inboxes"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"number\": \"<string>\",\n \"default_agent\": \"<string>\",\n \"test_mode\": {\n \"enabled\": true,\n \"test_numbers\": [\n \"<string>\"\n ]\n },\n \"coexistence_enabled\": \"<unknown>\",\n \"disable_inbound_ai\": true,\n \"pdf_local_text_extraction\": true,\n \"default_owner\": \"<string>\",\n \"webchat_config\": {\n \"allowed_domains\": [\n \"<string>\"\n ],\n \"allow_mobile_webview\": true,\n \"paused\": true,\n \"privacy_notice\": {\n \"enabled\": true,\n \"message\": \"<string>\",\n \"link_url\": \"<string>\"\n },\n \"prechat\": {\n \"enabled\": true,\n \"title\": \"<string>\",\n \"helper_text\": \"<string>\",\n \"fields\": [\n {\n \"enabled\": true,\n \"placeholder\": \"<string>\",\n \"required\": true,\n \"label\": \"<string>\"\n }\n ]\n },\n \"proactive_enabled\": true,\n \"triggers\": [\n {\n \"id\": \"<string>\",\n \"message\": \"<string>\",\n \"enabled\": true,\n \"rules\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"attachments\": {\n \"enabled\": true,\n \"media\": true,\n \"documents\": true,\n \"audio\": true\n },\n \"cta\": {\n \"enabled\": true,\n \"items\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n },\n \"away_after_seconds\": 1815,\n \"appearance\": {\n \"display_name\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"welcome_title\": \"<string>\",\n \"welcome_description\": \"<string>\",\n \"welcome_message\": \"<string>\",\n \"brand_color\": \"<string>\",\n \"button_spacing_x\": 60,\n \"button_spacing_y\": 60,\n \"locale\": \"<string>\"\n }\n }\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.nuvia.ai/v1/inboxes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"number\": \"<string>\",\n \"default_agent\": \"<string>\",\n \"test_mode\": {\n \"enabled\": true,\n \"test_numbers\": [\n \"<string>\"\n ]\n },\n \"coexistence_enabled\": \"<unknown>\",\n \"disable_inbound_ai\": true,\n \"pdf_local_text_extraction\": true,\n \"default_owner\": \"<string>\",\n \"webchat_config\": {\n \"allowed_domains\": [\n \"<string>\"\n ],\n \"allow_mobile_webview\": true,\n \"paused\": true,\n \"privacy_notice\": {\n \"enabled\": true,\n \"message\": \"<string>\",\n \"link_url\": \"<string>\"\n },\n \"prechat\": {\n \"enabled\": true,\n \"title\": \"<string>\",\n \"helper_text\": \"<string>\",\n \"fields\": [\n {\n \"enabled\": true,\n \"placeholder\": \"<string>\",\n \"required\": true,\n \"label\": \"<string>\"\n }\n ]\n },\n \"proactive_enabled\": true,\n \"triggers\": [\n {\n \"id\": \"<string>\",\n \"message\": \"<string>\",\n \"enabled\": true,\n \"rules\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"attachments\": {\n \"enabled\": true,\n \"media\": true,\n \"documents\": true,\n \"audio\": true\n },\n \"cta\": {\n \"enabled\": true,\n \"items\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n },\n \"away_after_seconds\": 1815,\n \"appearance\": {\n \"display_name\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"welcome_title\": \"<string>\",\n \"welcome_description\": \"<string>\",\n \"welcome_message\": \"<string>\",\n \"brand_color\": \"<string>\",\n \"button_spacing_x\": 60,\n \"button_spacing_y\": 60,\n \"locale\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nuvia.ai/v1/inboxes")
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 \"webhook_url\": \"<string>\",\n \"number\": \"<string>\",\n \"default_agent\": \"<string>\",\n \"test_mode\": {\n \"enabled\": true,\n \"test_numbers\": [\n \"<string>\"\n ]\n },\n \"coexistence_enabled\": \"<unknown>\",\n \"disable_inbound_ai\": true,\n \"pdf_local_text_extraction\": true,\n \"default_owner\": \"<string>\",\n \"webchat_config\": {\n \"allowed_domains\": [\n \"<string>\"\n ],\n \"allow_mobile_webview\": true,\n \"paused\": true,\n \"privacy_notice\": {\n \"enabled\": true,\n \"message\": \"<string>\",\n \"link_url\": \"<string>\"\n },\n \"prechat\": {\n \"enabled\": true,\n \"title\": \"<string>\",\n \"helper_text\": \"<string>\",\n \"fields\": [\n {\n \"enabled\": true,\n \"placeholder\": \"<string>\",\n \"required\": true,\n \"label\": \"<string>\"\n }\n ]\n },\n \"proactive_enabled\": true,\n \"triggers\": [\n {\n \"id\": \"<string>\",\n \"message\": \"<string>\",\n \"enabled\": true,\n \"rules\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"attachments\": {\n \"enabled\": true,\n \"media\": true,\n \"documents\": true,\n \"audio\": true\n },\n \"cta\": {\n \"enabled\": true,\n \"items\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n },\n \"away_after_seconds\": 1815,\n \"appearance\": {\n \"display_name\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"welcome_title\": \"<string>\",\n \"welcome_description\": \"<string>\",\n \"welcome_message\": \"<string>\",\n \"brand_color\": \"<string>\",\n \"button_spacing_x\": 60,\n \"button_spacing_y\": 60,\n \"locale\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"number": "<string>",
"company": "<unknown>",
"channel": "<string>",
"status": "ACTIVE",
"_id": "<string>",
"webhook_url": "<string>",
"test_mode": {
"enabled": true,
"test_numbers": [
"<string>"
]
},
"default_agent": "<unknown>",
"api_wap_config": {
"phone_number_id": "<string>",
"business_id": "<string>",
"business_token": "<string>",
"waba_id": "<string>"
},
"evolution_api_config": {
"base_url": "<string>",
"api_key": "<string>",
"instance_name": "<string>"
},
"linkedin_config": {
"account_id": "<string>",
"provider": "<string>",
"display_name": "<string>",
"profile_url": "<string>",
"public_identifier": "<string>"
},
"general_config": {
"include_operator_name_on_message": true
},
"coexistence_enabled": true,
"disable_inbound_ai": true,
"pdf_local_text_extraction": true,
"default_owner": "<string>",
"createdAt": "<unknown>",
"updatedAt": "<unknown>"
}Authorizations
JWT authentication token
Headers
Target company identifier. Required only for global API keys (type=global). Ignored for company API keys and human users.
Body
application/json
Inbox name
Minimum string length:
1Webhook URL for notifications
Minimum string length:
1Inbox phone number (international format)
Pattern:
^\+.*Default agent ID for new conversations
Communication channel (WAP_AUTO_CLOSER, etc.)
Available options:
WAP_AUTO_CLOSER, WEB_V2, EVOLUTION_API, LINKEDIN, EMAIL, WEBCHAT WhatsApp Business API settings
Show child attributes
Show child attributes
Evolution API settings
Show child attributes
Show child attributes
Test mode settings
Show child attributes
Show child attributes
General inbox settings
Show child attributes
Show child attributes
Read-only field, automatically synced from Meta.
Opt-in. When true, the AI does not handle organic inbound: new conversations start for human handling. The AI keeps handling campaign leads. Defaults to false.
Opt-in for the hybrid PDF reading mode. When true, the text is extracted locally and the AI receives the TEXT instead of the image (it stays in the loop, just reorganizing it): no size limit and no vision tokens. Falls back to the vision path when local reading doesn't work (scanned PDF, non-PDF, unreadable). Default false.
Opt-in. ID of the default owner user for any new conversation in this inbox (an explicit owner from the caller takes precedence). Null/absent = no default owner.
Editable configuration of the WEBCHAT channel — site_key/hmac_secret are generated by the server
Show child attributes
Show child attributes
Response
Inbox created successfully
Inbox name
Inbox's phone number
Company that owns the inbox
Communication channel (WAP_AUTO_CLOSER, etc.)
Inbox status (ACTIVE, DELETED)
Available options:
ACTIVE, DELETED Inbox ID
Webhook URL for notifications
Test mode settings
Show child attributes
Show child attributes
Default agent for new conversations
WhatsApp Business API settings (channel only)
Show child attributes
Show child attributes
Evolution API settings
Show child attributes
Show child attributes
LinkedIn settings (Unipile)
Show child attributes
Show child attributes
General inbox settings
Show child attributes
Show child attributes
Enables ingestion of smb_message_echoes (WhatsApp Coexistence).
Opt-in. When true, the AI does not handle organic inbound (new conversations for human handling); the AI keeps handling campaign leads.
Opt-in for the hybrid PDF reading mode. When true, the text is extracted locally and the AI receives the TEXT instead of the image (it stays in the loop, just reorganizing it): no size limit and no vision tokens. Falls back to the vision path when local reading doesn't work (scanned PDF, non-PDF, unreadable). Default false.
ID of the default owner user for new conversations in this inbox (opt-in). Null = no default owner.
Inbox creation date
Inbox update date