POST /messaging/v1/messageDefinitionSends/{triggeredSendDefinitionId}/send

Overview

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.

URL Parameters

NameTypeDescription
ObjectIDGUIDRequiredID of the entry event send definition that comes from the response when creating a TriggeredSendDefinition. Either this or the external key is required.
keystringRequiredExternal key of the entry event send definition. Either this or the ObjectID is required.

JSON Parameters

NameTypeDescription
FromobjectObject containing email address and name of sender.
From.AddressstringEmail address that will show as the sender.
From.NamestringName of the sender.
ToobjectRequiredObject requiring email address and optional subscriber parameters passed in at send time.
To.AddressstringRequiredEmail address of the message recipient.
To.SubscriberKeystringRequiredUnique identifier defined for the message recipient.
To.ContactAttributesobjectThe profile attributes setup determines the attributes that can be passed in.
To.ContactAttributes.SubscriberAttributesobjectName and value pairs for subscriber attributes defined for the message.
OptionsobjectObject used to specify asynchronous or synchronous. If not specified, defaults to asynchronous.
Options.RequestTypestringValid values ASYNC and SYNC. Default value when not defined is ASYNC. Determines if the request is processed asychronously.

Usage

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