--- title: "Update a broadcast." method: PUT path: "/api/v1/email/campaigns/broadcasts/{broadcastCampaignUid}" tags: ["Email"] --- # Update a broadcast. `PUT /api/v1/email/campaigns/broadcasts/{broadcastCampaignUid}` ## Request - Base URL: `https://go.outseta.com` - URL: `https://go.outseta.com/api/v1/email/campaigns/broadcasts/{broadcastCampaignUid}` - Auth: one of: - HTTP bearer - API key in header `Authorization` Setting SendDateTime to a future UTC date schedules the broadcast for sending and its status changes to Pending. An account may only have 5 broadcasts scheduled or sending at one time; scheduling beyond that is rejected until one finishes sending or is unscheduled. There is no limit on the number of drafts. Clearing SendDateTime unschedules the broadcast. Recipients can be added with EmailListUids and SegmentUids (see the create endpoint): on update these are merged onto the broadcast's existing recipients and only ever add — to remove recipients or replace the set, send RecipientData directly. When changing Message.Body, omit Message.Design: it is regenerated from the new Body so the drag-and-drop editor stays in sync. Sending a Design that was captured from an earlier response alongside an edited Body would otherwise keep the stale design. A body that was composed into the API email layout keeps the layout on such updates without duplicating it — its content is re-composed into the layout — and a bare fragment is composed like on create. See the create endpoint for how Body is rendered (Liquid), when the layout applies, and the unsubscribe-token expectation when it does not. ## Path parameters - `broadcastCampaignUid` string, nullable, required ## Request body - BroadcastCampaign - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SendDateTime` string, date-time, nullable - `NextRunDateTime` string, date-time, nullable - `Campaign` Campaign - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Name` string, required - `FromName` string, nullable - `FromEmail` string, nullable - `CampaignType` 1 | 2: `1` - Broadcast, `2` - Drip - `Message` Message - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Template` Template - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Name` string, required - `Subject` string, nullable - `Body` string, required - `Design` string, nullable - `Description` string, nullable - `SystemName` string, nullable - `IsInternal` boolean - `AvailableTokens` string, nullable - `RequiredTokens` string, nullable - `Tag` string, nullable - `Name` string, required - `Subject` string, nullable - `PreviewText` string, nullable - `Body` string, nullable - `Design` string, nullable - `CountSent` integer - `CountDelivered` integer - `CountBounce` integer - `CountSpam` integer - `CountOpen` integer - `CountClick` integer - `CountUnsubscribed` integer - `CountTotalOpen` integer - `CountTotalClick` integer - `IgnoredSpamBounce` integer - `IsBounceRatePaused` boolean - `IsSpamScorePaused` boolean - `EmailLinks` EmailLink[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Name` string, nullable - `URL` string, nullable - `CountClick` integer - `CountTotalClick` integer - `RecipientIds` integer[], nullable - `SpamAssassinScore` number - `SpamStatus` 0 | 1 | 2 | 3 | 4 | 5 | 6: `0` - Draft, `1` - Pending, `2` - Processing, `3` - Reprocessing, `4` - Spam, `5` - NotSpam, `6` - Ignored - `SpamReason` string, nullable - `RecipientData` string, nullable - `EmailListUids` string[], nullable - `SegmentUids` string[], nullable - `TemplateUid` string, nullable - `Status` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10: `1` - Draft, `2` - Pending, `3` - Sent, `4` - Queuing, `5` - Queued, `6` - Sending, `7` - Error, `8` - WaitingToResume, `9` - QueuedEmails, `10` - Archived - `ErrorMessage` string, nullable - `Tags` Tag[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Name` string, required - `SystemName` string, nullable - `SystemDescription` string, nullable - `TagColor` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10: `1` - Red, `2` - Orange, `3` - Amber, `4` - Green, `5` - Teal, `6` - Blue, `7` - Indigo, `8` - Purple, `9` - Pink, `10` - Gray - `EntityType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13: `0` - None, `1` - Account, `2` - Person, `3` - Deal, `4` - Case, `5` - Invoice, `6` - EmailLog, `7` - Plan, `8` - DiscountCoupon, `9` - AddOn, `10` - Task, `11` - Segment, `12` - Broadcast, `13` - Article ## Response `200` - BroadcastCampaign - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SendDateTime` string, date-time, nullable - `NextRunDateTime` string, date-time, nullable - `Campaign` Campaign - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Name` string, required - `FromName` string, nullable - `FromEmail` string, nullable - `CampaignType` 1 | 2: `1` - Broadcast, `2` - Drip - `Message` Message - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Template` Template - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Name` string, required - `Subject` string, nullable - `Body` string, required - `Design` string, nullable - `Description` string, nullable - `SystemName` string, nullable - `IsInternal` boolean - `AvailableTokens` string, nullable - `RequiredTokens` string, nullable - `Tag` string, nullable - `Name` string, required - `Subject` string, nullable - `PreviewText` string, nullable - `Body` string, nullable - `Design` string, nullable - `CountSent` integer - `CountDelivered` integer - `CountBounce` integer - `CountSpam` integer - `CountOpen` integer - `CountClick` integer - `CountUnsubscribed` integer - `CountTotalOpen` integer - `CountTotalClick` integer - `IgnoredSpamBounce` integer - `IsBounceRatePaused` boolean - `IsSpamScorePaused` boolean - `EmailLinks` EmailLink[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Name` string, nullable - `URL` string, nullable - `CountClick` integer - `CountTotalClick` integer - `RecipientIds` integer[], nullable - `SpamAssassinScore` number - `SpamStatus` 0 | 1 | 2 | 3 | 4 | 5 | 6: `0` - Draft, `1` - Pending, `2` - Processing, `3` - Reprocessing, `4` - Spam, `5` - NotSpam, `6` - Ignored - `SpamReason` string, nullable - `RecipientData` string, nullable - `EmailListUids` string[], nullable - `SegmentUids` string[], nullable - `TemplateUid` string, nullable - `Status` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10: `1` - Draft, `2` - Pending, `3` - Sent, `4` - Queuing, `5` - Queued, `6` - Sending, `7` - Error, `8` - WaitingToResume, `9` - QueuedEmails, `10` - Archived - `ErrorMessage` string, nullable - `Tags` Tag[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Name` string, required - `SystemName` string, nullable - `SystemDescription` string, nullable - `TagColor` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10: `1` - Red, `2` - Orange, `3` - Amber, `4` - Green, `5` - Teal, `6` - Blue, `7` - Indigo, `8` - Purple, `9` - Pink, `10` - Gray - `EntityType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13: `0` - None, `1` - Account, `2` - Person, `3` - Deal, `4` - Case, `5` - Invoice, `6` - EmailLog, `7` - Plan, `8` - DiscountCoupon, `9` - AddOn, `10` - Task, `11` - Segment, `12` - Broadcast, `13` - Article ## Other responses - `400`: Invalid Uid format - `401`: Unauthorized - `404`: BroadcastCampaign not found --- [API](https://skmtc.dev/outseta/apis/outseta-api.md) · [All operations](https://skmtc.dev/outseta/apis/outseta-api/llms.txt) · [OpenAPI document](https://skmtc.dev/outseta/apis/outseta-api/revisions/c362823af82d?raw)