Email

Send a test email for a broadcast.

Sends to the logged-in user and optionally to additional recipients. Additional recipients are specified as a list of person Uids and must belong to the same account as the logged-in user.

post/api/v1/email/campaigns/broadcasts/sendtestemail

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/email/campaigns/broadcasts/sendtestemail
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Request body

AdditionalRecipientsstring[] nullable

Example request

{
  "BroadcastCampaign": {
    "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.