Automations

An automation is a template sequence triggered when a contact is added to an audience: send the first step after its delay, then each following step relative to the previous one. Sequences stop themselves when a contact unsubscribes, gets suppressed, or the automation is paused — the same consent guardrails as broadcasts, including an always-present one-click unsubscribe link.

Create an automation

POST/api/v1/automations

curl

curl -X POST https://www.noticeapi.com/api/v1/automations \
  -H "Authorization: Bearer ntc_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Welcome flow",
    "audienceId": "aud_xxxxxxxx",
    "fromAddress": "[email protected]",
    "steps": [
      { "delayMinutes": 0, "templateId": "tpl_welcome" },
      { "delayMinutes": 4320, "templateId": "tpl_tips" }
    ]
  }'

Field	Type	Description
`name`required	string	Shown in the dashboard.
`audienceId`required	string	Trigger: contacts added to this audience enter the sequence.
`fromAddress`required	string	Sender for every step. Sandbox or a verified domain.
`steps`required	array (1–5)	Each step: { delayMinutes, templateId }. Delays are relative to the previous step.
`enabled`	boolean	Defaults to true. Paused automations cancel pending steps on their next tick.

Manage

GET/api/v1/automations

GET/api/v1/automations/:id

PATCH/api/v1/automations/:id

DELETE/api/v1/automations/:id

GET /:idincludes the automation's recent runs so you can see where each contact is in the sequence. Deleting an automation cancels its scheduled steps.

Template variables

Steps render their template with {{FIRST_NAME}}, {{LAST_NAME}}, {{EMAIL}}, and {{UNSUBSCRIBE_URL}}filled from the contact. If your template doesn't place the unsubscribe tag, a footer link is appended automatically.