POST /messaging/v1/messageDefinitionSends/{triggeredSendDefinitionId}/send
Sends transactional email using Marketing Cloud's triggered send functionality. In order to use this service, configure a triggered send definition in Email Studio. This documentation applies only to triggered sends that are managed in Email Studio. To use the transactional messaging REST API, review Transactional Messaging API.
Name | Type | Description | |
---|---|---|---|
ObjectID | GUID | Required | ID of the entry event send definition that comes from the response when creating a TriggeredSendDefinition. Either this or the external key is required. |
key | string | Required | External key of the entry event send definition. Either this or the ObjectID is required. |
Name | Type | Description | |
---|---|---|---|
From | object | Object containing email address and name of sender. | |
From.Address | string | Email address that will show as the sender. | |
From.Name | string | Name of the sender. | |
To | object | Required | Object requiring email address and optional subscriber parameters passed in at send time. |
To.Address | string | Required | Email address of the message recipient. |
To.SubscriberKey | string | Required | Unique identifier defined for the message recipient. |
To.ContactAttributes | object | The profile attributes setup determines the attributes that can be passed in. | |
To.ContactAttributes.SubscriberAttributes | object | Name and value pairs for subscriber attributes defined for the message. | |
Options | object | Object used to specify asynchronous or synchronous. If not specified, defaults to asynchronous. | |
Options.RequestType | string | Valid values ASYNC and SYNC. Default value when not defined is ASYNC. Determines if the request is processed asychronously. |
Example Asynchronous Request Using Send ID
Example Asynchronous Request Using Customer Key
Example Synchronous Request Using Send ID
Example Synchronous Request Using Customer Key
Example Response (Asynchronous)
Queued status for an asynchronous request means that the request is accepted for processing. Refer to Get Email Delivery Details for the final message request status.
Error Response (Synchronous)
Error Response