Create a Send Object

This page contains information about creating a new Send object.

Why Create a Send Object 

You can use the newly created Send object to conduct an email send or as part of an email send definition.

How to Create a Send Object 

Use the code below as a model to construct your own API call.

Sample .NET Code 

1using System;
2using System.Configuration;
3using System.Data;
4using System.Linq;
5using System.Web;
6using System.Web.Security;
7using System.Web.UI;
8using System.Web.UI.HtmlControls;
9using System.Web.UI.WebControls;
10using System.Web.UI.WebControls.WebParts;
11using System.Xml.Linq;
12using etAPI;
13public partial class SendCreate : System.Web.UI.Page
14{
15    //Global Variables
16    private SoapClient client = new SoapClient();
17    protected void Page_Load(object sender, EventArgs e)
18    {
19        //Authenticate
20        client.ClientCredentials.UserName.UserName = System.Configuration.ConfigurationSettings.AppSettings["wsUserName"];
21        client.ClientCredentials.UserName.Password = System.Configuration.ConfigurationSettings.AppSettings["wsPassword"];
22        if (!IsPostBack)
23        {
24        }
25    }
26    protected void btnSubmit_Click(object sender, EventArgs e)
27    {
28        try
29        {
30            //Create a GUID for ESD to ensure a unique name and customer key
31            string strGUID = System.Guid.NewGuid().ToString();
32            Send s = new Send();
33            Email em = new Email();
34            em.ID = 887526;
35            em.IDSpecified = true;
36            s.Email = em;
37            //Subscriber[] subs = new Subscriber[1];
38            //subs[0] = new Subscriber();
39            //subs[0].EmailAddress = "email@example.com";
40            //subs[0].SubscriberKey = System.Guid.NewGuid().ToString();
41            //Create the List Object for the Send Object
42            s.List = new List[1];
43            s.List[0] = new List();
44            s.List[0].ID = 256415;
45            s.List[0].IDSpecified = true;
46            //s.List[0].Subscribers = subs;
47            string cRequestID = String.Empty;
48            string cStatus = String.Empty;
49            try
50            {
51                //Call the Create method on the Send object
52                CreateResult[] cResults = client.Create(new CreateOptions(), new APIObject[] { s }, out cRequestID, out cStatus);
53                //Display Results
54                lblMessage.Text += "Overall Create Status: " + cStatus;
55                lblMessage.Text += "<br/>";
56                lblMessage.Text += "Number of Results: " + cResults.Length;
57                lblMessage.Text += "<br/>";
58                //Loop through each object returned and display the StatusMessage
59                foreach (CreateResult cr in cResults)
60                {
61                    lblMessage.Text += "Status Message: " + cr.StatusMessage;
62                    lblMessage.Text += "<br/>";
63                }
64            }
65            catch (Exception exCreate)
66            {
67                //Set Message
68                lblMessage.Text += "<br/><br/>CREATE SEND ERROR:<br/>" + exCreate.Message;
69            }
70        }
71        catch (Exception exc)
72        {
73            //Set Message
74            lblMessage.Text += "<br/><br/>###ERROR<br/>" + exc.Message;
75        }
76    }
77}

Sample Java Code (Axis 1.4) 

1public void testSendEmailToList() throws RemoteException {
2        Soap stub = init();
3        Send send = new Send();
4        send.setEmail(testGetEmailById());
5        List l1= new List();
6        l1.setID(new Integer(12345));
7        List l2= new List();
8        l2.setID(new Integer(54321));
9        List[] ids = {l1,l2};
10        send.setList(ids);
11        send.setFromAddress("acruz@example.com");
12        send.setFromName("Angel Cruz");
13        APIObject[] apiObjectList = {send};
14        CreateRequest createRequest = new CreateRequest(new CreateOptions(), apiObjectList);
15        CreateResponse createResponse = stub.create(createRequest);
16        System.out.println("CreateResponse ::: " + createResponse.getOverallStatus());
17    }
18    public void testSend1000EmailToList() throws RemoteException {
19        Soap stub = init();
20        Send send = new Send();
21        Email e = new Email();
22        e.setID(12345);
23        send.setEmail(e);
24        ArrayList arr = new ArrayList();
25        for (int i = 0; i < 1000; i++) {
26            Subscriber s = new Subscriber();
27            s.setSubscriberKey("HUB_" + i);
28            s.setEmailAddress("hub_" + i + "@example.com");
29            Attribute a1 = new Attribute();
30            a1.setName("username");
31            a1.setValue("username_" + i);
32            Attribute a2 = new Attribute();
33            a2.setName("first_name");
34            a2.setValue("firstname_1" + i);
35            s.setAttributes(new Attribute[]{a1, a2});
36            arr.add(s);
37        }
38        Subscriber s = new Subscriber();
39        s.setSubscriberKey("ac_hub_1_");
40        s.setEmailAddress("test@example.com");
41        Attribute a1 = new Attribute();
42        a1.setName("username");
43        a1.setValue("username_1");
44        Attribute a2 = new Attribute();
45        a2.setName("first_name");
46        a2.setValue("firstname _1");
47        s.setAttributes(new Attribute[]{a1, a2});
48        arr.add(s);
49        List l = new List();
50        Subscriber[] ss = new Subscriber[arr.size()];
51        arr.toArray(ss);
52        l.setSubscribers(ss);
53        send.setList(new List[]{l});
54        send.setFromAddress("acruz@example.com");
55        send.setFromName("Angel Cruz");
56        CreateOptions c = new CreateOptions();
57        c.setRequestType(RequestType.Asynchronous);
58        APIObject[] apiObjectList = {send};
59        CreateRequest createRequest = new CreateRequest(c, apiObjectList);
60        CreateResponse createResponse = stub.create(createRequest);
61        System.out.println("CreateResponse ::: " + createResponse.getOverallStatus());
62
63    }

Sample SOAP Envelope - Create a Send Object Using an Email ID and a List ID 

1<soap:Body>
2    <CreateRequest xmlns="http://exacttarget.com/wsdl/partnerAPI">
3        <Options/>
4        <Objects xsi:type="Send">
5            <ObjectID xsi:nil="true"/>
6            <Email>
7                <ID>12345</ID>
8            </Email>
9            <List>
10                <ID>12345</ID>
11            </List>
12        </Objects>
13    </CreateRequest>
14</soap:Body>