Email

Update a drip campaign.

Activating a drip campaign (setting IsActive) begins sending its messages to members. StartDripToExistingMembers controls whether members already in the campaign receive the messages or only members added going forward.

put/api/v1/email/campaigns/drips/{dripCampaignUid}

Request

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

Path parameters

dripCampaignUidstring nullable required

The drip campaign's unique identifier.

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.