Email

Add someone to an email sequence

Only someone the project already knows, like any recipient (a form submission with in_reply_to, a document, an app user, a buyer, a confirmed list contact, or an address the owner confirmed). data fills the variables of every step. Someone who is already in the sequence stays where they are (200).

post/email-sequences/{id}/enrollments

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/email-sequences/{id}/enrollments
  • 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)

Path parameters

idstring uuid required

The id of the sequence.

Request body

emailstring required

The person's address. It must appear in the project, like any recipient.

dataobject

The values for the variables, like { "name": "Sam", "order_number": "1042" }. Text, numbers or true/false.

in_reply_tostring uuid

The form submission or chat conversation this person came from, when that is the only place the address appears.

Response

Already in the sequence.

idstring uuid required
sequence_idstring uuid required
emailstring required
status'active' | 'completed' | 'stopped' required
stepinteger required

The step that is next (0 is the first).

next_send_atstring date-time nullable required
stop_reasonstring nullable required

Why it stopped: unsubscribed, stopped, or the event (like order.paid).

created_atstring date-time required

Changes

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