Skip to content
Pidgely Docs

API reference · Broadcasts

Update a draft broadcast

PATCHhttps://api.pidgely.com/broadcasts/{id}
View as Markdown

Updates a draft broadcast. Broadcasts that are scheduled or already sending cannot be edited.

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Path parameters

Name Type Required Description
id string Yes Resource id UUID.

Body parameters

JSON object.

Name Type Required Description
segment_id string No Segment the broadcast is sent to. UUID.
audience_id string No Legacy alias of segment_id. UUID.
from string No —
subject string No Subject line, up to 998 bytes. Required unless a template provides it.
reply_to string | string[] No Reply-To address or list of addresses.
html string No Supports {{{FIRST_NAME|there}}}, {{{contact.<property>}}}, {{{PIDGELY_UNSUBSCRIBE_URL}}}.
text string No —
name string No Display name.
preview_text string No Preview text shown by mail clients next to the subject (inserted as hidden text at the top of the HTML).
send boolean No Send immediately after creating (or at scheduled_at).
scheduled_at string No ISO 8601 or natural language (in 1 hour, tomorrow at 9am, UTC), within 30 days.
topic_id string No Not supported yet.

Request

Node.js
import { Pidgely } from 'pidgely';

const pidgely = new Pidgely(process.env.PIDGELY_API_KEY);

const { data, error } = await pidgely.broadcasts.update('0199d7f6-4c8d-7e1a-9b3f-2d6a5c0e7f19', {
  subject: 'What shipped in October (and what is next)',
});
console.log(data ?? error);
Python
import os
import pidgely

pidgely.api_key = os.environ["PIDGELY_API_KEY"]

result = pidgely.Broadcasts.update("0199d7f6-4c8d-7e1a-9b3f-2d6a5c0e7f19", {
    "subject": "What shipped in October (and what is next)",
})
print(result)
PHP
<?php

require __DIR__ . '/vendor/autoload.php';

$pidgely = Pidgely::client(getenv('PIDGELY_API_KEY'));

$result = $pidgely->broadcasts->update('0199d7f6-4c8d-7e1a-9b3f-2d6a5c0e7f19', [
    'subject' => 'What shipped in October (and what is next)',
]);
var_dump($result);
Go
package main

import (
	"context"
	"fmt"
	"os"

	"github.com/pidgely/pidgely-go"
)

func main() {
	ctx := context.Background()
	client := pidgely.NewClient(os.Getenv("PIDGELY_API_KEY"))

	result, err := client.Broadcasts.Update(ctx, "0199d7f6-4c8d-7e1a-9b3f-2d6a5c0e7f19", &pidgely.UpdateBroadcastRequest{
		Subject: "What shipped in October (and what is next)",
	})
	if err != nil {
		panic(err)
	}
	fmt.Println(result)
}
Ruby
require "pidgely"

Pidgely.api_key = ENV["PIDGELY_API_KEY"]

result = Pidgely::Broadcasts.update("0199d7f6-4c8d-7e1a-9b3f-2d6a5c0e7f19", {
  subject: "What shipped in October (and what is next)"
})
puts result
cURL
curl -X PATCH 'https://api.pidgely.com/broadcasts/0199d7f6-4c8d-7e1a-9b3f-2d6a5c0e7f19' \
  -H "Authorization: Bearer $PIDGELY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "subject": "What shipped in October (and what is next)"
}'

Response

200 OK

JSON
{
  "object": "broadcast",
  "id": "0199d7f6-4c8d-7e1a-9b3f-2d6a5c0e7f19"
}

Response fields

Name Type Required Description
object string Yes Object type.
id string Yes Unique id (UUID). UUID.

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
422 validation_error A field is missing or invalid; message names it.
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.
409 broadcast_not_draft The broadcast is not a draft any more.