Create a campaign message
https://email.growthdept.ai/api/campaign-messagesThe request body can be up to 5 MB.
Rate limits
Scopes
campaigns:write
Operation id
create_campaign_message The same operation as in Klaviyo's API. OpenAPI document
Query parameters
Pick values to add them to the request:
Body
Send application/vnd.api+json or application/json.
object
dataobjectrequired
data: 5 fields
typestringrequired
campaign-messageidstring
attributesobjectrequired
attributes: 2 fields
definitionobjectrequired
definition: 5 fields
namestring
statusstring
tracking_optionsobject
tracking_options: 4 fields
is_add_utmbooleancan be null
is_tracking_clicksbooleancan be null
is_tracking_opensbooleancan be null
tracking_paramsarray of objects
tracking_params: 3 fields
typestring
namestringrequired
valuestringrequired
send_optionsobject
send_options: 7 fields
send_timestring
send_timesobject
send_strategystring
recipient_percentageinteger
throttling_typestring
throttle_unitstring
is_ignoring_unsubscribesbooleancan be null
ab_testobject
ab_test: 4 fields
winner_metricstring
winner_percentageinteger
winner_wait_hoursinteger
track_links_separatelybooleancan be null
variationsarray of objects
variations: 1 field
definitionobjectrequired
definition: 2 fields
namestring
detailsobject
relationshipsobject
relationships: 2 fields
campaignobjectrequired
campaign: 1 field
dataobjectrequired
data: 2 fields
typestringrequired
campaignidstringrequired
campaign-audienceobjectrequired
campaign-audience: 1 field
dataobjectrequired
data: 2 fields
typestringrequired
campaign-audienceidstringrequired
metaobject
Edit the example. The code samples use what you type here.
Headers
stringrequireddefault 2026-10-15
API revision, YYYY-MM-DD. This server implements 2026-10-15.
Responses
201Success
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
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