Campaign API Documentation

Manage email marketing campaigns through programmatic API access. Create, update, monitor, and control campaign lifecycles.

Cancel a Campaign

POST /api.php (legacy)

API Usage Notes

• Authentication is done by User API Key
• Required permissions: Campaign.Update
• Legacy endpoint access via /api.php is also supported

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: campaign.cancel
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
CampaignID	Integer	Yes	ID of the campaign to cancel

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "campaign.cancel",
    "SessionID": "your-session-id",
    "CampaignID": 12345
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0
}

Error Response

{
  "Success": false,
  "ErrorCode": [1]
}

Error Codes

0: Success
1: Missing required parameter (CampaignID)
2: Campaign not found or doesn't belong to user

Copy a Campaign

POST /api.php (legacy)

API Usage Notes

• Authentication is done by User API Key
• Required permissions: Campaign.Create
• Legacy endpoint access via /api.php is also supported

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: campaign.copy
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
CampaignID	Integer	Yes	ID of the campaign to copy

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "campaign.copy",
    "SessionID": "your-session-id",
    "CampaignID": 12345
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "NewCampaignID": 12346
}

Error Response

{
  "Success": false,
  "ErrorCode": [1],
  "ErrorText": ["Invalid source campaign"]
}

Error Codes

0: Success
1: Invalid source campaign or campaign not found

Create a Campaign

POST /api.php (legacy)

API Usage Notes

• Authentication is done by User API Key
• Required permissions: Campaign.Create
• Legacy endpoint access via /api.php is also supported

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: campaign.create
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
CampaignName	String	Yes	Name of the new campaign

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "campaign.create",
    "SessionID": "your-session-id",
    "CampaignName": "Summer Sale 2025"
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "CampaignID": 12345
}

Error Response

{
  "Success": false,
  "ErrorCode": [1]
}

Error Codes

0: Success
1: Missing required parameter (CampaignName)

Get Campaign Details

POST /api.php (legacy)

API Usage Notes

• Authentication is done by User API Key or Admin API Key
• Required permissions: Campaign.Get
• Legacy endpoint access via /api.php is also supported

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: campaign.get
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
CampaignID	Integer	Yes	ID of the campaign to retrieve
RetrieveStatistics	Boolean	No	Include campaign statistics (default: false)
RetrieveTags	Boolean	No	Include campaign tags (default: false)
SplitABTestStatistics	Boolean	No	Include A/B test statistics (default: false)
RetrieveRecipientDomains	Boolean	No	Include recipient domain statistics (default: true)

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "campaign.get",
    "SessionID": "your-session-id",
    "CampaignID": 12345,
    "RetrieveStatistics": true,
    "RetrieveRecipientDomains": true
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "Campaign": {
    "CampaignID": 12345,
    "CampaignName": "Summer Sale 2025",
    "CampaignStatus": "Sent",
    "TotalRecipients": 10000,
    "TotalSent": 9950,
    "TotalOpens": 3500,
    "UniqueOpens": 2100,
    "TotalClicks": 850,
    "UniqueClicks": 650
  },
  "CampaignThroughput": {
    "EmailsPerSecond": 125.5,
    "Duration": 79
  }
}

Error Response

{
  "Success": false,
  "ErrorCode": 2
}

Error Codes

0: Success
2: Campaign not found or invalid CampaignID

Pause a Campaign

POST /api.php (legacy)

API Usage Notes

• Authentication is done by User API Key
• Required permissions: Campaign.Update
• Legacy endpoint access via /api.php is also supported

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: campaign.pause
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
CampaignID	Integer	Yes	ID of the campaign to pause

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "campaign.pause",
    "SessionID": "your-session-id",
    "CampaignID": 12345
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0
}

Error Response

{
  "Success": false,
  "ErrorCode": 3
}

Error Codes

0: Success
1: Missing required parameter (CampaignID)
2: Campaign not found or doesn't belong to user
3: Invalid campaign status (campaign must be Sending or Ready to be paused)

Get Campaign Recipients

POST /api.php (legacy)

API Usage Notes

• Authentication is done by User API Key or Admin API Key
• Required permissions: Campaign.Get
• This endpoint only works for unsent campaigns (Draft, Ready, Pending Approval)
• For sent campaigns, use campaign statistics or queue endpoints instead
• Legacy endpoint access via /api.php is also supported

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: campaign.recipients.get
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
CampaignID	Integer	Yes	ID of the campaign
OnlyTotal	Boolean	No	Return only total count without recipient details (default: false)

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "campaign.recipients.get",
    "SessionID": "your-session-id",
    "CampaignID": 12345,
    "OnlyTotal": false
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "CampaignID": 12345,
  "TotalRecipients": 1500,
  "Recipients": [
    {
      "SubscriberID": 101,
      "EmailAddress": "user@example.com",
      "FirstName": "John",
      "LastName": "Doe"
    }
  ]
}

Error Response

{
  "Success": false,
  "ErrorCode": 4,
  "ErrorMessage": "This endpoint only works for unsent campaigns",
  "CampaignStatus": "Sent"
}

Error Codes

0: Success
1: Missing required parameter (CampaignID)
2: Invalid CampaignID (must be numeric)
3: Campaign not found or access denied
4: Invalid campaign status (must be Draft, Ready, or Pending Approval)
5: Campaign has no RulesJsonBundle or criteria defined
10: Error retrieving campaign recipients

Resume a Campaign

POST /api.php (legacy)

API Usage Notes

• Authentication is done by User API Key
• Required permissions: Campaign.Update
• Legacy endpoint access via /api.php is also supported

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: campaign.resume
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
CampaignID	Integer	Yes	ID of the campaign to resume

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "campaign.resume",
    "SessionID": "your-session-id",
    "CampaignID": 12345
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0
}

Error Response

{
  "Success": false,
  "ErrorCode": 3
}

Error Codes

0: Success
1: Missing required parameter (CampaignID)
2: Campaign not found or doesn't belong to user
3: Campaign status is not Paused (only Paused campaigns can be resumed)

Update a Campaign

POST /api.php (legacy)

API Usage Notes

• Authentication is done by User API Key
• Required permissions: Campaign.Update
• Legacy endpoint access via /api.php is also supported

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: campaign.update
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
CampaignID	Integer	Yes	ID of the campaign to update
CampaignName	String	No	New campaign name
CampaignStatus	String	No	Campaign status (Draft, Ready, Sending, Paused, Pending Approval, Sent, Failed)
CampaignStatusReason	String	No	Reason for status change
RelEmailID	Integer	No	ID of the email content to use
ScheduleType	String	No	Schedule type (Not Scheduled, Immediate, Future, Recursive)
SendDate	String	No	Send date (YYYY-MM-DD format) - required if ScheduleType=Future
SendTime	String	No	Send time (HH:MM:SS format) - required if ScheduleType=Future
SendTimeZone	String	No	Timezone for scheduled send
ScheduleRecDaysOfWeek	String	No	Days of week for recurring campaigns
ScheduleRecDaysOfMonth	String	No	Days of month for recurring campaigns
ScheduleRecMonths	String	No	Months for recurring campaigns - required if ScheduleType=Recursive
ScheduleRecHours	String	No	Hours for recurring campaigns - required if ScheduleType=Recursive
ScheduleRecMinutes	String	No	Minutes for recurring campaigns - required if ScheduleType=Recursive
ScheduleRecSendMaxInstance	Integer	No	Max instances for recurring campaigns - required if ScheduleType=Recursive
ApprovalUserExplanation	String	No	User explanation for approval
GoogleAnalyticsDomains	String	No	Google Analytics tracking domains
PublishOnRSS	String	No	Publish on RSS (Enabled/Disabled)
AutoResendEnabled	Boolean	No	Enable auto-resend to non-openers
AutoResendWaitDays	Integer	No	Days to wait before auto-resend - required if AutoResendEnabled=true
AutoResendSubject	String	No	Subject line for auto-resend - required if AutoResendEnabled=true
AutoResendPreHeaderText	String	No	Pre-header text for auto-resend
OriginalCampaignID	Integer	No	ID of original campaign if this is a resend
RecipientListsAndSegments	String	No	Comma-separated list (format: ListID:SegmentID)
Exclude_RecipientListsAndSegments	String	No	Comma-separated exclusion list (format: ListID:SegmentID)
RulesJsonBundle	String	No	JSON string with advanced recipient selection rules
S2SEnabled	Boolean	No	Enable server-to-server tracking
ABTesting	Object	No	A/B testing configuration with variations

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "campaign.update",
    "SessionID": "your-session-id",
    "CampaignID": 12345,
    "CampaignName": "Updated Summer Sale",
    "CampaignStatus": "Ready",
    "ScheduleType": "Future",
    "SendDate": "2025-06-15",
    "SendTime": "10:00:00",
    "SendTimeZone": "America/New_York"
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0
}

Error Response

{
  "Success": false,
  "ErrorCode": 6
}

Error Codes

0: Success
1: Missing required parameter (CampaignID)
2: Campaign not found or doesn't belong to user
3: Invalid campaign status
4: Email not found or doesn't belong to user
5: Invalid schedule type
6: Missing SendDate for Future schedule
7: Missing SendTime for Future schedule
8: Missing ScheduleRecDaysOfWeek or ScheduleRecDaysOfMonth for Recursive schedule
9: Missing ScheduleRecMonths for Recursive schedule
10: Missing ScheduleRecHours for Recursive schedule
11: Missing ScheduleRecMinutes for Recursive schedule
12: Missing ScheduleRecSendMaxInstance for Recursive schedule
14: Missing or invalid AutoResendWaitDays when AutoResendEnabled=true
15: Missing AutoResendSubject when AutoResendEnabled=true
16: Missing AutoResendPreHeaderText when AutoResendEnabled=true
17: Invalid ABTesting parameter format (must be array)
18: Invalid ABTesting variations format (must be array)
19: Email variation not found or doesn't belong to user
21: Minimum 2 A/B test variations required
22: Maximum 5 A/B test variations allowed
23: Missing required fields in A/B variation (EmailID, Weight)
24: Invalid EmailID or Weight in A/B variation
25: A/B variation distribution percentage below 1%

Get Campaign Archive URL

POST /api.php (legacy)

API Usage Notes

• Authentication is done by User API Key
• Required permissions: Campaigns.Get
• Legacy endpoint access via /api.php is also supported

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: campaigns.archive.geturl
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
TagID	Integer	Yes	ID of the tag for archive URL
TemplateURL	String	No	Custom template URL for archive

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "campaigns.archive.geturl",
    "SessionID": "your-session-id",
    "TagID": 5,
    "TemplateURL": "https://example.com/archive-template"
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "URL": "https://example.com/archive/tag/5"
}

Error Response

{
  "Success": false,
  "ErrorCode": 2
}

Error Codes

0: Success
1: Missing required parameter (TagID)
2: Tag not found or doesn't belong to user

Delete Campaigns

POST /api.php (legacy)

API Usage Notes

• Authentication is done by User API Key
• Required permissions: Campaign.Delete
• This endpoint also deletes associated auto-resend campaigns automatically
• Legacy endpoint access via /api.php is also supported

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: campaigns.delete
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
Campaigns	String	Yes	Comma-separated list of campaign IDs to delete

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "campaigns.delete",
    "SessionID": "your-session-id",
    "Campaigns": "12345,12346,12347"
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "ErrorText": ""
}

Error Response

{
  "Success": false,
  "ErrorCode": [1]
}

Error Codes

0: Success
1: Missing required parameter (Campaigns)

Get Campaigns List

POST /api.php (legacy)

API Usage Notes

• Authentication is done by User API Key
• Required permissions: Campaigns.Get
• Legacy endpoint access via /api.php is also supported

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: campaigns.get
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
CampaignStatus	String	No	Filter by status (Draft, Ready, Scheduled, Sending, Sent, Paused, Failed, All)
ScheduleType	String/Array	No	Filter by schedule type (Not Scheduled, Immediate, Future, Recursive)
SearchKeyword	String	No	Search campaigns by name (LIKE query)
FilterByUserID	Integer	No	Filter by account/user ID (admin only)
CampaignIDs	String/Array	No	Filter by specific campaign IDs (comma-separated or array)
Date_From	String	No	Start date for filtering (YYYY-MM-DD format)
Date_To	String	No	End date for filtering (YYYY-MM-DD format)
OrderField	String	No	Field to sort by (CampaignName, SendDate, etc.)
OrderType	String	No	Sort direction (ASC or DESC)
RecordsPerRequest	Integer	No	Number of records per page (0 for all, default: 0)
RecordsFrom	Integer	No	Offset for pagination (default: 0)
RetrieveStatistics	Boolean	No	Include campaign statistics (default: true)
RetrieveTags	Boolean	No	Include campaign tags (default: false)
Tags	String	No	Comma-separated tag IDs to filter by
SplitABTestStatistics	Boolean	No	Include A/B split test statistics (default: false)
ExcludeColumns	Array	No	Column names to exclude from SELECT for performance
Include_AutoResend	Boolean	No	Include auto-resend campaigns (default: false)
IncludeTotalRecipients	Boolean	No	Include aggregate sums of TotalRecipients, TotalSent, TotalFailed (default: false)

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "campaigns.get",
    "SessionID": "your-session-id",
    "CampaignStatus": "Sent",
    "Date_From": "2025-01-01",
    "Date_To": "2025-12-31",
    "RecordsPerRequest": 50,
    "RecordsFrom": 0,
    "OrderField": "SendDate",
    "OrderType": "DESC",
    "RetrieveStatistics": true
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "ErrorText": "",
  "Campaigns": [
    {
      "CampaignID": 12345,
      "CampaignName": "Summer Sale 2025",
      "CampaignStatus": "Sent",
      "SendDate": "2025-06-15",
      "TotalRecipients": 10000,
      "TotalSent": 9950,
      "TotalOpens": 3500,
      "UniqueOpens": 2100
    }
  ],
  "TotalCampaigns": 125
}

Error Response

{
  "Success": false,
  "ErrorCode": 0
}

Error Codes

0: Success

Get Tags List

POST /api.php (legacy)

API Usage Notes

• Authentication required: User API Key
• Legacy endpoint access via /api.php only (no v1 REST alias configured)

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: tags.get
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "tags.get",
    "SessionID": "your-session-id"
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "ErrorText": "",
  "TotalTagCount": 5,
  "Tags": [
    {
      "TagID": 1,
      "Tag": "newsletter",
      "RelOwnerUserID": 123
    },
    {
      "TagID": 2,
      "Tag": "promotion",
      "RelOwnerUserID": 123
    }
  ]
}

Error Response

{
  "Success": false,
  "ErrorCode": 0
}

Error Codes

0: Success

Create a Tag

POST /api.php (legacy)

API Usage Notes

• Authentication required: User API Key
• Legacy endpoint access via /api.php only (no v1 REST alias configured)

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: tag.create
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
Tag	String	Yes	Tag name (letters, numbers, spaces, hyphens, underscores only)

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "tag.create",
    "SessionID": "your-session-id",
    "Tag": "summer-campaign"
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "ErrorText": "",
  "TagID": 15
}

Error Response

{
  "Success": false,
  "ErrorCode": 2
}

Error Codes

0: Success
1: Missing required parameter (Tag)
2: Tag already exists in the system
3: Invalid tag format (only letters, numbers, spaces, hyphens and underscores allowed)
4: Tag cannot be empty after trimming whitespace

Update a Tag

POST /api.php (legacy)

API Usage Notes

• Authentication required: User API Key
• Legacy endpoint access via /api.php only (no v1 REST alias configured)

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: tag.update
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
TagID	Integer	Yes	ID of the tag to update
Tag	String	Yes	New tag name (letters, numbers, spaces, hyphens, underscores only)

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "tag.update",
    "SessionID": "your-session-id",
    "TagID": 15,
    "Tag": "summer-promotion"
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "ErrorText": ""
}

Error Response

{
  "Success": false,
  "ErrorCode": [1, 2]
}

Error Codes

0: Success
1: Missing required parameter (TagID)
2: Missing required parameter (Tag)
3: Invalid tag format (only letters, numbers, spaces, hyphens and underscores allowed)
4: Tag cannot be empty after trimming whitespace

Delete Tags

POST /api.php (legacy)

API Usage Notes

• Authentication required: User API Key
• Legacy endpoint access via /api.php only (no v1 REST alias configured)

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: tags.delete
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
Tags	String	Yes	Comma-separated list of tag IDs to delete

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "tags.delete",
    "SessionID": "your-session-id",
    "Tags": "15,16,17"
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "ErrorText": ""
}

Error Response

{
  "Success": false,
  "ErrorCode": [1]
}

Error Codes

0: Success
1: Missing required parameter (Tags)

Assign Tag to Campaigns

POST /api.php (legacy)

API Usage Notes

• Authentication required: User API Key
• Required permissions: Campaigns.Get
• Legacy endpoint access via /api.php only (no v1 REST alias configured)

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: tag.assigntocampaigns
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
TagID	Integer	Yes	ID of the tag to assign
CampaignIDs	String	Yes	Comma-separated list of campaign IDs

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "tag.assigntocampaigns",
    "SessionID": "your-session-id",
    "TagID": 15,
    "CampaignIDs": "100,101,102"
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "ErrorText": ""
}

Error Response

{
  "Success": false,
  "ErrorCode": [1, 2]
}

Error Codes

0: Success
1: Missing required parameter (TagID)
2: Missing required parameter (CampaignIDs)

Unassign Tag from Campaigns

POST /api.php (legacy)

API Usage Notes

• Authentication required: User API Key
• Required permissions: Campaigns.Get
• Legacy endpoint access via /api.php only (no v1 REST alias configured)

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: tag.unassignfromcampaigns
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
TagID	Integer	Yes	ID of the tag to unassign
CampaignIDs	String	Yes	Comma-separated list of campaign IDs

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "tag.unassignfromcampaigns",
    "SessionID": "your-session-id",
    "TagID": 15,
    "CampaignIDs": "100,101,102"
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "ErrorText": ""
}

Error Response

{
  "Success": false,
  "ErrorCode": [1, 2]
}

Error Codes

0: Success
1: Missing required parameter (TagID)
2: Missing required parameter (CampaignIDs)

Create a Split Test

POST /api.php (legacy)

API Usage Notes

• Authentication required: User API Key
• Required permissions: Campaign.Create
• Legacy endpoint access via /api.php only (no v1 REST alias configured)

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: splittest.create
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
CampaignID	Integer	Yes	ID of the campaign to create split test for
TestSize	Integer	Yes	Percentage of recipients to include in test (e.g., 20 for 20%)
TestDuration	Integer	Yes	Duration of the test in hours before sending to remaining recipients
Winner	String	Yes	Winner selection criteria for the split test

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "splittest.create",
    "SessionID": "your-session-id",
    "CampaignID": 12345,
    "TestSize": 20,
    "TestDuration": 24,
    "Winner": "highest_open_rate"
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "SplitTestID": 567
}

Error Response

{
  "Success": false,
  "ErrorCode": [1, 2]
}

Error Codes

0: Success
1: Missing required parameter (CampaignID)
2: Missing required parameter (TestSize)
4: Missing required parameter (TestDuration)
5: Missing required parameter (Winner)
6: Campaign not found or doesn't belong to user

Retry Failed Recipients

POST /api/v1/admin.campaign.retryfailed

API Usage Notes

• Authentication required: Admin API Key
• Rate limit: 100 requests per 60 seconds
• Legacy endpoint access via /api.php is also supported

Retries failed recipients for campaigns with status "Sent" or "Failed". This endpoint resets failed queue entries to Pending, creates new delivery batches, sets the campaign to "Sending" status, and pushes it to RabbitMQ for delivery workers to process.

Important: This endpoint bypasses the campaign picker and handles batch creation + RabbitMQ publishing directly. This ensures only the original failed recipients are retried without re-inserting subscribers who joined target lists after the original send.

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: admin.campaign.retryfailed
SessionID	String	No	Session ID obtained from login
APIKey	String	No	API key for authentication
CampaignID	Integer	Yes	ID of the campaign to retry failed recipients for

Example Request

curl -X POST https://example.com/api/v1/admin.campaign.retryfailed \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "admin.campaign.retryfailed",
    "APIKey": "your-admin-api-key",
    "CampaignID": 4069
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "ErrorText": "",
  "RetriedCount": 150,
  "BatchesCreated": 1,
  "Message": "150 failed recipients queued for retry in 1 batch(es)."
}

Error Response

{
  "Success": false,
  "ErrorCode": 3,
  "ErrorText": "Campaign is not in Sent or Failed status. Only completed or failed campaigns can have their failed recipients retried."
}

Error Codes

0: Success
1: campaign_id parameter is required
2: Campaign not found
3: Campaign is not in Sent or Failed status
4: Queue table does not exist for this campaign
5: No failed recipients found for this campaign
6: Database error during retry operation