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

Gets send definition configuration details for a definition key. You can only retrieve activated Transactional Send Journeys created in Journey Builder.

URL Parameters 

NameTypeDescription
definitionKeystringRequiredUnique identifier of the definition.

Responses 

StatusNameTypeDescription
200  Definition retrieved. Review example response.
 requestIdstringThe unique identifier of this request.
 namestringName of the definition.
 definitionKeystringUnique, user-generated key to access the definition object.
 definitionIdstringA unique object identifier.
 descriptionstringUser-provided description of the send definition.
 classificationstringThe external key of a sending classification defined in Email Studio Administration. Only transactional classifications are permitted. Default is default transactional.
 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.
 createdDatestringDate the definition was created.
 modifiedDatestringDate and time the definition was most recently changed.
 content.customerKeystringUnique identifier of the content asset.
 subscriptions.dataExtensionstringThe external key of the triggered send data extension. Each request inserts as a new row in the data extension.
 subscriptions.liststringThe external key of the list or all subscribers. Contains the subscriber keys and profile attributes.
 subscriptions.autoAddSubscriberbooleanAdds the recipient’s email address and contact key as a subscriber key to subscriptions.list. Default is true.
 subscriptions.updateSubscriberbooleanFor 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.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 dynamically BCC at send time, create a profile attribute and use the %%attribute%% syntax.
 journeybooleanIndicates whether the send definition is available in Journey Builder as a Transactional Send Journey.
 journey.interactionKeystringUnique ID of the Transactional Send Journey.

Usage 

Example Request 

Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
GET /messaging/v1/email/definitions/2FA_order_accounts
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

Example Response 

HTTP/1.1 200 Success
{
  "requestId": "1f1e8755-819b-424d-a914-e066b5ba20f8",
  "name": "My Unique Definition Name",
  "definitionKey": "2FA_order_accounts",
  "definitionId": "c13a2f02-2e02-e911-80e9-1402ec6b9711",
  "description": "description updated",
  "classification": "Default Transactional",
  "status": "Active",
  "createdDate": "2018-12-17T13:00:00",
  "modifiedDate": "2018-12-31T09:52:00",
  "content": {
    "customerKey": "bebf8650-137a-494c-8727-cdeb32534961"
  },
  "subscriptions": {
    "dataExtension": "test-de",
    "list": "test-list"
    "autoAddSubscriber": true,
    "updateSubscriber": true
  },
  "options": {
    "trackLinks": true
  },
  "journey": {
    "interactionKey": "81bcd4b9-10b0-47c2-be8e-fce576c8110c"
  }
}

HTTP Responses 

ResponseReason
200 SuccessDefinition retrieved. Review example response.
400 Bad RequestInvalid request
403 ForbiddenFailed to pass authorization.
404 Not FoundDefinition key doesn’t exist for this MID
500 Server ErrorInternal error