Skip to main content
GET
Get campaign by ID
📧 Campaign Details Include:
  • Complete campaign configuration
  • Content and design information
  • Targeting and segmentation rules
  • Schedule and timezone settings
🔍 Use Cases:
  • Preview campaign before sending
  • Check campaign status
  • Review targeting settings
  • Access campaign for editing

Authorizations

X-Team-ApiKey
string
header
required

Team API key for authentication. Find your API key in SendX Settings → Team API Key.

Example:

Path Parameters

identifier
string
required

Campaign identifier

  • campaign_IMBoxK2iB5sUdgiNOjqAMA
Pattern: ^(campaign_)?[a-zA-Z0-9]{22}$

Response

✅ Campaign retrieved successfully

name
string
required

Internal campaign name

Example:

"Summer Sale 2024"

subject
string
required

Email subject line

Example:

"🌞 Summer Sale - 50% Off Everything!"

sender
string
required

Sender id

Example:

"sender_4vK3WFhMgvOwUNyaL4QxCD"

scheduleType
integer
default:0
required

Campaign scheduling type.

Values:

  • 0 - Schedule later
  • 1 - Send Now
scheduleCondition
string
required

datetime for scheduled campaigns (required if scheduleType=1)

Example:

"2024-12-30"

timezone
string
required

Campaign timezone

Example:

"America/New_York"

includedLists
string[]
required

Included list IDs with prefix

Pattern: ^list_[a-zA-Z0-9]{22}$
Example:
excludedLists
string[]
required

Excluded list IDs with prefix

Pattern: ^list_[a-zA-Z0-9]{22}$
Example:
id
string

Unique ID for the campaign

Example:

"campaign_6h8DnYrHt4KktCnG8PDO5Z"

preheader
string

Email preview text

Example:

"Limited time offer - Shop now!"

htmlContent
string

HTML email content

textContent
string

Plain text email content

status
integer

Campaign status.

Values:

  • 0 - Draft
  • 1 - Scheduled
  • 2 - Sending
  • 3 - Sent
  • 4 - Quarantined
  • 5 - Evaluating
  • 6 - Evaluation Failed
  • 7 - Warming Up
isArchived
boolean

Whether the campaign is archived

Example:

false

campaignScreenshotUrl
string

URL to the campaign screenshot

Example:

"https://cdn.sendx.io/campaigns/screenshot_abc123.png"

timeCondition
string

Time-related condition for the campaign

Example:

"9:00 AM"

smartSend
boolean

Timezone for the scheduled send

Example:

"America/New_York"

sendInContactsTimezone
boolean

Send at specified time in each contact's timezone

Example:

true

preferredTimeCondition
string

Preferred time condition, in case of smartSend and sendInContactTimeZone

Example:

"10:00 AM"

preferredTimezone
string

Preferred timezone for smart send optimization

Example:

"America/Los_Angeles"

strategy
string

Campaign delivery strategy

Example:

"Batch Sending"

includedSegments
string[]

Included segment IDs

Pattern: ^segment_[a-zA-Z0-9]{22}$
Example:
includedTags
string[]

Included tag IDs with prefix

Pattern: ^tag_[a-zA-Z0-9]{22}$
Example:
excludedSegments
string[]

Excluded segment IDs

Pattern: ^segment_[a-zA-Z0-9]{22}$
Example:
excludedTags
string[]

Excluded tag IDs with prefix

Pattern: ^tag_[a-zA-Z0-9]{22}$
Example:
created
string<date-time>
updated
string<date-time>