{"_id":"562bdf3932ee000d0084fd86","project":"55dd9f2e0efd5821000d54d9","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":45,"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","5b19051beece890003020163","5b34ded01cb20f000391ad6d","5b3a325acffe770003fd29e5","5b3c737a7f7b890003365501","5b3c929b367036000391b11e","5b7c1e210dc2e20003871521"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"user":"55dd9841cafe7221002a4c62","category":{"_id":"562ba149d56bc30d00f0cb18","project":"55dd9f2e0efd5821000d54d9","version":"55dd9f4dab0e4d210045aae9","__v":33,"pages":["562ba3865a39cd0d009aff24","562ba3f1f68a5f0d007b1f39","562bae5f5a39cd0d009aff2a","562bb233db5fea0d003fa834","562bb2d4d56bc30d00f0cb24","562bb3039ebc950d000f7512","562bb3516562140d001501d7","562bb685d56bc30d00f0cb25","562bb6a4f68a5f0d007b1f41","562bb7736562140d001501dd","562bb7c2db5fea0d003fa839","562bb8de5a39cd0d009aff2c","562bb900d56bc30d00f0cb27","562bb93d5a39cd0d009aff2d","562bb96b9ebc950d000f7517","562bbb249ebc950d000f7518","562bbbc5ed4bea0d00c11dee","562bbc7cd56bc30d00f0cb29","562bbcc76562140d001501df","562bbce75a39cd0d009aff42","562bbd48d56bc30d00f0cb2a","562bbd799ebc950d000f751c","562bbdec9ebc950d000f751e","562bbe651b98640d00714506","562bbef26562140d001501e0","562bbf11d56bc30d00f0cb2d","562bbf5e1b98640d00714508","562bbf88ed4bea0d00c11df0","562bcada52fb180d0034cc04","562bdf3932ee000d0084fd86","562be06f12c2820d00869ba4","562be30352fb180d0034cc15","562fb928eed65e0d008def39"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-24T15:18:33.484Z","from_sync":false,"order":25,"slug":"campaigns-1","title":"Campaigns"},"editedParams2":true,"githubsync":"","editedParams":true,"parentDoc":null,"__v":5,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-24T19:42:49.328Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\">\n   <s:Body>\n      <CreateAddressBookResponse xmlns=\"http://apiconnector.com/v2\">\n         <CreateAddressBookResult xmlns:a=\"http://apiconnector.com\" xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\">\n            <a:Id>0</a:Id>\n            <a:Name>My Address Book</a:Name>\n            <a:Visibility>Public</a:Visibility>\n            <a:Contacts>0</a:Contacts>\n         </CreateAddressBookResult>\n      </CreateAddressBookResponse>\n   </s:Body>\n</s:Envelope>","language":"xml","status":200,"name":""}]},"settings":"","examples":{"codes":[{"code":"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:v2=\"http://apiconnector.com/v2\" xmlns:apic=\"http://apiconnector.com\">\n   <soapenv:Header/>\n   <soapenv:Body>\n      <v2:CreateAddressBook>\n         <v2:apiAddressBook>\n            <apic:Name>My Address Book</apic:Name>\n            <apic:Visibility>Public</apic:Visibility>\n         </v2:apiAddressBook>\n      </v2:CreateAddressBook>\n   </soapenv:Body>\n</soapenv:Envelope>","language":"xml"}]},"auth":"required","params":[{"_id":"55ddbc1e746ace2b00dd6f38","ref":"","in":"body","required":true,"desc":"The name of the address book you're creating. It can't be an existing address book's name, 'Test' or 'All contacts'.","default":"","type":"string","name":"Name"},{"_id":"55ddbc1e746ace2b00dd6f37","ref":"","in":"body","required":false,"desc":"All address books are created as 'Private' by default but you can set it as 'Public' upon creation should you wish to.","default":"","type":"string","name":"Visibility"}],"url":"/v:version/ApiService/CreateAddressBook"},"isReference":false,"order":4,"body":"This method sends a specified campaign to as many address books and segments as you choose. However, when sending to contacts, you can only send to up to 10 in a single call. You can send to a single contact if you wish. \n\nThe send can also be scheduled by including the SendDate parameter.  If the SendDate parameter isn't included, the campaign will be sent immediately.\n\nIf you want to send the campaign as a split test, you must include all the fields of the SplitTestOptions parameter. If the SplitTestOptions parameter isn't included, the campaign will not be sent as a split test.\n\nThe value of the TestPercentage field must be between 1 and 100.The value of the TestPeriodHours field must be between 1 and 2,147,483,647.\n\nPlease note that this method doesn't add to your allotted total calls in a 24 hour period.\n\n**SOAP action:** [https://[region ID]-api.dotmailer.com/v2/ApiService/SendCampaign](doc:sendcampaign)\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The input and output parameters for this method are:\\n\\n**Input parameters** \\n  * CampaignId - *required; integer*\\n  * AddressBooks - *optional; array of integers*\\n       * integer \\n  * ContactIds - *optional; array of integers* \\n       * integer\\n  * SendDate - *optional; dateTime*\\n  * SplitTestOptions - *optional; object*\\n       * TestMetric - *string ('Opens', 'Clicks')*\\n       * TestPercentage - *integer*\\n       * TestPeriodHours - *integer*\\n\\n**Output parameters** \\n  * SendCampaignResult\\n       * Id - *GUID*\\n       * CampaignId - *integer*\\n       * AddressBooks - *array of integers*\\n            * integer \\n       * ContactIds - *array of integers* \\n            * integer \\n       * SendDate - *dateTime*\\n       * SplitTestOptions - *object*\\n            * TestMetric - *string ('Opens', 'Clicks')*\\n            * TestPercentage - *integer*\\n            * TestPeriodHours - *integer* \\n       * Status - *string ('NotSent', 'Scheduled', 'Sending', 'Sent', 'Cancelled')*\",\n  \"title\": \"Input and output parameters\"\n}\n[/block]\n **Example** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"using (var client = new ApiServiceClient())\\n{\\n\\tclient.ClientCredentials.UserName.UserName = \\\"username\\\";\\n\\tclient.ClientCredentials.UserName.Password = \\\"password\\\";\\n\\n\\t// Note: You can send to AddressBookIds OR ContactIds, not both at the same time\\n\\tvar campaignSend = new ApiCampaignSend\\n\\t                    {\\n\\t                        CampaignId = 1,\\n\\t                        AddressBookIds = new[] { 1, 2, 3 },\\n\\t                        ContactIds = new[] { 1, 2, 3 },\\n\\t                        SplitTestOptions = new ApiSplitTestSendOptions\\n\\t                                            {\\n\\t                                                TestMetric = ApiSplitTestMetrics.Clicks,\\n\\t                                                TestPercentage = 50,\\n\\t                                                TestPeriodHours = 12\\n\\t                                            },\\n\\t                        SendDate = new DateTime(2015, 01, 01, 00, 00, 00, DateTimeKind.Utc)\\n\\t                    };\\n\\tvar updatedCampaignSend = client.SendCampaign(campaignSend);\\n}\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"Sends a specified campaign to one or more address books, segments or contacts, either as an immediate or scheduled send","slug":"sendcampaign","type":"basic","title":"SendCampaign"}

SendCampaign

Sends a specified campaign to one or more address books, segments or contacts, either as an immediate or scheduled send

This method sends a specified campaign to as many address books and segments as you choose. However, when sending to contacts, you can only send to up to 10 in a single call. You can send to a single contact if you wish. The send can also be scheduled by including the SendDate parameter. If the SendDate parameter isn't included, the campaign will be sent immediately. If you want to send the campaign as a split test, you must include all the fields of the SplitTestOptions parameter. If the SplitTestOptions parameter isn't included, the campaign will not be sent as a split test. The value of the TestPercentage field must be between 1 and 100.The value of the TestPeriodHours field must be between 1 and 2,147,483,647. Please note that this method doesn't add to your allotted total calls in a 24 hour period. **SOAP action:** [https://[region ID]-api.dotmailer.com/v2/ApiService/SendCampaign](doc:sendcampaign) [block:callout] { "type": "info", "body": "The input and output parameters for this method are:\n\n**Input parameters** \n * CampaignId - *required; integer*\n * AddressBooks - *optional; array of integers*\n * integer \n * ContactIds - *optional; array of integers* \n * integer\n * SendDate - *optional; dateTime*\n * SplitTestOptions - *optional; object*\n * TestMetric - *string ('Opens', 'Clicks')*\n * TestPercentage - *integer*\n * TestPeriodHours - *integer*\n\n**Output parameters** \n * SendCampaignResult\n * Id - *GUID*\n * CampaignId - *integer*\n * AddressBooks - *array of integers*\n * integer \n * ContactIds - *array of integers* \n * integer \n * SendDate - *dateTime*\n * SplitTestOptions - *object*\n * TestMetric - *string ('Opens', 'Clicks')*\n * TestPercentage - *integer*\n * TestPeriodHours - *integer* \n * Status - *string ('NotSent', 'Scheduled', 'Sending', 'Sent', 'Cancelled')*", "title": "Input and output parameters" } [/block] **Example** [block:code] { "codes": [ { "code": "using (var client = new ApiServiceClient())\n{\n\tclient.ClientCredentials.UserName.UserName = \"username\";\n\tclient.ClientCredentials.UserName.Password = \"password\";\n\n\t// Note: You can send to AddressBookIds OR ContactIds, not both at the same time\n\tvar campaignSend = new ApiCampaignSend\n\t {\n\t CampaignId = 1,\n\t AddressBookIds = new[] { 1, 2, 3 },\n\t ContactIds = new[] { 1, 2, 3 },\n\t SplitTestOptions = new ApiSplitTestSendOptions\n\t {\n\t TestMetric = ApiSplitTestMetrics.Clicks,\n\t TestPercentage = 50,\n\t TestPeriodHours = 12\n\t },\n\t SendDate = new DateTime(2015, 01, 01, 00, 00, 00, DateTimeKind.Utc)\n\t };\n\tvar updatedCampaignSend = client.SendCampaign(campaignSend);\n}", "language": "csharp" } ] } [/block]