Unschedule a broadcast.

Unschedules a pending broadcast, reverting its status to Draft.

post/api/v1/email/campaigns/broadcasts/{broadcastCampaignUid}/unschedule

Request

Base URL: https://go.outseta.com
URL: https://go.outseta.com/api/v1/email/campaigns/broadcasts/{broadcastCampaignUid}/unschedule
Auth: one of:
- HTTP bearer
- API key in header Authorization

Path parameters

broadcastCampaignUidstring nullable required

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.