Back to KlaviyoGet Campaign Message
Returns a specific message based on a required id.
Rate limits:
Burst: 10/s
Steady: 150/m
\n\nScopes:\nCampaigns Read
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: string
description: The message ID to be retrieved
fields[campaign-message]:
type: array
items:
type: string
enum:
- label
- channel
- content
- content.subject
- content.preview_text
- content.from_email
- content.from_label
- content.template_id
- content.template_name
- send_times
- created_at
- updated_at
- campaign_id
description: >-
For more information please visit
https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
revision:
type: string
default: '2023-02-22'
description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
required:
- id
- revision
title: Parameters
Output
type: object
required:
- data
properties:
data:
type: object
required:
- type
- id
- attributes
- links
properties:
type:
type: string
enum:
- campaign-message
id:
type: string
description: The message ID
attributes:
type: object
required:
- label
- channel
- content
- campaign_id
properties:
label:
type: string
description: The label or name on the message
channel:
type: string
description: The channel the message is to be sent on
content:
type: object
properties:
subject:
type: string
example: Buy our product!
description: The subject of the message
preview_text:
type: string
example: My preview text
description: Preview text associated with the message
from_email:
type: string
example:
[email protected]
description: The email the message should be sent from
from_label:
type: string
example: My Company
description: The label associated with the from_email
template_id:
type: string
example: RipRmi
description: The ID of the template associated to the message
template_name:
type: string
example: My email template
description: The name of the template associated to the message
send_times:
type: array
description: >-
The list of appropriate Send Time Sub-objects associated with the
message
items:
type: object
required:
- datetime
- is_local
properties:
datetime:
type: string
format: date-time
example: '2022-11-08T00:00:00'
description: The datetime that the message is to be sent
is_local:
type: boolean
description: >-
Whether that datetime is to be a local datetime for the
recipient
created_at:
type: string
format: date-time
example: '2022-11-08T00:00:00'
description: The datetime when the message was created
updated_at:
type: string
format: date-time
example: '2022-11-08T00:00:00'
description: The datetime when the message was last updated
campaign_id:
type: string
description: The parent campaign id
links:
type: object
required:
- self
properties:
self:
type: string
format: uri