Skip to main content
PUT
/
v2
/
api
/
numbers
/
{number}
/
default_summary_template
Set number default summary template
curl --request PUT \
  --url https://api.withallo.com/v2/api/numbers/{number}/default_summary_template \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "summary_template_id": "tst-abc123"
}
'
import requests

url = "https://api.withallo.com/v2/api/numbers/{number}/default_summary_template"

payload = { "summary_template_id": "tst-abc123" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({summary_template_id: 'tst-abc123'})
};

fetch('https://api.withallo.com/v2/api/numbers/{number}/default_summary_template', 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/numbers/{number}/default_summary_template",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'summary_template_id' => 'tst-abc123'
]),
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/numbers/{number}/default_summary_template"

payload := strings.NewReader("{\n \"summary_template_id\": \"tst-abc123\"\n}")

req, _ := http.NewRequest("PUT", 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.put("https://api.withallo.com/v2/api/numbers/{number}/default_summary_template")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"summary_template_id\": \"tst-abc123\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.withallo.com/v2/api/numbers/{number}/default_summary_template")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"summary_template_id\": \"tst-abc123\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "number": "+14155551234",
    "default_summary_template_id": "tst-abc123"
  }
}
{
"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: SUMMARY_TEMPLATES_WRITE

Behavior

Sets the default summary template for a phone number. New calls on that number are summarized using this template. The {number} path parameter is the Allo phone number in E.164 format (e.g. +14155551234). Pass summary_template_id (a tst-* ID) to set the default, or omit it / pass null to clear the default and fall back to Allo’s standard summary.

Errors

  • 404 PHONE_NUMBER_NOT_FOUND — the number is not one of your account’s numbers. List them with GET /v2/api/numbers.
  • 404 SUMMARY_TEMPLATE_NOT_FOUND — no active template with that ID exists for the number’s team.

Authorizations

Authorization
string
header
required

Path Parameters

number
string
required

Allo phone number in E.164 format

Example:

"+14155551234"

Body

application/json
summary_template_id
string | null

Summary template ID (tst-*) to set as the default, or null to clear.

Example:

"tst-abc123"

Response

Default summary template updated

data
object