Email

Update a broadcast.

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.

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

Path parameters

broadcastCampaignUidstring nullable required

Request body

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
SendDateTimestring date-time nullable
NextRunDateTimestring date-time nullable
RecipientDatastring nullable
EmailListUidsstring[] nullable
SegmentUidsstring[] nullable
TemplateUidstring nullable
Status1 | 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

ErrorMessagestring nullable

Example request

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "SendDateTime": "string",
  "NextRunDateTime": "string",
  "Campaign": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "Name": "string",
    "FromName": "string",
    "FromEmail": "string",
    "CampaignType": 1
  },
  "Message": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "Template": {},
    "Name": "string",
    "Subject": "string",
    "PreviewText": "string",
    "Body": "string",
    "Design": "string",
    "CountSent": 0,
    "CountDelivered": 0,
    "CountBounce": 0,
    "CountSpam": 0,
    "CountOpen": 0,
    "CountClick": 0,
    "CountUnsubscribed": 0,
    "CountTotalOpen": 0,
    "CountTotalClick": 0,
    "IgnoredSpamBounce": 0,
    "IsBounceRatePaused": false,
    "IsSpamScorePaused": false,
    "EmailLinks": [],
    "SpamAssassinScore": 0,
    "SpamStatus": 0,
    "SpamReason": "string"
  },
  "RecipientData": "string",
  "EmailListUids": [
    "string"
  ],
  "SegmentUids": [
    "string"
  ],
  "TemplateUid": "string",
  "Status": 1,
  "ErrorMessage": "string",
  "Tags": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Name": "string",
      "SystemName": "string",
      "SystemDescription": "string",
      "TagColor": 1,
      "EntityType": 0
    }
  ]
}

Response

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
SendDateTimestring date-time nullable
NextRunDateTimestring date-time nullable
RecipientDatastring nullable
EmailListUidsstring[] nullable
SegmentUidsstring[] nullable
TemplateUidstring nullable
Status1 | 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

ErrorMessagestring nullable

Example response

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "SendDateTime": "string",
  "NextRunDateTime": "string",
  "Campaign": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "Name": "string",
    "FromName": "string",
    "FromEmail": "string",
    "CampaignType": 1
  },
  "Message": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "Template": {},
    "Name": "string",
    "Subject": "string",
    "PreviewText": "string",
    "Body": "string",
    "Design": "string",
    "CountSent": 0,
    "CountDelivered": 0,
    "CountBounce": 0,
    "CountSpam": 0,
    "CountOpen": 0,
    "CountClick": 0,
    "CountUnsubscribed": 0,
    "CountTotalOpen": 0,
    "CountTotalClick": 0,
    "IgnoredSpamBounce": 0,
    "IsBounceRatePaused": false,
    "IsSpamScorePaused": false,
    "EmailLinks": [],
    "SpamAssassinScore": 0,
    "SpamStatus": 0,
    "SpamReason": "string"
  },
  "RecipientData": "string",
  "EmailListUids": [
    "string"
  ],
  "SegmentUids": [
    "string"
  ],
  "TemplateUid": "string",
  "Status": 1,
  "ErrorMessage": "string",
  "Tags": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Name": "string",
      "SystemName": "string",
      "SystemDescription": "string",
      "TagColor": 1,
      "EntityType": 0
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.