{"_id":"5937b444a5fcc0000fdd432a","project":"55dd9f2e0efd5821000d54d9","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":39,"project":"55dd9f2e0efd5821000d54d9","createdAt":"2015-08-26T11:13:17.024Z","releaseDate":"2015-08-26T11:13:17.024Z","categories":["55dd9f4dab0e4d210045aaea","55ddb5fa9067202b00ddff6f","55e0472c6bad670d0081f213","55e04764a44fae0d00214671","55e047a9a44fae0d00214672","55e047b258c5460d0076a9a7","55e95e337fc27b2d00d32cf2","55e979bda7ca823900ad549a","55edb8c18dcb210d0056900b","55f0365c8563861700a33765","55f03677d58f9b1900acf996","55f036938eeefc23001ea5de","55f036a38563861700a33767","55f036c08563861700a33769","55f036d02911b72100482cd7","55f036e92911b72100482cd9","55f036fa8563861700a3376b","55f0370ee507711900e58c69","55f0371df6101b1900c70700","55f0374f2911b72100482cdb","55f0375e2911b72100482cdc","560eb0f659cb8d0d0015cd52","560eb25239fad419002ae1e0","561fb64d4d67490d00804b2a","562b9f775a39cd0d009aff22","562ba0505a39cd0d009aff23","562ba149d56bc30d00f0cb18","562ba595f68a5f0d007b1f3b","562ba78fd56bc30d00f0cb1b","562ba8b95a39cd0d009aff27","562baadf6562140d001501d2","562bab37f68a5f0d007b1f3d","562bc1bf9ebc950d000f7523","562bc99ced4bea0d00c11dfa","562bd29c1b98640d00714520","562bd5875a39cd0d009aff60","562bdfabff2da50d002c0aaf","562be0bd5a39cd0d009aff75","57a0b476d8313e1900454439"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"55f036c08563861700a33769","version":"55dd9f4dab0e4d210045aae9","__v":1,"pages":["5601545b3aa0520d00da0ccd"],"project":"55dd9f2e0efd5821000d54d9","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-09T13:40:16.609Z","from_sync":false,"order":17,"slug":"transactional-email","title":"Transactional email"},"user":"55dd9841cafe7221002a4c62","__v":1,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-07T08:07:32.938Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"","name":""}]},"method":"post","examples":{"codes":[{"code":"{\n \"toAddresses\": [\"john.smith:::at:::thisdomain.com\"],\n \"campaignId\": \"57332\",\n \"personalizationValues\": [{ Name: \"FIRSTNAME\" , Value: \"John\" }, { Name: \"LASTNAME\" , Value: \"Smith\" }]\n}","language":"json"}]},"auth":"required","params":[{"_id":"5937b444a5fcc0000fdd432d","ref":"","in":"body","required":true,"desc":"The array of email addresses of the recipients you're sending to, which need to be included within the request body. Separate addresses with a comma if you're sending to multiple recipients.","default":"","type":"array_string","name":"ToAddresses"},{"_id":"5937b444a5fcc0000fdd432c","ref":"","in":"body","required":true,"desc":"The ID of the triggered campaign, which needs to be included within the request body.","default":"","type":"int","name":"CampaignID"},{"_id":"5937b444a5fcc0000fdd432b","ref":"","in":"body","required":false,"desc":"Each personalisation value is a key-value pair; the placeholder name of the personalisation value needs to be included within the request body.","default":"","type":"string","name":"PersonalizationValues.Name"},{"_id":"59392b4f4ea7ce000f36b922","ref":"","in":"body","required":false,"desc":"Each personalisation value is a key-value pair; the personalisation value needs to be included within the request body.","default":"","type":"string","name":"PersonalizationValues.Value"}],"url":"/v2/email/triggered-campaign"},"isReference":false,"order":1,"body":"This operation sends a transactional email using a triggered campaign.\n\nIf sending to multiple recipients, please separate addresses with a comma.\n\nThere is no string length limit for the 'Name' and 'Value' values.\n\nWhen sending a transactional email via this operation, you'll note that you're not required to provide the subject line and the from address. This is because they will be directly taken from the 'Subject line and 'From address' of the triggered campaign as set up in dotmailer. These are entered on the 'Provide a few campaign setup details' page in dotmailer, which is the first step (**Create**) in the campaign creation process when creating or editing a campaign.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"A note on HTML compatibility for personalisation content\",\n  \"body\": \"When using transactional email personalisation, the type of personalised content needs to be compatible with the HTML element it's being put into within the triggered campaign. For example, if the operation contains a personalised table, it will need to go into a table element in the campaign, not a paragraph. \\n\\nCheck with your campaign designers to ensure that their campaign's elements are suitable for the personalisation content being used.\"\n}\n[/block]","excerpt":"Sends a transactional email using a triggered campaign","slug":"send-transactional-email-using-a-triggered-campaign","type":"endpoint","title":"Send transactional email using a triggered campaign"}

postSend transactional email using a triggered campaign

Sends a transactional email using a triggered campaign

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

ToAddresses:
required
array of strings
The array of email addresses of the recipients you're sending to, which need to be included within the request body. Separate addresses with a comma if you're sending to multiple recipients.
CampaignID:
required
integer
The ID of the triggered campaign, which needs to be included within the request body.
PersonalizationValues.Name:
string
Each personalisation value is a key-value pair; the placeholder name of the personalisation value needs to be included within the request body.
PersonalizationValues.Value:
string
Each personalisation value is a key-value pair; the personalisation value needs to be included within the request body.

Examples


Documentation

This operation sends a transactional email using a triggered campaign. If sending to multiple recipients, please separate addresses with a comma. There is no string length limit for the 'Name' and 'Value' values. When sending a transactional email via this operation, you'll note that you're not required to provide the subject line and the from address. This is because they will be directly taken from the 'Subject line and 'From address' of the triggered campaign as set up in dotmailer. These are entered on the 'Provide a few campaign setup details' page in dotmailer, which is the first step (**Create**) in the campaign creation process when creating or editing a campaign. [block:callout] { "type": "warning", "title": "A note on HTML compatibility for personalisation content", "body": "When using transactional email personalisation, the type of personalised content needs to be compatible with the HTML element it's being put into within the triggered campaign. For example, if the operation contains a personalised table, it will need to go into a table element in the campaign, not a paragraph. \n\nCheck with your campaign designers to ensure that their campaign's elements are suitable for the personalisation content being used." } [/block]