Declare sender ID
curl --request POST \
--url https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"sender_id": "PLOMBMARTIN",
"example_content": "Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin"
}
'import requests
url = "https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids"
payload = {
"sender_id": "PLOMBMARTIN",
"example_content": "Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin"
}
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({
sender_id: 'PLOMBMARTIN',
example_content: 'Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin'
})
};
fetch('https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids', 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/partner/accounts/{account_id}/sender_ids",
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([
'sender_id' => 'PLOMBMARTIN',
'example_content' => 'Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin'
]),
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/partner/accounts/{account_id}/sender_ids"
payload := strings.NewReader("{\n \"sender_id\": \"PLOMBMARTIN\",\n \"example_content\": \"Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin\"\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/partner/accounts/{account_id}/sender_ids")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sender_id\": \"PLOMBMARTIN\",\n \"example_content\": \"Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids")
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 \"sender_id\": \"PLOMBMARTIN\",\n \"example_content\": \"Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "vsi-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61",
"account_id": "usr-575966AF3661061265263C58882BC409D2A427B8",
"partner_client_ref": "crm-12345",
"sender_id": "PLOMBMARTIN",
"status": "PENDING",
"example_content": "Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin",
"created_at": "2026-11-16T10:05:00"
}
}{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {}
}{
"error": {}
}{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Sender IDs
Declare sender ID
Declares an alphanumeric sender ID on one of your accounts, so the account can send SMS under that name. The sender ID is created with status PENDING and Allo reviews it by hand, usually in 1 to 5 business days. Allo then sends the partner.sender_id.validated or partner.sender_id.failed webhook. A sender ID belongs to one Allo account only, and an account holds at most 3. Sending the same sender_id again for the same account returns the existing one. Requires the PARTNER scope.
POST
/
v2
/
api
/
partner
/
accounts
/
{account_id}
/
sender_ids
Declare sender ID
curl --request POST \
--url https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"sender_id": "PLOMBMARTIN",
"example_content": "Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin"
}
'import requests
url = "https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids"
payload = {
"sender_id": "PLOMBMARTIN",
"example_content": "Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin"
}
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({
sender_id: 'PLOMBMARTIN',
example_content: 'Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin'
})
};
fetch('https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids', 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/partner/accounts/{account_id}/sender_ids",
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([
'sender_id' => 'PLOMBMARTIN',
'example_content' => 'Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin'
]),
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/partner/accounts/{account_id}/sender_ids"
payload := strings.NewReader("{\n \"sender_id\": \"PLOMBMARTIN\",\n \"example_content\": \"Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin\"\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/partner/accounts/{account_id}/sender_ids")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sender_id\": \"PLOMBMARTIN\",\n \"example_content\": \"Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids")
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 \"sender_id\": \"PLOMBMARTIN\",\n \"example_content\": \"Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "vsi-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61",
"account_id": "usr-575966AF3661061265263C58882BC409D2A427B8",
"partner_client_ref": "crm-12345",
"sender_id": "PLOMBMARTIN",
"status": "PENDING",
"example_content": "Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin",
"created_at": "2026-11-16T10:05:00"
}
}{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {}
}{
"error": {}
}{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Required scope:
PARTNERPENDING.
Request
sender_idis required: 1 to 11 letters or digits, with no spaces or symbols, for examplePLOMBMARTIN. A missing value fails withMISSING_FIELD, any other format withSENDER_ID_INVALID_FORMAT. The name has to represent the account’s actual business, see the Sender ID naming rules.example_contentis optional: an example of a message the account will send, up to 1,000 characters. Allo’s reviewer reads it. A longer value fails withEXAMPLE_CONTENT_TOO_LONG.
Rules
- A sender ID belongs to one Allo account only. A name already held by another Allo account fails with
409 SENDER_ID_ALREADY_EXISTS. - An account holds at most 3 sender IDs. A fourth fails with
409 MAX_SENDER_IDS_REACHED. - Sending the same
sender_idagain for the same account returns the existing sender ID, so a retry is safe. - You can only declare sender IDs on accounts your own API key created. Any other account returns
404 PARTNER_ACCOUNT_NOT_FOUND.
Review
Allo reviews every sender ID by hand, usually in 1 to 5 business days. When the review ends, Allo sendspartner.sender_id.validated or partner.sender_id.failed to your own webhook endpoint. Without a webhook endpoint, poll Get sender ID.
Once the sender ID is VALIDATED, the account sends SMS with it through Send SMS (France).Body
application/json
Was this page helpful?