latestSwagger 2.02026-08-10148196271.0 KB

afaab604b58c

Send an email to an email address

Send an email to a specific email address. Request data fields will override user profile data fields. A reference to the user profile is provided via the <code>profile</code> field, to help resolve field collisions.<br/><br/>Learn about <a href="https://support.iterable.com/hc/articles/29156459027348">identifying users by <code>userId</code> and <code>email</code></a>.

post/api/email/target

Request body

allowRepeatMarketingSendsboolean

Allow repeat marketing sends? Defaults to true.

campaignIdinteger required

Campaign ID

dataFieldsobject

Fields to merge into email template

metadataobject

Metadata to pass back via webhooks. Not used for rendering

recipientEmailstring

An email address that identifies a user profile in Iterable. Provide a <code>recipientEmail</code> or a <code>recipientUserId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.

recipientUserIdstring

A user ID that identifies a user profile in Iterable. Provide a <code>recipientEmail</code> or a <code>recipientUserId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.

sendAtstring

Schedule the message for up to 365 days in the future. If set in the past, email is sent immediately. Format is <code>YYYY-MM-DD HH:MM:SS</code> in UTC

Response

successful operation