API Reference
Update broadcast
Update a broadcast in draft status.
PATCH
/
v1
/
broadcasts
/
{broadcastId}
Update broadcast
curl --request PATCH \
--url https://api.zavu.dev/v1/broadcasts/{broadcastId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"text": "<string>",
"content": {
"mediaUrl": "<string>",
"mediaId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"templateId": "<string>",
"templateVariables": {},
"templateButtonVariables": {},
"templateHeaderVariables": {}
},
"emailSubject": "<string>",
"emailHtmlBody": "<string>",
"metadata": {}
}
'import requests
url = "https://api.zavu.dev/v1/broadcasts/{broadcastId}"
payload = {
"name": "<string>",
"text": "<string>",
"content": {
"mediaUrl": "<string>",
"mediaId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"templateId": "<string>",
"templateVariables": {},
"templateButtonVariables": {},
"templateHeaderVariables": {}
},
"emailSubject": "<string>",
"emailHtmlBody": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
text: '<string>',
content: {
mediaUrl: '<string>',
mediaId: '<string>',
mimeType: '<string>',
filename: '<string>',
templateId: '<string>',
templateVariables: {},
templateButtonVariables: {},
templateHeaderVariables: {}
},
emailSubject: '<string>',
emailHtmlBody: '<string>',
metadata: {}
})
};
fetch('https://api.zavu.dev/v1/broadcasts/{broadcastId}', 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.zavu.dev/v1/broadcasts/{broadcastId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'text' => '<string>',
'content' => [
'mediaUrl' => '<string>',
'mediaId' => '<string>',
'mimeType' => '<string>',
'filename' => '<string>',
'templateId' => '<string>',
'templateVariables' => [
],
'templateButtonVariables' => [
],
'templateHeaderVariables' => [
]
],
'emailSubject' => '<string>',
'emailHtmlBody' => '<string>',
'metadata' => [
]
]),
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.zavu.dev/v1/broadcasts/{broadcastId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"content\": {\n \"mediaUrl\": \"<string>\",\n \"mediaId\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"filename\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateVariables\": {},\n \"templateButtonVariables\": {},\n \"templateHeaderVariables\": {}\n },\n \"emailSubject\": \"<string>\",\n \"emailHtmlBody\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.zavu.dev/v1/broadcasts/{broadcastId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"content\": {\n \"mediaUrl\": \"<string>\",\n \"mediaId\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"filename\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateVariables\": {},\n \"templateButtonVariables\": {},\n \"templateHeaderVariables\": {}\n },\n \"emailSubject\": \"<string>\",\n \"emailHtmlBody\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zavu.dev/v1/broadcasts/{broadcastId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"content\": {\n \"mediaUrl\": \"<string>\",\n \"mediaId\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"filename\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateVariables\": {},\n \"templateButtonVariables\": {},\n \"templateHeaderVariables\": {}\n },\n \"emailSubject\": \"<string>\",\n \"emailHtmlBody\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"broadcast": {
"id": "brd_abc123",
"name": "<string>",
"totalContacts": 123,
"createdAt": "2023-11-07T05:31:56Z",
"text": "<string>",
"content": {
"mediaUrl": "<string>",
"mediaId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"templateId": "<string>",
"templateVariables": {},
"templateButtonVariables": {},
"templateHeaderVariables": {}
},
"senderId": "<string>",
"emailSubject": "<string>",
"pendingCount": 123,
"sendingCount": 123,
"deliveredCount": 123,
"failedCount": 123,
"estimatedCost": 123,
"reservedAmount": 123,
"actualCost": 123,
"scheduledAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"metadata": {},
"updatedAt": "2023-11-07T05:31:56Z",
"reviewResult": {
"score": 123,
"categories": [
"<string>"
],
"reasoning": "<string>",
"reviewedAt": "2023-11-07T05:31:56Z",
"flaggedContent": [
"<string>"
]
},
"reviewAttempts": 123
}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Response
Broadcast updated.
Show child attributes
Show child attributes
⌘I
Update broadcast
curl --request PATCH \
--url https://api.zavu.dev/v1/broadcasts/{broadcastId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"text": "<string>",
"content": {
"mediaUrl": "<string>",
"mediaId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"templateId": "<string>",
"templateVariables": {},
"templateButtonVariables": {},
"templateHeaderVariables": {}
},
"emailSubject": "<string>",
"emailHtmlBody": "<string>",
"metadata": {}
}
'import requests
url = "https://api.zavu.dev/v1/broadcasts/{broadcastId}"
payload = {
"name": "<string>",
"text": "<string>",
"content": {
"mediaUrl": "<string>",
"mediaId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"templateId": "<string>",
"templateVariables": {},
"templateButtonVariables": {},
"templateHeaderVariables": {}
},
"emailSubject": "<string>",
"emailHtmlBody": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
text: '<string>',
content: {
mediaUrl: '<string>',
mediaId: '<string>',
mimeType: '<string>',
filename: '<string>',
templateId: '<string>',
templateVariables: {},
templateButtonVariables: {},
templateHeaderVariables: {}
},
emailSubject: '<string>',
emailHtmlBody: '<string>',
metadata: {}
})
};
fetch('https://api.zavu.dev/v1/broadcasts/{broadcastId}', 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.zavu.dev/v1/broadcasts/{broadcastId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'text' => '<string>',
'content' => [
'mediaUrl' => '<string>',
'mediaId' => '<string>',
'mimeType' => '<string>',
'filename' => '<string>',
'templateId' => '<string>',
'templateVariables' => [
],
'templateButtonVariables' => [
],
'templateHeaderVariables' => [
]
],
'emailSubject' => '<string>',
'emailHtmlBody' => '<string>',
'metadata' => [
]
]),
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.zavu.dev/v1/broadcasts/{broadcastId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"content\": {\n \"mediaUrl\": \"<string>\",\n \"mediaId\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"filename\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateVariables\": {},\n \"templateButtonVariables\": {},\n \"templateHeaderVariables\": {}\n },\n \"emailSubject\": \"<string>\",\n \"emailHtmlBody\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.zavu.dev/v1/broadcasts/{broadcastId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"content\": {\n \"mediaUrl\": \"<string>\",\n \"mediaId\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"filename\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateVariables\": {},\n \"templateButtonVariables\": {},\n \"templateHeaderVariables\": {}\n },\n \"emailSubject\": \"<string>\",\n \"emailHtmlBody\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zavu.dev/v1/broadcasts/{broadcastId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"content\": {\n \"mediaUrl\": \"<string>\",\n \"mediaId\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"filename\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateVariables\": {},\n \"templateButtonVariables\": {},\n \"templateHeaderVariables\": {}\n },\n \"emailSubject\": \"<string>\",\n \"emailHtmlBody\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"broadcast": {
"id": "brd_abc123",
"name": "<string>",
"totalContacts": 123,
"createdAt": "2023-11-07T05:31:56Z",
"text": "<string>",
"content": {
"mediaUrl": "<string>",
"mediaId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"templateId": "<string>",
"templateVariables": {},
"templateButtonVariables": {},
"templateHeaderVariables": {}
},
"senderId": "<string>",
"emailSubject": "<string>",
"pendingCount": 123,
"sendingCount": 123,
"deliveredCount": 123,
"failedCount": 123,
"estimatedCost": 123,
"reservedAmount": 123,
"actualCost": 123,
"scheduledAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"metadata": {},
"updatedAt": "2023-11-07T05:31:56Z",
"reviewResult": {
"score": 123,
"categories": [
"<string>"
],
"reasoning": "<string>",
"reviewedAt": "2023-11-07T05:31:56Z",
"flaggedContent": [
"<string>"
]
},
"reviewAttempts": 123
}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}