Developers
Help CenterCommunityStatus

Send an email to a contact - SendMailing

Sends a Campaign email to a specified contact. The SendMailing operation is specifically for the delivery of autoresponders based on a custom event. This operation will not send an email template.

📘

The MailingId and RecipientEmail

The MailingId must be for an existing, custom event autoresponder and the contact email address must be for a contact who already exists in the database associated with the mailing.

See Add a contact for information on adding a contact to a database.

🚧

Call limit and sends

There is a limit of 10,000 SendMailing API calls per day for an organization. If you plan to send more than 10,000 transactional emails per day, please contact your Acoustic account manager to discuss alternatives.

Each send is queued for message generation and delivery. They do not always send immediately, but receive slices of processing time as determined by an algorithm. Small sends such as these are typically built and sent within a range of seconds‐to‐minutes, but that varies based on several factors such as concurrent system usage.

Elements (Required)

MailingId - Identifies the mailing Acoustic Campaign will send

Elements (Optional)

📘

You only need to use one

If you use RecipientEmail, then neither LOOK_UP_KEYS nor COLUMNS is needed.

If you use COLUMNS because of a keyed database, then LOOK_UP_KEYS won't work and RecipientEmail isn’t needed.

If you use LOOK_UP_KEYS because of a flexible database, then COLUMNS won't work and RecipientEmail isn’t needed.

RecipientEmail - Identifies the targeted contact’s email address

COLUMNS - XML nodes defining the column name and value for the database’s key fields. Each node must have a Name and a Value tag. If the database has a key that is not email, unique key columns must also be part of the submission with column names and values.
COLUMN - A child of COLUMNS that contains Name and Value as children
Name - Defines the field name
Value - Contains the field value

LOOK_UP_KEYS - XML node that sends an autoresponder message to a single contact referencing a flexible database through a combination of unique values. Contains LOOK_UP_KEY and its children.
LOOK_UP_KEY - A child of LOOK_UP_KEYS that contains Name and Value as children
Name - Defines the field name
Value - Contains the field value

Example calls:

<Envelope>
  <Body>
    <SendMailing>
      <MailingId>149482</MailingId>
      <RecipientEmail>[email protected]</RecipientEmail>
    </SendMailing>
  </Body>
</Envelope>

<Envelope>
  <Body>
    <SendMailing>
      <MailingId>149482</MailingId>
      <COULMNS>
      <COLUMN>
      <NAME>CustomerID</NAME>
      <VALUE>00141</VALUE>
      </COLUMN>
      </COLUMNS>
    </SendMailing>
  </Body>
</Envelope>

<Envelope>
  <Body>
    <SendMailing>
      <MailingId>149482</MailingId>
      <LOOK_UP_KEYS>
      <LOOK_UP_KEY>
      <NAME>UID</NAME>
      <VALUE>36912</VALUE>
      </LOOK_UP_KEY>
      <LOOK_UP_KEY>
      <NAME>Offer Id</NAME>
      <VALUE>1</VALUE>
      </LOOK_UP_KEY>
      </LOOK_UP_KEYS>
    </SendMailing>
  </Body>
</Envelope>

<Envelope>
  <Body>
    <RESULT>
      <SUCCESS>TRUE</SUCCESS>
      <ORGANIZATION_ID>123456</ORGANIZATION_ID>
    </RESULT>
  </Body>
</Envelope>

Elements (Results)

SUCCESS - True if successful; False if not. Upon success, the API immediately schedules a mailing to the contact.

ORGANIZATION_ID - Identifies your Acoustic Campaign organization.