Email

Update an email automation

Changes only the fields you send, like enabled: false to pause it.

patch/email-automations/{id}

Request

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

Request body

template_idstring uuid
tostring
fromstring

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

reply_tostring nullable
category'transactional' | 'other'
delay_minutesinteger
enabledboolean

Response

The updated automation.

idstring uuid required
event'form.submitted' | 'booking.created' | 'order.paid' | 'order.payment_failed' | 'app_user.created' | 'list.subscribed' | 'subscription.payment_failed' | 'subscription.past_due' | 'subscription.chargeback' | 'subscription.canceled' | 'subscription.paused' | 'subscription.resumed' | 'subscription.recovered' required
template_idstring uuid nullable required
sequence_idstring uuid nullable required
tostring required

contact (the person of the event) or a fixed address.

fromstring required
reply_tostring nullable required
category'transactional' | 'other' required
delay_minutesinteger required
enabledboolean required
created_atstring date-time required

Changes

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