CampaignMessages
Returns all message records associated with a campaign, including message content, type, and delivery details.
Select
The add-in uses the Klaviyo API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the add-in.
- Id supports the following operator: =
- CampaignId supports the following operator: =
SELECT * FROM CampaignMessages Where Id = 'campaignMessageId'
SELECT * FROM CampaignMessages Where CampaignId = 'CampaignId'
Update
Klaviyo allows updating a Campaign Message
Note: When updating a Campaign Message, the channel where the message comes from must always be specified.
UPDATE CampaignMessages SET DefinitionLabel = 'Updated label', channel='email' Where ID = '01JP31YSK8N1ET7K47SRGQM7PK'
Columns
| Name | Type | ReadOnly | References | Description | |
| Id [KEY] | String | True |
The unique identifier for the campaign message. Use this value to reference or filter message records within a campaign. | ||
| CampaignId | String | False |
Campaigns.Id |
The unique identifier of the campaign associated with this message. Use this value to retrieve all messages belonging to a specific campaign. | |
| CreatedAt | Datetime | True |
The date and time when the message was created in Klaviyo. | ||
| UpdatedAt | Datetime | True |
The date and time when the message was last modified or updated. | ||
| Channel | String | False |
Specifies the communication channel used to deliver the message, such as email, SMS, or push notification. | ||
| ContentBCCEmail | String | False |
An optional BCC email address to receive a blind copy of the message when it is sent. | ||
| ContentCCEmail | String | False |
An optional CC email address to receive a carbon copy of the message when it is sent. | ||
| ContentFromEmail | String | False |
The sender email address used for this message. | ||
| ContentFromLabel | String | False |
The display name associated with the sender email address shown to recipients. | ||
| ContentPreviewText | String | False |
The preview text or snippet displayed in the recipient's inbox before opening the message. | ||
| ContentReplyToEmail | String | False |
An optional reply-to email address where responses to this message are sent. | ||
| ContentSubject | String | False |
The subject line of the message displayed to recipients. | ||
| DefinitionLabel | String | False |
The internal name or label assigned to the message definition. | ||
| ContentMediaUrl | String | False |
The URL of any media asset, such as an image or video, included in the message content. | ||
| DefinitionNotificationType | String | False |
Specifies the type of notification or message being sent, such as campaign or transactional. | ||
| DefinitionContentTitle | String | False |
The title or heading displayed within the message content. | ||
| DefinitionContentBody | String | False |
The main body content of the message, including text and dynamic placeholders. | ||
| DefinitionContentDynamicImage | String | False |
Specifies a dynamic image used in the message, such as a personalized image in a push notification. | ||
| RenderOptionsShortenLinks | Boolean | False |
Indicates whether URLs in the message content should be automatically shortened when rendered. | ||
| RenderOptionsAddOrgPrefix | Boolean | False |
Indicates whether to automatically add the organization prefix to links included in the message content. | ||
| RenderOptionsAddInfoLink | Boolean | False |
Indicates whether to include an informational link, such as a help or company link, in the rendered message. | ||
| RenderOptionsAddOptOutLanguage | Boolean | False |
Indicates whether opt-out or unsubscribe language should be automatically included in the message footer. | ||
| SendTimesDatetime | Datetime | False |
The scheduled date and time for sending the message to recipients. | ||
| SendTimesIsLocal | Boolean | False |
Indicates whether the scheduled send time should be interpreted as the recipient's local time. |