Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";
const syllableSDK = new SyllableSDK({
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});
async function run() {
const result = await syllableSDK.outbound.batches.delete({
batchId: "<id>",
bodyOutboundBatchDelete: {
deleteReason: "<value>",
},
});
console.log(result);
}
run();import os
from syllable_sdk import SyllableSDK
with SyllableSDK(
api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:
res = ss_client.outbound.batches.delete(batch_id="<id>", body_outbound_batch_delete={
"delete_reason": "<value>",
})
# Handle response
print(res)curl --request DELETE \
--url https://api.syllable.cloud/api/v1/outbound/batches/{batch_id} \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Syllable-API-Key: <api-key>' \
--data 'delete_reason=<string>'const options = {
method: 'DELETE',
headers: {
'Syllable-API-Key': '<api-key>',
'Content-Type': 'application/x-www-form-urlencoded'
},
body: new URLSearchParams({delete_reason: '<string>'})
};
fetch('https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}', 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.syllable.cloud/api/v1/outbound/batches/{batch_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => "delete_reason=%3Cstring%3E",
CURLOPT_HTTPHEADER => [
"Content-Type: application/x-www-form-urlencoded",
"Syllable-API-Key: <api-key>"
],
]);
$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.syllable.cloud/api/v1/outbound/batches/{batch_id}"
payload := strings.NewReader("delete_reason=%3Cstring%3E")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("Syllable-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}")
.header("Syllable-API-Key", "<api-key>")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("delete_reason=%3Cstring%3E")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Syllable-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "delete_reason=%3Cstring%3E"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}outbound.batches
Delete Outbound Communication Batch
DELETE
/
api
/
v1
/
outbound
/
batches
/
{batch_id}
Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";
const syllableSDK = new SyllableSDK({
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});
async function run() {
const result = await syllableSDK.outbound.batches.delete({
batchId: "<id>",
bodyOutboundBatchDelete: {
deleteReason: "<value>",
},
});
console.log(result);
}
run();import os
from syllable_sdk import SyllableSDK
with SyllableSDK(
api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:
res = ss_client.outbound.batches.delete(batch_id="<id>", body_outbound_batch_delete={
"delete_reason": "<value>",
})
# Handle response
print(res)curl --request DELETE \
--url https://api.syllable.cloud/api/v1/outbound/batches/{batch_id} \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Syllable-API-Key: <api-key>' \
--data 'delete_reason=<string>'const options = {
method: 'DELETE',
headers: {
'Syllable-API-Key': '<api-key>',
'Content-Type': 'application/x-www-form-urlencoded'
},
body: new URLSearchParams({delete_reason: '<string>'})
};
fetch('https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}', 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.syllable.cloud/api/v1/outbound/batches/{batch_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => "delete_reason=%3Cstring%3E",
CURLOPT_HTTPHEADER => [
"Content-Type: application/x-www-form-urlencoded",
"Syllable-API-Key: <api-key>"
],
]);
$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.syllable.cloud/api/v1/outbound/batches/{batch_id}"
payload := strings.NewReader("delete_reason=%3Cstring%3E")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("Syllable-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}")
.header("Syllable-API-Key", "<api-key>")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("delete_reason=%3Cstring%3E")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Syllable-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "delete_reason=%3Cstring%3E"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}⌘I

