Email

Create an email sequence

A series of 1 to 20 emails, each a template with a wait before it (in minutes, at most 30 days). Someone joins with POST /email-sequences/{id}/enrollments or through an automation. It stops for a person when they unsubscribe (always), when an event in stop_on happens for their address (like order.paid), or with POST /email-sequences/{id}/stop. category other (default) gives every email an unsubscribe link.

post/email-sequences

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/email-sequences
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: messages:write)

Request body

namestring required

A name, like "Onboarding".

stop_onstring[]

Stop for a person when one of these happens for their address, like order.paid, or subscription.recovered and subscription.canceled for reminders about a failed payment. Unsubscribing always stops.

fromstring required

The sender: an address on a verified sending domain of this project, optionally with a name, like "Acme hello@acme.com".

reply_tostring

Optional. Where replies go, like the owner's own mailbox.

category'transactional' | 'other'

other (default): every email has an unsubscribe link. transactional only for steps that follow up on something the person did.

Response

The sequence.

idstring uuid required
namestring required
stop_onstring[] required
fromstring required
reply_tostring nullable required
category'transactional' | 'other' required
activeinteger required

How many people are in the sequence now.

created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.