Send Finalized Transactional Mail

Rate Limit

For Optimove's general API rate limit, see the Understanding API Rate Limits reference.

Notes

• BrandID – The ID of your transactional account (if you don't have this ID, contact your CSM).
• Type – The MIME type of the attachment (e.g., "text/plain", "text/html", "application/pdf").
• UniqueMessageID enforces idempotency. This is limited to 254 characters.
• IsSuccess – true is returned if the send was successful. Otherwise, false.
• SendID – If the send failed, null is returned.
• Error – A description of the error. When the send succeeds, null is returned. If the specified template is invalid, Error contains "Invalid template". If idempotency is enforced a 409 error code shows with the following message "Request for this UniqueMessageID has succeeded before".
• Each call may include a maximum of 200 email recipients.
• This function supports a maximum of 10 calls in parallel.

Sample Request

{  
	"BrandID":99,
	"FromEmail":"[[email protected]](mailto:[email protected])",
	"FromName":"Lovely.com",
	"ReplyTo":"[[email protected]](mailto:[email protected])",
	"Subject":"Check out today's hot deals!",
	"Html":"html content goes here",
	"PlainText":"plain text content goes here",
	"Recipients":\[
		{"Email":"[[email protected]](mailto:[email protected])"},
		{"Email":"[[email protected]](mailto:[email protected])"}
	],
	"Attachments":\[{
		"Content":"/_Base64 Encoded Content_/",
		"Type":"application/pdf",
		"FileName":"hotdealcoupons.pdf"
	}],
	"UniqueMessageID" (optional):"87ba42c0-9431-4266-b808-01cf05867006"
}

Sample Response

{"IsSuccess":true,"SendID":235311,"Error":null}
{"IsSuccess":false,"SendID":null,"Error":"Invalid template"}