Send a test email for a drip campaign.

Sends the drip campaign 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. Sending is skipped when the account is restricted due to unpaid invoices.

post/api/v1/email/campaigns/drips/sendtestemail

Request

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

Request body

AdditionalRecipientsstring[] nullable

Example request

{
  "DripCampaign": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "IsActive": false,
    "Campaign": {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Name": "string",
      "FromName": "string",
      "FromEmail": "string",
      "CampaignType": 1
    },
    "TriggerId": 0,
    "TriggerStartValue": "string",
    "TriggerStopValue": "string",
    "DripCampaignMessages": [
      {
        "Uid": "string",
        "_objectType": "string",
        "Created": "string",
        "Updated": "string",
        "ActivityEventData": {},
        "DripCampaign": {},
        "Message": {},
        "DelayFromPriorDay": 0,
        "DelayInHours": 0,
        "Weight": 0
      }
    ],
    "AllowRepeatProcessing": false,
    "StartDripToExistingMembers": false,
    "MarkExistingRecipientsDone": false
  }
}

Changes

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