NUnureply
Campaigns

Create new campaign

Create a new email campaign with multi-step sequences and A/B test variations.

Key Features:

  • Multi-step email sequences with wait times
  • A/B testing with multiple variations per step
  • Schedule configuration (days, hours, timezone)
  • Behavioral triggers (stop on reply/click)
  • Tracking and deliverability settings
post/v3/user-api/mail-campaigns

Request

  • Base URL
    https://api.nureply.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared. Required headers: x-personal-api-key

Headers

x-personal-api-keystring required

API Key from Dashboard

Request body

namestring required

Campaign name

intervalMinnumber required

Minimum interval between emails in minutes

intervalRandomUpTonumber required

Random interval to add (0 to this value in minutes)

userEmailAccountsstring[] required

Array of user email account IDs to send from. Can be empty if tags are provided.

stopSendingAfterReplyboolean required

Stop sending emails after receiving a reply

stopSendingFollowUpAfterReplyboolean required

Stop sending follow-up emails after receiving a reply

stopSendingAfterClickboolean required

Stop sending emails after a link is clicked

dailySendingLimitnumber required

Maximum emails to send per day

isPausedboolean required

Whether the campaign is paused

isCompletedboolean required

Whether the campaign is completed

isDeletedboolean required

Whether the campaign is deleted

isArchivedboolean required

Whether the campaign is archived

leadListstring required

Lead list ID to send the campaign to

openTrackingEnabledboolean required

Enable email open tracking

clickTrackingEnabledboolean required

Enable link click tracking

botFilteringboolean required

Enable bot filtering using global IP blocklist

unsubscribeEnabledboolean required

Enable unsubscribe functionality

timeZonestring required

Campaign timezone (IANA timezone identifier)

allowedDaysstring[] required

Days when emails can be sent

hourStartstring required

Start hour for sending emails (HH:mm format)

hourEndstring required

End hour for sending emails (HH:mm format)

ccstring[]

CC email addresses

bccstring[]

BCC email addresses

followUpPercentagenumber required

Percentage of leads to follow up with (0-100)

winningMetric'replyRate' | 'clickRate' | 'openRate' | ''

Metric to optimize for in A/B testing

tagsstring[]

Campaign tags for organization

bounceThresholdnumber nullable

Bounce rate threshold to pause campaign (null for no threshold)

customESPRulesCustomESPRuleDto[]

Rules restricting which sender ESPs may mail which recipient ESPs

emailDeliveryOptimizationEmailDeliveryOptimizationDto

Example request

{
  "name": "Q4 Sales Outreach Campaign",
  "intervalMin": 5,
  "intervalRandomUpTo": 5,
  "sequences": [
    {
      "name": "Initial Outreach",
      "variations": [
        {
          "name": "Variation A",
          "subject": "Great opportunity for {{firstName}}",
          "body": "<p>Hi {{firstName}},</p><p>I wanted to reach out...</p>",
          "isActive": true
        }
      ],
      "waitDaysBeforeNextStep": 1
    }
  ],
  "userEmailAccounts": [
    "653a2b0bf5444e11e5cdd1d0"
  ],
  "stopSendingAfterReply": true,
  "dailySendingLimit": 50,
  "leadList": "653a2b0bf5444e11e5cdd1d1",
  "openTrackingEnabled": true,
  "clickTrackingEnabled": true,
  "timeZone": "America/New_York",
  "allowedDays": [
    "monday",
    "tuesday",
    "wednesday",
    "thursday",
    "friday"
  ],
  "hourStart": "09:00",
  "hourEnd": "17:00",
  "cc": [],
  "bcc": [],
  "followUpPercentage": 50,
  "tags": [
    "sales",
    "q4-2023"
  ]
}

Response

messagestring required

Example response

{
  "message": "Created mail campaign",
  "data": {
    "_id": "653a2b0bf5444e11e5cdd1ce",
    "name": "Q1 2024 Outreach Campaign",
    "intervalMin": 5,
    "intervalRandomUpTo": 5,
    "sequences": [
      {
        "name": "Initial Outreach",
        "variations": [
          {
            "name": "Variation A",
            "subject": "Great opportunity for {{firstName}}",
            "body": "<p>Hi {{firstName}},</p><p>I wanted to reach out...</p>",
            "isActive": true
          }
        ],
        "waitDaysBeforeNextStep": 1
      }
    ],
    "userEmailAccounts": [
      "653a2b0bf5444e11e5cdd1d0"
    ],
    "tags": [],
    "customESPRules": [],
    "stopSendingAfterReply": true,
    "dailySendingLimit": 5,
    "dailySendingLimitRemaining": 5,
    "leadList": "653a2b0bf5444e11e5cdd1d1",
    "openTrackingEnabled": true,
    "clickTrackingEnabled": true,
    "user": "62878b4e647d7bd25db029a3",
    "organization": "62878b4e647d7bd25db029a4",
    "timeZone": "America/New_York",
    "allowedDays": [
      "monday",
      "tuesday",
      "wednesday",
      "thursday",
      "friday"
    ],
    "hourStart": "09:00",
    "hourEnd": "17:00",
    "createdAt": "2023-10-26T11:11:25.365Z",
    "updatedAt": "2023-10-26T11:11:25.365Z",
    "id": "653a2b0bf5444e11e5cdd1ce"
  }
}

Changes

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