APIs & Integrations

How do I automate exporting recipient data to SFTP?

You can automate your CSV exports by using the RawRecipientDataExport API with the MOVE_TO_FTP=true parameter. This sends your export file directly to your SFTP /download folder without manual intervention.

Setting up automation

Log into your SFTP account using your Campaign username and password (not your Acoustic ID). Make sure you're connecting to the correct POD-specific server address for your account.

Once the export file lands in your SFTP folder, set up a scheduled script to automatically pull it to your local system. You can then archive or process the file as needed.

What happens to files after download

Files are automatically removed from SFTP once downloaded. If you miss a file, simply re-run the API call using the same date range to generate it again.

Sample API request

<Envelope>
<Body>
<RawRecipientDataExport>
<EXPORT_FORMAT>CSV</EXPORT_FORMAT>
<MOVE_TO_FTP>true</MOVE_TO_FTP>
<EMAIL>youremail@domain.com</EMAIL>
<DATE_START>2025-09-01</DATE_START>
<DATE_END>2025-09-14</DATE_END>
</RawRecipientDataExport>
</Body>
</Envelope>

This workflow gives you a fully automated process: export → SFTP → download → archive.

How do I export suppression list data using the API?

Use the RawRecipientDataExport API to export suppression list data for your organization. This API retrieves raw contact events filtered specifically for suppressed contacts.

Before you start

Make sure you have the necessary permissions and API credentials for your Acoustic Campaign account.

Exporting suppression data

Call the RawRecipientDataExport API endpoint and include the SUPPRESSED parameter in your request. This filters your export to show only suppressed contacts.

Each suppressed contact includes a reason code that tells you why they were suppressed. The API response also includes email addresses, mailing IDs, suppression reason codes, and timestamps (original_sent_ts).

Automating your exports

Want to set up automated suppression list exports? Connect with your Client Success Manager (CSM) for help getting this configured.

Related resources

How do I test Transact XML requests in Postman?

Use Postman to test your Transact API calls before implementing them in your production environment.

Before you start

Make sure your IP address is added to the allowlist in Org Administration > Security Settings. You'll also need your organization's Transact API endpoint URL and a properly formatted XML request.

Setting up Postman

Change the request method to POST, then enter your organization's Transact API endpoint URL.

Add a header with Content-Type set to text/xml.

In the Body section, select "raw" and paste your XML request. Make sure your XML follows the documented schema and includes proper authentication and recipient data.

Testing your request

First, confirm your current IP address is approved for Transact access. Then validate your XML format—check that authentication elements and recipient data are correct.

Click Send in Postman and review the response. Look for success confirmation or error messages.

If you get errors, use the response codes and error details to identify and fix issues.

What to watch for

Pay attention to HTTP response codes, success confirmations, and any error details. These help you refine your Transact XML implementation.

How does the Establish Identity API handle lookup keys?

When you call the Establish Identity API, the behavior depends on whether your lookup key (like Lead_ID) already exists in your database.

If the lookup key doesn't exist, the API assigns it to the specified mobile contact instead of merging records. If the key already exists, the API merges the contacts as expected.

Avoiding unintended assignments

Pre-populate your database with all required contacts and lookup keys before calling the API. This ensures merges happen correctly and prevents new keys from being created unexpectedly.

Working as designed

This behavior is intentional and can't be changed. If you need additional guidance on managing lookup keys, contact Acoustic Support.

Why aren't recipient logs showing up in my Raw Recipient Data Export?

The Raw Recipient Data Export (RDDE) API won't return recipient-level logs if your mailing has a Cancelled status. Summary data still appears in the Single Mailing Report, but detailed event logs are only available for mailings with a Sent status.

Getting your logs

To access recipient-level logs for a cancelled mailing, contact Acoustic Support. They can update the mailing to a Sent status so RDDE returns the logs you need.

Why am I getting an error when removing a recipient from the Master Suppression List?

This error happens because the Master Suppression List is email-keyed. If you use a payload format designed for non-keyed lists, the API won't find the recipient.

Removing a recipient successfully

Make sure your API payload uses the correct format. You need to specify the Master Suppression List ID and the recipient's email address. When formatted correctly, the API returns a success response.

Correct payload format

<Envelope>
<Body>
<RemoveRecipient>
<LIST_ID>10000</LIST_ID>
<EMAIL>XYZ@gmail.com</EMAIL>
</RemoveRecipient>
</Body>
</Envelope>

Replace 10000 with your Master Suppression List ID and XYZ@gmail.com with the email address you want to remove.

Which composer does the SaveMailing API use for templates?

The SaveMailing API currently creates templates in Classic Composer only.

Why aren't my Facebook Lead Ads importing through Social Audience?

Facebook form lead ads may not import if your Facebook page isn't properly subscribed in Social Audience or if your field mappings are incorrect.

Verify your page subscription

In Social Audience, go to Settings → Facebook. Expand the business account you want to use and click on the Pages tab.

If the page isn't subscribed, click Subscribe. Make sure you've accepted the Facebook Terms of Service at https://www.facebook.com/ads/leadgen/tos.

Check Facebook Business Settings for the page and confirm that Full Control is enabled.

If Subscribe still doesn't appear

Unmap the Facebook account in Social Audience, then re-link the account and verify the page. The Subscribe option should now appear.

Check your field mapping

Make sure the Facebook form field names are correctly mapped in Social Audience. Update the fields in the input boxes and save your changes.

Once you've completed these steps, Facebook leads should start importing successfully into your Campaign database.

Optional verification

If you have access to Social Audience's database, you can confirm leads are importing by viewing the lead records for your organization.

Join the community

Academy

Related articles

Join the community

Academy