Email

Stop an email sequence for someone

For example when the person replied. Steps that were scheduled for them are not sent.

post/email-sequences/{id}/stop

Request

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

Response

Stopped.

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.