email-campaigns-v2

Create a new email campaign

Campaign starts in 'draft' status. Use the send endpoint to trigger.

post/v2/email/campaigns

Request

  • Base URL: https://api.tracklysms.com/api
  • URL: https://api.tracklysms.com/api/v2/email/campaigns
  • Auth: API key in header X-Api-Key

Request body

fromEmailstring required

Sender email address

fromNamestring required

Sender display name

listIdsstring[]

Target list IDs

namestring required

Campaign name

replyTostring

Reply-To address

scheduledAtstring date-time

Scheduled send time (ISO 8601)

segmentIdsstring[]

Target segment IDs

sendTypestring

Send type: immediate, scheduled

subjectstring required

Email subject line

templateIdstring

Email template ID

Response

Campaign created

abTestobject

A/B test config

complianceStatusstring

Compliance check status

createdAtstring date-time

Creation timestamp

fromEmailstring

Sender email

fromNamestring

Sender name

idstring

Campaign ID

listIdsstring[]

Target list IDs

namestring

Campaign name

replyTostring

Reply-To address

scheduledAtstring date-time

Scheduled send time

segmentIdsstring[]

Target segment IDs

sendTypestring

Send type

statsobject

Campaign statistics

statusstring

Campaign status

subjectstring

Subject line

templateIdstring

Template ID

updatedAtstring date-time

Last update timestamp

Changes

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