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

Updates a specific message definition.

Name	Type		Description
definitionKey	string	Required	Unique identifier of the definition.

Name	Type		Description
name	string	Required	Name of the definition. Must be unique.
content.customerKey	string	Required	Unique identifier of the content asset.
status	string		Operational 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.
description	string		User-provided description of the send definition.
classification	string		The external key of a sending classification defined in Email Studio Administration. Only transactional classifications are permitted. Default is default transactional.
subscriptions.list	string	Required	The external key of the list or all subscribers. Contains the subscriber keys and profile attributes.
subscriptions.dataExtension	string		The external key of the triggered send data extension. Each request inserts as a new row in the data extension.
subscriptions.autoAddSubscriber	boolean		Adds the recipient’s email address and contact key as a subscriber key to subscriptions.list. Default is true.
subscriptions.updateSubscriber	boolean		Updates the recipient’s contact key as a subscriber key with the provided email address and profile attributes to subscriptions.list. Default is true.
options.trackLinks	boolean		Wraps links for tracking and reporting. Default is true.
options.cc	array		Include CC email addresses with every send. To CC dynamically at send time, create a profile attribute and use the %%attribute%% syntax.
options.bcc	array		Include BCC email addresses with every send. To BCC dynamically at send time, create a profile attribute and use the %%attribute%% syntax.
options.createJourney	boolean		A 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.

Status	Name	Type	Description
200			Send definition is updated. Review example response.
	requestId	string	The unique identifier of this request.
	name	string	Name of the definition.
	definitionKey	string	Unique, user-generated key to access the definition object.
	definitionId	string	A unique object ID.
	description	string	User-provided description of the send definition.
	classification	string	The external key of a sending classification defined in Email Studio Administration. Only transactional classifications are permitted. Default is default transactional.
	status	string	Operational 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.
	createdDate	string	Date the definition was created.
	modifiedDate	string	Date and time the definition was most recently changed.
	content.customerKey	string	Unique identifier of the content asset.
	subscriptions.dataExtension	string	The external key of the triggered send data extension. Each request inserts as a new row in the data extension.
	subscriptions.list	string	The external key of the list or all subscribers. Contains the subscriber keys and profile attributes.
	subscriptions.autoAddSubscriber	boolean	Adds the recipient’s email address and contact key as a subscriber key to subscriptions.list. Default is true.
	subscriptions.updateSubscriber	boolean	For email only: Updates the recipient’s contact key as a subscriber key with the provided email address and profile attributes to subscriptions.list. Default is true.
	options.trackLinks	boolean	Wraps links for tracking and reporting. Default is true.

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.

Response	Reason
200 OK	Send definition is updated. Review example response.
400 Bad Request	Invalid request
403 Forbidden	Failed to pass authorization.
500 Server Error	Internal error