PATCH /messaging/v1/email/definitions/{definitionKey}

Overview

Updates a specific message definition.

URL Parameters

NameTypeDescription
definitionKeystringRequiredUnique identifier of the definition.

JSON Parameters

NameTypeDescription
namestringRequiredName of the definition. Must be unique.
content.customerKeystringRequiredUnique identifier of the content asset.
statusstringOperational state of the definition: active, inactive, or deleted. A message sent to an active definition is processed and delivered. A message sent to an inactive definition isn’t processed or delivered. Instead, the message is queued for later processing for up to three days.
descriptionstringUser-provided description of the send definition.
classificationstringMarketing Cloud external key of a sending classification defined in Email Studio Administration. Only transactional classifications are permitted. Default is default transactional.
subscriptions.liststringRequiredMarketing Cloud external key of the list or all subscribers. Contains the subscriber keys and profile attributes.
subscriptions.dataExtensionstringMarketing Cloud external key of the triggered send data extension. Each request inserts as a new row in the data extension.
subscriptions.autoAddSubscriberbooleanAdds the recipient’s email address and contact key as a subscriber key to subscriptions.list. Default is true.
subscriptions.updateSubscriberbooleanUpdates the recipient’s contact key as a subscriber key with the provided email address and profile attributes to subscriptions.list. Default is true.
options.trackLinksbooleanWraps links for tracking and reporting. Default is true.
options.ccarrayInclude CC email addresses with every send. To CC dynamically at send time, create a profile attribute and use the %%attribute%% syntax.
options.bccarrayInclude BCC email addresses with every send. To BCC dynamically at send time, create a profile attribute and use the %%attribute%% syntax.
options.createJourneybooleanA value of true makes the send definition available in Journey Builder as a Transactional Send Journey. After the definition is tied to a Transactional Send Journey, the definition remains part of Journey Builder. You can’t unlink a journey from a definition without recreating the transactional send definition.

Usage

Use this call to update a specific message definition.

If you want your existing definition to appear as a Transactional Send Journey, update the definition using the “createJourney” option.

Example Request

Example Response

HTTP Responses

ResponseReason
200 OKSend definition is updated. Review example response.
400 Bad RequestInvalid request
403 ForbiddenFailed to pass authorization.
500 Server ErrorInternal error