Sender Details: Sample Use Cases and Flows

This article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation.

Publish an email campaign from a new sender

This use case demonstrates how to send an email campaign from a new sender. For example, if your business now accepts bookings and you want to start a new email campaign, you'll need to send it from a different sender, such as Yoga Bookings: [bookings@yogawithpuppies.com].

Notes:

  • Currently, there's a limitation when publishing an email campaign with the Campaign API. The API automatically publishes campaigns only from the default sender. For this use case to work, you need to set the new sender as the default.
  • This flow assumes that the site owner already created an email campaign.

To publish a campaign from a new sender:

  1. Create and verify the new email address using the Sender Email API.
  2. Call Create Sender Details passing the verified email address into the fromEmailAddress field. Also, enter the sender's name into the fromName field. Save the value of id field for later use.
  3. Call Mark Sender Details as Default and pass the saved ID.
  4. Call Publish Campaign to send out the campaign. The campaign will automatically use the new sender details.
Did this help?