Create inbox
curl --request POST \
--url https://api.withallo.com/v2/api/inboxes \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Sales",
"emoji": "💼",
"sources": [
{
"allo_number": "+33612345678",
"conditions": [
{
"type": "MENU_BRANCH",
"branches": [
[
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
]
],
"include_no_choice": false
}
]
}
],
"filters": {
"types": [
"INBOUND_CALL"
],
"user_ids": [],
"contact_ids": [],
"contact_list_ids": []
},
"notifications_muted": false
}
'import requests
url = "https://api.withallo.com/v2/api/inboxes"
payload = {
"name": "Sales",
"emoji": "💼",
"sources": [
{
"allo_number": "+33612345678",
"conditions": [
{
"type": "MENU_BRANCH",
"branches": [[
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
]],
"include_no_choice": False
}
]
}
],
"filters": {
"types": ["INBOUND_CALL"],
"user_ids": [],
"contact_ids": [],
"contact_list_ids": []
},
"notifications_muted": False
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Sales',
emoji: '💼',
sources: [
{
allo_number: '+33612345678',
conditions: [
{
type: 'MENU_BRANCH',
branches: [[{node_id: 'node-1', digit: '1'}, {node_id: 'node-3', digit: '2'}]],
include_no_choice: false
}
]
}
],
filters: {types: ['INBOUND_CALL'], user_ids: [], contact_ids: [], contact_list_ids: []},
notifications_muted: false
})
};
fetch('https://api.withallo.com/v2/api/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.withallo.com/v2/api/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' => 'Sales',
'emoji' => '💼',
'sources' => [
[
'allo_number' => '+33612345678',
'conditions' => [
[
'type' => 'MENU_BRANCH',
'branches' => [
[
[
'node_id' => 'node-1',
'digit' => '1'
],
[
'node_id' => 'node-3',
'digit' => '2'
]
]
],
'include_no_choice' => false
]
]
]
],
'filters' => [
'types' => [
'INBOUND_CALL'
],
'user_ids' => [
],
'contact_ids' => [
],
'contact_list_ids' => [
]
],
'notifications_muted' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.withallo.com/v2/api/inboxes"
payload := strings.NewReader("{\n \"name\": \"Sales\",\n \"emoji\": \"💼\",\n \"sources\": [\n {\n \"allo_number\": \"+33612345678\",\n \"conditions\": [\n {\n \"type\": \"MENU_BRANCH\",\n \"branches\": [\n [\n {\n \"node_id\": \"node-1\",\n \"digit\": \"1\"\n },\n {\n \"node_id\": \"node-3\",\n \"digit\": \"2\"\n }\n ]\n ],\n \"include_no_choice\": false\n }\n ]\n }\n ],\n \"filters\": {\n \"types\": [\n \"INBOUND_CALL\"\n ],\n \"user_ids\": [],\n \"contact_ids\": [],\n \"contact_list_ids\": []\n },\n \"notifications_muted\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.withallo.com/v2/api/inboxes")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Sales\",\n \"emoji\": \"💼\",\n \"sources\": [\n {\n \"allo_number\": \"+33612345678\",\n \"conditions\": [\n {\n \"type\": \"MENU_BRANCH\",\n \"branches\": [\n [\n {\n \"node_id\": \"node-1\",\n \"digit\": \"1\"\n },\n {\n \"node_id\": \"node-3\",\n \"digit\": \"2\"\n }\n ]\n ],\n \"include_no_choice\": false\n }\n ]\n }\n ],\n \"filters\": {\n \"types\": [\n \"INBOUND_CALL\"\n ],\n \"user_ids\": [],\n \"contact_ids\": [],\n \"contact_list_ids\": []\n },\n \"notifications_muted\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/inboxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Sales\",\n \"emoji\": \"💼\",\n \"sources\": [\n {\n \"allo_number\": \"+33612345678\",\n \"conditions\": [\n {\n \"type\": \"MENU_BRANCH\",\n \"branches\": [\n [\n {\n \"node_id\": \"node-1\",\n \"digit\": \"1\"\n },\n {\n \"node_id\": \"node-3\",\n \"digit\": \"2\"\n }\n ]\n ],\n \"include_no_choice\": false\n }\n ]\n }\n ],\n \"filters\": {\n \"types\": [\n \"INBOUND_CALL\"\n ],\n \"user_ids\": [],\n \"contact_ids\": [],\n \"contact_list_ids\": []\n },\n \"notifications_muted\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "inb-abc123",
"name": "Sales",
"emoji": "💼",
"sources": [
{
"allo_number": "+33612345678",
"conditions": [
{
"type": "MENU_BRANCH",
"branches": [
[
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
]
],
"include_no_choice": false
}
]
}
],
"filters": {
"types": [
"INBOUND_CALL"
],
"user_ids": [],
"contact_ids": [],
"contact_list_ids": []
},
"notifications_muted": false
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Inboxes
Create inbox
Creates an inbox for the caller, or for a teammate with user_id in the body. Every source line must be accessible to the inbox owner. Up to 50 inboxes per user. Size limits (name over 80 characters, emoji over 16, more than 100 sources or 10 conditions per source) return 400 INVALID_REQUEST_BODY with field_errors. A menu path not listed by the line’s menu_options, or a null source, condition or digit, returns 400 INVALID_INBOX_SOURCE. Menu conditions are only accepted on a line whose menu_options list is not empty, with paths from that list; on other lines use a whole-line source (empty conditions). For a teammate, the inbox must hold at least one line of the caller’s workspace.
POST
/
v2
/
api
/
inboxes
Create inbox
curl --request POST \
--url https://api.withallo.com/v2/api/inboxes \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Sales",
"emoji": "💼",
"sources": [
{
"allo_number": "+33612345678",
"conditions": [
{
"type": "MENU_BRANCH",
"branches": [
[
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
]
],
"include_no_choice": false
}
]
}
],
"filters": {
"types": [
"INBOUND_CALL"
],
"user_ids": [],
"contact_ids": [],
"contact_list_ids": []
},
"notifications_muted": false
}
'import requests
url = "https://api.withallo.com/v2/api/inboxes"
payload = {
"name": "Sales",
"emoji": "💼",
"sources": [
{
"allo_number": "+33612345678",
"conditions": [
{
"type": "MENU_BRANCH",
"branches": [[
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
]],
"include_no_choice": False
}
]
}
],
"filters": {
"types": ["INBOUND_CALL"],
"user_ids": [],
"contact_ids": [],
"contact_list_ids": []
},
"notifications_muted": False
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Sales',
emoji: '💼',
sources: [
{
allo_number: '+33612345678',
conditions: [
{
type: 'MENU_BRANCH',
branches: [[{node_id: 'node-1', digit: '1'}, {node_id: 'node-3', digit: '2'}]],
include_no_choice: false
}
]
}
],
filters: {types: ['INBOUND_CALL'], user_ids: [], contact_ids: [], contact_list_ids: []},
notifications_muted: false
})
};
fetch('https://api.withallo.com/v2/api/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.withallo.com/v2/api/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' => 'Sales',
'emoji' => '💼',
'sources' => [
[
'allo_number' => '+33612345678',
'conditions' => [
[
'type' => 'MENU_BRANCH',
'branches' => [
[
[
'node_id' => 'node-1',
'digit' => '1'
],
[
'node_id' => 'node-3',
'digit' => '2'
]
]
],
'include_no_choice' => false
]
]
]
],
'filters' => [
'types' => [
'INBOUND_CALL'
],
'user_ids' => [
],
'contact_ids' => [
],
'contact_list_ids' => [
]
],
'notifications_muted' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.withallo.com/v2/api/inboxes"
payload := strings.NewReader("{\n \"name\": \"Sales\",\n \"emoji\": \"💼\",\n \"sources\": [\n {\n \"allo_number\": \"+33612345678\",\n \"conditions\": [\n {\n \"type\": \"MENU_BRANCH\",\n \"branches\": [\n [\n {\n \"node_id\": \"node-1\",\n \"digit\": \"1\"\n },\n {\n \"node_id\": \"node-3\",\n \"digit\": \"2\"\n }\n ]\n ],\n \"include_no_choice\": false\n }\n ]\n }\n ],\n \"filters\": {\n \"types\": [\n \"INBOUND_CALL\"\n ],\n \"user_ids\": [],\n \"contact_ids\": [],\n \"contact_list_ids\": []\n },\n \"notifications_muted\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.withallo.com/v2/api/inboxes")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Sales\",\n \"emoji\": \"💼\",\n \"sources\": [\n {\n \"allo_number\": \"+33612345678\",\n \"conditions\": [\n {\n \"type\": \"MENU_BRANCH\",\n \"branches\": [\n [\n {\n \"node_id\": \"node-1\",\n \"digit\": \"1\"\n },\n {\n \"node_id\": \"node-3\",\n \"digit\": \"2\"\n }\n ]\n ],\n \"include_no_choice\": false\n }\n ]\n }\n ],\n \"filters\": {\n \"types\": [\n \"INBOUND_CALL\"\n ],\n \"user_ids\": [],\n \"contact_ids\": [],\n \"contact_list_ids\": []\n },\n \"notifications_muted\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/inboxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Sales\",\n \"emoji\": \"💼\",\n \"sources\": [\n {\n \"allo_number\": \"+33612345678\",\n \"conditions\": [\n {\n \"type\": \"MENU_BRANCH\",\n \"branches\": [\n [\n {\n \"node_id\": \"node-1\",\n \"digit\": \"1\"\n },\n {\n \"node_id\": \"node-3\",\n \"digit\": \"2\"\n }\n ]\n ],\n \"include_no_choice\": false\n }\n ]\n }\n ],\n \"filters\": {\n \"types\": [\n \"INBOUND_CALL\"\n ],\n \"user_ids\": [],\n \"contact_ids\": [],\n \"contact_list_ids\": []\n },\n \"notifications_muted\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "inb-abc123",
"name": "Sales",
"emoji": "💼",
"sources": [
{
"allo_number": "+33612345678",
"conditions": [
{
"type": "MENU_BRANCH",
"branches": [
[
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
]
],
"include_no_choice": false
}
]
}
],
"filters": {
"types": [
"INBOUND_CALL"
],
"user_ids": [],
"contact_ids": [],
"contact_list_ids": []
},
"notifications_muted": false
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Required scope:
INBOXES_WRITEBehavior
Creates an inbox owned by the caller and returns it with201. Send user_id in the JSON body to create it for a teammate instead: the inbox is owned by the teammate and shows in the teammate’s inbox switcher. Only admins and managers of the teammate’s workspace can do that.
Every source line must be accessible to the inbox owner, with the same line access rules as the app. A source with an empty conditions list covers the whole line. Build sources from the source of inbox suggestions, or from the condition of menu options.
Menu conditions are only accepted on a line whose menu options list is not empty. On any other line, use a whole-line source.
Each line appears once in sources. To cover several menu options of one line, put all their paths in the branches of a single MENU_BRANCH condition.
Errors
| Status | Code | When |
|---|---|---|
400 | INBOX_NAME_REQUIRED | name is missing or blank |
400 | INVALID_INBOX_SOURCE | A source, condition or digit is null or invalid, a menu path is not in that line’s menu options, two sources share an allo_number, or a teammate inbox would have no line in the caller’s workspace |
400 | INVALID_REQUEST_BODY | name over 80 characters, emoji over 16, more than 100 sources, or more than 10 conditions in a source. field_errors names each field |
400 | INVALID_INBOX_FILTERS | filters has an unknown key or an invalid value |
400 | INBOX_LIMIT_REACHED | The inbox owner already has 50 inboxes |
403 | FORBIDDEN | user_id is set and the caller is not an admin or manager of that teammate’s workspace |
403 | ALLO_NUMBER_FORBIDDEN | A source line is not accessible to the inbox owner, or, with user_id, is not in a workspace the caller manages |
Authorizations
Body
application/json
Required and non-blank.
Maximum string length:
80Example:
"Sales"
Maximum array length:
100Show child attributes
Show child attributes
Maximum string length:
16Example:
"💼"
Saved filters, with the same meaning as the conversation list filters in the app. "Unread only" is not saved on an inbox: use the unread query parameter of List conversations.
Show child attributes
Show child attributes
Example:
false
Create the inbox for this teammate (usr-*). The caller must be an admin or manager of that teammate's workspace.
Example:
"usr-abc123"
Response
Inbox created
Show child attributes
Show child attributes
Was this page helpful?