SendDefinitions
Create, update, delete and query send definitions.
Table Specific Information
Select
Retrieve all send definitions:
SELECT * FROM SendDefinitions
Retrieve a specific send definition:
SELECT * FROM SendDefinitions WHERE DefinitionKey = '9955614b-02e7-4147-91a2-3f5f5fe9d679'
Retrieve all send definitions with Status as 'Active':
SELECT * FROM SendDefinitions WHERE Status = 'Active'
Insert
To create a send definition, you will need to specify at least the DefinitionKey, Name, SubscriptionsList and ContentCustomerKey column.
INSERT INTO SendDefinitions (DefinitionKey, Name, ContentCustomerKey, SubscriptionsList, OptionsCc, OptionsCreateJourney) VALUES ('TEST_Definition_Key', 'Test Definition Key', '76ad3572-abbc-4baa-b3fe-04c4364bf34a', 'All Subscribers', '[email protected]', true)
Update
To update a send definition, you will need to specify the DefinitionKey of the SendDefinition.
UPDATE SendDefinitions SET OptionsCc = '[email protected],[email protected]', OptionsBcc = '[email protected],[email protected]' WHERE DefinitionKey = 'TEST_Definition_Key'
Delete
Send definitions may be deleted by providing the Definition Key of the send definition and issuing a DELETE statement.
DELETE FROM SendDefinitions WHERE DefinitionKey = 'TEST_Definition_Key'
Columns
Name | Type | ReadOnly | References | Filters | Description |
DefinitionKey [KEY] | String | False | = |
Unique, user-generated key to access the definition object. | |
DefinitionId | String | True |
Unique Marketing Cloud object identifier. | ||
Classification | String | False |
Marketing Cloud external key of a sending classification defined in Email Studio Administration. Only transactional classifications are permitted. Default is default transactional. | ||
ContentCustomerKey | String | False |
Unique identifier of the content asset. | ||
CreatedDate | Datetime | True |
Date the definition was created. | ||
Description | String | False |
User-provided description of the send definition. | ||
Journey | Boolean | True |
Indicates whether the send definition is available in Journey Builder as a Transactional Send Journey. | ||
JourneyInteractionKey | String | True |
Unique ID of the Transactional Send Journey. | ||
ModifiedDate | Datetime | True |
Date and time the definition was most recently changed. | ||
Name | String | False |
Name of the definition. | ||
OptionsBcc | String | False |
Include BCC email addresses with every send. To dynamically BCC at send time, create a profile attribute and use the %%attribute%% syntax. | ||
OptionsCc | String | False |
Include CC email addresses with every send. To CC dynamically at send time, create a profile attribute and use the %%attribute%% syntax. | ||
OptionsTrackLinks | Boolean | False |
Wraps links for tracking and reporting. Default is true. | ||
OptionsCreateJourney | Boolean | False |
Defines the subscriber key or email address within a data extension. Required when defining a schema. | ||
RequestId | String | True |
The unique identifier of this request. | ||
Status | String | False | =,!= |
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. | |
SubscriptionsAutoAddSubscriber | Boolean | False |
Adds the recipient's email address and contact key as a subscriber key to subscriptions.list. Default is true. | ||
SubscriptionsDataExtension | String | False |
Marketing Cloud external key of the triggered send data extension. Each request inserts as a new row in the data extension. | ||
SubscriptionsList | String | False |
Marketing Cloud external key of the list or all subscribers. Contains the subscriber keys and profile attributes. | ||
SubscriptionsUpdateSubscriber | Boolean | False |
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. |