Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 1.84 KB

File metadata and controls

56 lines (40 loc) · 1.84 KB

Campaign

Campaign schema

Properties

Name Type Description Notes
id Integer [optional] [readonly]
campaignHash String [optional] [readonly]
status StatusEnum Status of the campaign [optional]
thumbnail String Thumbnail of the campaign [optional]
channel ChannelEnum Channel of the campaign [optional]
internalName String Internal name of the campaign [optional]
listId Integer [optional] [readonly]
title String Subject of the campaign [optional]
createdBy Integer [optional] [readonly]
groupId Integer [optional] [readonly]
created OffsetDateTime [optional]
updated OffsetDateTime [optional]
startDate OffsetDateTime [optional]
endDate OffsetDateTime [optional]
scheduleDate CampaignScheduleDate [optional]
processedMessages Integer Total number of processed messages [optional]
automationId Integer The automation id of the campaign [optional]

Enum: StatusEnum

Name Value
DRAFT "draft"
CANCELED "canceled"
QUEUED "queued"
PAUSED "paused"
SENDING "sending"
SENT "sent"

Enum: ChannelEnum

Name Value
EMAIL "email"
PUSH "push"
SMS "sms"
SMART_SMS "smart_sms"
VOICE "voice"
WEB_PUSH "web_push"