Get a campaign message
https://email.growthdept.ai/api/campaign-messages/{id}Rate limits
Scopes
campaigns:read
Operation id
get_campaign_message The same operation as in Klaviyo's API. OpenAPI document
Path parameters
stringrequired
Query parameters
Pick values to add them to the request:
Pick values to add them to the request:
Pick values to add them to the request:
Pick values to add them to the request:
Headers
stringrequireddefault 2026-10-15
API revision, YYYY-MM-DD. This server implements 2026-10-15.
Responses
200Success
Response body
object
dataobjectrequired
data: 5 fields
typestringrequired
campaign-messageidstringrequired
attributesobjectrequired
attributes: 3 fields
createdstring (date-time)required
updatedstring (date-time)required
definitionobjectrequired
definition: 5 fields
namestringcan be null
statusstringcan be null
cancelleddraftscheduledsendingsenttracking_optionsobjectcan be null
tracking_options: 4 fields
is_add_utmbooleancan be null
is_tracking_clicksbooleancan be null
is_tracking_opensbooleancan be null
tracking_paramsarray of objectscan be null
One option: StaticMessageTrackingParam
typestring
staticnamestringrequired
valuestringrequired
One option: DynamicMessageTrackingParam
typestring
dynamicnamestringrequired
valuestringrequired
send_optionsobjectcan be null
send_options: 7 fields
send_timestring (date-time)can be null
send_timesobjectcan be null
send_strategystringcan be null
ab_send_time_testcontent_variationcontent_variation_local_timezonelocal_timezonepersonalized_send_time_optimizationsend_time_optimizationstaticthrottledvariation_per_second_throttledrecipient_percentageintegercan be null
throttling_typestringcan be null
nonethrottle-for-campaignsthrottle-for-campaigns-and-flowsthrottle-for-flowsthrottle_unitstringcan be null
hourminuteis_ignoring_unsubscribesbooleancan be null
ab_testobjectcan be null
ab_test: 3 fields
winner_metricstringcan be null
clicks_uniqueopens_uniqueplaced_orders_uniquewinner_percentageintegercan be null
winner_wait_hoursintegercan be null
relationshipsobject
relationships: 3 fields
campaignobject
campaign: 2 fields
dataobject
data: 2 fields
typestringrequired
campaignidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
campaign-audienceobject
campaign-audience: 2 fields
dataobject
data: 2 fields
typestringrequired
campaign-audienceidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
campaign-variationsobject
campaign-variations: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
campaign-variationidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
includedarray of objects
One option: OmniCampaignResponseObjectResource
typestringrequired
campaignidstringrequired
attributesobjectrequired
attributes: 3 fields
created_atstring (date-time)can be null
updated_atstring (date-time)can be null
definitionobjectrequired
definition: 6 fields
namestringcan be null
builderstringcan be null
archivedbooleancan be null
colorstringcan be null
descriptionstringcan be null
send_settingsobjectcan be null
send_settings: 5 fields
send_timezonestringcan be null
send_strategystringcan be null
content_variationcontent_variation_local_timezonepersonalized_send_time_optimizationsend_time_optimizationsimplethrottledtimezonevariationvariation_per_second_throttledvariation_send_timesend_passed_rltz_immediatelybooleancan be null
exit_condition_enabledbooleancan be null
exit_condition_conversion_metric_idstringcan be null
relationshipsobject
relationships: 3 fields
campaign-audiencesobject
campaign-audiences: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
campaign-audienceidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
campaign-messagesobject
campaign-messages: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
campaign-messageidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
tagsobject
tags: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
tagidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
One option: VariationResponseObjectResource
typestringrequired
campaign-variationidstringrequired
attributesobjectrequired
attributes: 3 fields
createdstring (date-time)required
updatedstring (date-time)required
definitionobjectrequired
definition: 2 fields
namestringcan be null
detailsone ofcan be null
One option: EmailChannelDetails
channelstring
emailtemplate_idstringcan be null
from_labelstring
from_emailstring
reply_to_emailstring
cc_emailstring
bcc_emailstring
subjectstring
preview_textstring
One option: SMSChannelDetails
channelstring
smstemplate_idstringcan be null
costnumbercan be null
mms_static_image_asset_idintegercan be null
shorten_linksbooleancan be null
include_contact_cardbooleancan be null
bodystring
add_org_prefixbooleancan be null
add_info_linkbooleancan be null
add_opt_out_languagebooleancan be null
mms_dynamic_image_templatestringcan be null
text_message_typestring
MMSRCSSMSmessage_hierarchyarray of objectscan be null
One option: MessageHierarchyRcsItem
messagestring
message_formatstring
RCSrich_contentobjectcan be null
rich_content: 3 fields
cardsarray of objectscan be null
suggestionsarray of objectscan be null
fileobjectcan be null
extraobjectcan be null
imageobjectcan be null
image: 3 fields
static_image_asset_idintegercan be null
dynamic_image_templatestringcan be null
rendered_asset_urlstringcan be null
One option: MessageHierarchySmsItem
messagestringrequired
message_formatstring
SMSextraobjectcan be null
imageone ofcan be null
One option: StaticSMSImage
dynamicbooleancan be null
falsestatic_image_asset_idintegerrequired
One option: DynamicSMSImage
dynamicboolean
truedynamic_image_templatestringrequired
mediaone ofcan be null
One option: MediaAsset
idstringrequired
company_idstringrequired
urlstringrequired
media_typestring
namestringrequired
file_sizeintegerrequired
thumbnail_urlstringcan be null
l10n_keystringcan be null
One option: MediaAssetReference
static_asset_idstringcan be null
dynamic_templatestringcan be null
thumbnailobjectcan be null
One option: PushChannelDetails
channelstring
pushtitlestring
bodystring
badgeboolean
badge_configstring
increment-oneset-countset-propertybadge_valuestring
sound_file_namestring
static_asset_idintegercan be null
soundboolean
open_actioninteger
dynamic_media_templatestring
kv_pairsobjectcan be null
push_typestring
silentstandardios_deep_linkstringcan be null
android_deep_linkstringcan be null
web_urlstringcan be null
content_availablebooleancan be null
send_to_inboxbooleancan be null
mutable_contentbooleancan be null
video_asset_idstringcan be null
action_buttonsarray of objectscan be null
action_buttons: 7 fields
labelstringrequired
action_typestringrequired
deep_linkdismissopen_appopen_urlurlstringcan be null
iconstringcan be null
custom_action_idstringcan be null
ios_deep_linkstringcan be null
android_deep_linkstringcan be null
push_platform_targetintegercan be null
send_to_primarybooleancan be null
One option: WhatsappChannelDetails
channelstring
whatsapptemplate_idstringcan be null
shorten_linksboolean
relationshipsobject
relationships: 3 fields
campaign-messageobject
campaign-message: 2 fields
dataobject
data: 2 fields
typestringrequired
campaign-messageidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
translationobject
translation: 2 fields
dataobject
data: 2 fields
typestringrequired
translationidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
imageobject
image: 2 fields
dataobject
data: 2 fields
typestringrequired
imageidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
linksobject
links: 1 field
selfstring (uri)required
metaobject
4XXClient error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject
See status codes for each code.
5XXServer error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject