Campaigns

[DEPRECATED] Create a new email campaign

⚠️ DEPRECATED: Use POST /user-api/mail-campaigns instead. This endpoint will be removed on March 1, 2026.

Creates a new email marketing campaign with specified sequences, targeting, and configuration.

post/v3/user-api/create-campaign

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

Example request

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