Omnisend Campaigns API is one of 15 APIs that Omnisend publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include Campaigns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a JSON-LD context, and 2 JSON Schemas.
This API exposes
14 operations
across 10 paths,
and defines 66 schemas.
It is described by OpenAPI 3.0.0, at version 2026-preview.
Requests are made against a single base URL, https://api.omnisend.com/api.
The identity and technical contract details declared by the specification.
ABTest
object
A/B test configuration. Variants are keyed by "a" and "b"; the parent campaign's content field is omitted because variants carry their own content. result is p…
3 properties
ABTestDecisionTime
object
Decision time before selecting a winner. Same shape as booster delay.
2 properties
ABTestResult
object
A/B test result (read-only).
3 properties
ABTestSettings
object
A/B test settings.
3 properties
ABTestVariant
object
A/B test variant. Email-specific fields live under content.email.
2 properties
ABTestVariantContent
object
A/B test variant content grouped by channel.
1 property
ABTestVariantEmail
object
Email content fields for an A/B test variant.
6 properties
ABTestVariants
object
A/B test variants object with keys "a" and "b".
2 properties
Audience
object
Campaign audience
2 properties
BoosterDelay
object
Delay between the parent campaign send and the booster send.
2 properties
BoosterSettings
object
Booster-specific settings.
3 properties
2 required
Campaign
object
Campaign resource. When type is booster, the boosterSettings field is populated, identifying the parent campaign and the conditions under which the booster tar…
16 properties
CampaignChannel
string
Campaign message channel
CampaignStatus
string
Campaign status
CampaignType
string
Campaign type
CampaignsResponse
object
Paginated list of campaigns
2 properties
Content
object
Campaign content
2 properties
CreateABTest
object
A/B test configuration for campaign creation.
2 properties
2 required
CreateABTestDecisionTime
object
Decision time before selecting a winner. Same shape as booster delay.
2 properties
2 required
CreateABTestSettings
object
A/B test settings for campaign creation.
3 properties
1 required
CreateABTestVariant
object
A/B test variant for creation. Email fields live under content.email.
1 property
1 required
CreateABTestVariantContent
object
Variant content grouped by channel for creation.
1 property
1 required
CreateABTestVariantEmail
object
Email content fields for an A/B test variant creation.
6 properties
2 required
CreateABTestVariants
object
A/B test variants object with keys "a" and "b".
2 properties
2 required
CreateBoosterDelay
object
Delay settings for booster campaign
2 properties
2 required
CreateBoosterSettings
object
Booster settings for campaign creation
3 properties
2 required
CreateCampaignRequest
object
Campaign creation request
9 properties
2 required
CreateContent
object
Campaign content for creation
2 properties
CreateEmail
object
Email content for campaign creation
6 properties
1 required
CreateSMS
object
SMS content for campaign creation
4 properties
2 required
CreateSMSCompliance
object
SMS compliance text settings for creation
2 properties
2 required
CreateSendingSettings
object
Sending settings for campaign creation
4 properties
CursorsResponse
object
Cursor pointers for paginating forward and backward through results
2 properties
Email
object
Email content
6 properties
FieldError
object
A single field validation failure within a validation error response.
3 properties
PagingResponse
object
Cursor-based pagination metadata
3 properties
Problem
object
Standard error response returned by all API endpoints on failure.
5 properties
RateLimitProblem
object
Error response returned when the rate limit is exceeded. Use the retryAfter value to know when it is safe to retry the request.
6 properties
SMS
object
SMS message content
5 properties
SMSCompliance
object
SMS compliance text settings
2 properties
SelectABTestWinnerRequest
object
Winning variant selection for a manual A/B test winner pick
1 property
1 required
SendTestEmailRequest
object
Request payload for sending a campaign test email.
1 property
1 required
SendingSettings
object
Campaign sending settings
4 properties
UTMResponse
object
UTM settings for a campaign. Exactly one of tags (regular campaign) or variants (A/B test campaign) is present.
2 properties
UTMTags
object
UTM tag values. Providing empty values resets them to defaults.
3 properties
UTMUpdate
object
UTM update request. Provide tags for regular campaigns or variants for A/B test campaigns. Exactly one must be present; providing both is a validation error.
2 properties
UTMVariant
object
UTM variant entry for an A/B test campaign.
2 properties
UTMVariantTags
object
UTM variant tags for an A/B update request. Providing empty values resets them to defaults.
3 properties
UTMVariants
object
UTM variants for an A/B test campaign.
2 properties
UTMVariantsUpdate
object
UTM variant update entries for an A/B test campaign.
2 properties
UpdateABTest
object
A/B test update block. Full replacement semantics.
2 properties
UpdateABTestDecisionTime
object
Decision time for A/B test winner selection
2 properties
2 required
UpdateABTestSettings
object
A/B test settings for update
3 properties
UpdateABTestVariant
object
Content fields for a single A/B variant. Email fields live under content.email.
1 property
UpdateABTestVariantContent
object
Variant content grouped by channel for update.
1 property
UpdateABTestVariantEmail
object
Email content fields for an A/B test variant update.
5 properties
UpdateABTestVariants
object
Per-variant content for A/B test update
2 properties
UpdateBoosterDelay
object
Delay settings for booster campaign
2 properties
2 required
UpdateBoosterSettings
object
Booster-specific settings for campaign update.
2 properties
UpdateCampaignRequest
object
Campaign update request
7 properties
UpdateContent
object
Campaign content for update
2 properties
UpdateEmail
object
Email content for campaign update
5 properties
UpdateSMS
object
SMS content for campaign update
4 properties
UpdateSMSCompliance
object
SMS compliance text settings for update
2 properties
UpdateSendingSettings
object
Sending settings for campaign update. Full object replacement - provide all fields applicable to the selected strategy (for personalized: strategy, scheduledAt…
4 properties
ValidationProblem
object
Error response returned when the request contains invalid input. The errors array lists every field that failed validation.
6 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Omnisend publishes across the network.
