Skip to main content
PATCH
/
broadcasts
/
{id}
Update a broadcast
curl --request PATCH \
  --url https://api.getvero.com/api/v2/broadcasts/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated broadcast name"
}
'
import requests

url = "https://api.getvero.com/api/v2/broadcasts/{id}"

payload = { "name": "Updated broadcast name" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Updated broadcast name'})
};

fetch('https://api.getvero.com/api/v2/broadcasts/{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.getvero.com/api/v2/broadcasts/{id}",
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' => 'Updated broadcast name'
]),
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.getvero.com/api/v2/broadcasts/{id}"

payload := strings.NewReader("{\n \"name\": \"Updated broadcast name\"\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://api.getvero.com/api/v2/broadcasts/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Updated broadcast name\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.getvero.com/api/v2/broadcasts/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Updated broadcast name\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "name": "<string>",
  "schedule": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
{
"error": "not_found"
}
{
"errors": [
{
"message": "<string>"
}
]
}
{
"errors": [
{
"message": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Accepts either a raw API key or Bearer <key>.

Headers

revision
string

Optional dated API revision for the request. Must use YYYY-MM-DD format.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-03-01"

Path Parameters

id
integer
required

Broadcast ID.

Body

application/json

Update message/content-adjacent broadcast metadata only. channel may change only while the broadcast is a single-message draft whose current message is not yet sendable; that switch resets the message content body. Audience, segment, trigger, schedule, send, launch, lifecycle, and run fields are rejected with 422 Validation error.

name
string

Broadcast name. Trimmed before validation; must be non-blank.

Required string length: 1 - 255
channel
enum<string>
Available options:
email,
sms,
push

Response

Broadcast updated.

A broadcast: a one-off or recurring message sent to an audience.

id
integer
required
name
string
required

Broadcast name.

channel
enum<string>
required

Delivery channel.

Available options:
email,
sms,
push
schedule
object
required

Scheduling details for the broadcast. type indicates whether the broadcast is sent once or on a recurring schedule. Additional scheduling fields (such as scheduled_at, cron, next_scheduled_at, batches, and timezone_detection) may also be present.

status
enum<string>
required

Broadcast status. archived is returned for archived broadcasts on the detail endpoint.

Available options:
draft,
scheduled,
sending,
sent,
cancelled,
active,
paused,
archived
created_at
string<date-time>
required
updated_at
string<date-time>
required