Email

Create a new drip campaign.

To copy an existing drip campaign, retrieve it and pass its data as the request body — the Uid and per-message counts are automatically reset. Messages can be supplied inline via DripCampaignMessages, or added later with the messages endpoint. Each inline message's Name defaults to its position (e.g. "Message 1") when omitted.

post/api/v1/email/campaigns/drips

Request

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

Request body

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
IsActiveboolean
TriggerIdinteger
TriggerStartValuestring nullable
TriggerStopValuestring nullable
AllowRepeatProcessingboolean
StartDripToExistingMembersboolean
MarkExistingRecipientsDoneboolean

Example request

{
  "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
}

Response

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
IsActiveboolean
TriggerIdinteger
TriggerStartValuestring nullable
TriggerStopValuestring nullable
AllowRepeatProcessingboolean
StartDripToExistingMembersboolean
MarkExistingRecipientsDoneboolean

Example response

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