Skip to main content
POST
Send a follow-up email for an ingested presentation

Authorizations

Authorization
string
header
required

A Demand IQ API key or service token, passed in the Authorization: Bearer header.

Body

application/json

Name the presentation with presentation_id, or with deck_id and source_event_id together. A request that includes both shapes returns 400.

idempotency_key
string
required

One send per key. Reuse the same key when you retry.

Required string length: 1 - 64
Example:

"reminder-48213-1"

subject_variant
enum<string>
required

Which email to send. The first email is sent by ingest, so initial is not accepted.

Available options:
reminder
presentation_id
string<uuid>

The presentation to send, as returned by ingest

Example:

"7c2e5f8b-1a4d-4e6f-9b3c-8d0e2f4a6b1c"

deck_id
string<uuid>

With source_event_id, identifies the presentation ingest created

Example:

"3f6c2a1e-8b4d-4c7a-9e2f-1d5b7a9c0e4f"

source_event_id
string

The source_event_id you passed to the ingest endpoint

Minimum string length: 1
Example:

"journey-complete-48213"

skip_if
enum<string>[]

Extra conditions that skip the send. opened: the homeowner opened an earlier email (machine opens don't count). viewed: the homeowner viewed the presentation.

Available options:
opened,
viewed

Response

The outcome

send_status
enum<string>
required
Available options:
sent,
skipped,
failed
reason
string

Set when skipped: no_presentation, no_email, suppressed, presentation_parked, presentation_failed, no_initial_send, reminder_disabled, opened, or viewed. Set when failed: the error message.

presentation_id
string<uuid>

Absent for no_presentation

delivery_id
string<uuid>

The delivery attempt ID. Absent for no_presentation.