Email

Update a message in a drip campaign.

Changing DelayInHours on an active drip campaign reschedules the drip for its existing members. The DripCampaign Uid on the body, if supplied, must match the dripCampaignUid in the URL, and the message Uid on the body must match the dripCampaignMessageUid in the URL.

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

Request

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

Path parameters

dripCampaignUidstring nullable required

The drip campaign's unique identifier.

dripCampaignMessageUidstring nullable required

The drip campaign message's unique identifier.

Request body

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
DelayFromPriorDayinteger
DelayInHoursinteger
Weightinteger

Example request

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "DripCampaign": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "IsActive": false,
    "Campaign": {},
    "TriggerId": 0,
    "TriggerStartValue": "string",
    "TriggerStopValue": "string",
    "DripCampaignMessages": [],
    "AllowRepeatProcessing": false,
    "StartDripToExistingMembers": false,
    "MarkExistingRecipientsDone": false
  },
  "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"
  },
  "DelayFromPriorDay": 0,
  "DelayInHours": 0,
  "Weight": 0
}

Response

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
DelayFromPriorDayinteger
DelayInHoursinteger
Weightinteger

Example response

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "DripCampaign": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "IsActive": false,
    "Campaign": {},
    "TriggerId": 0,
    "TriggerStartValue": "string",
    "TriggerStopValue": "string",
    "DripCampaignMessages": [],
    "AllowRepeatProcessing": false,
    "StartDripToExistingMembers": false,
    "MarkExistingRecipientsDone": false
  },
  "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"
  },
  "DelayFromPriorDay": 0,
  "DelayInHours": 0,
  "Weight": 0
}

Changes

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