Email Notifications API

Access and purpose

This API requires an alpha invitation even when your organization already uses the Email Notifications app. Grant read access for settings and activity, or the separate write permission for changes.

Alerts are created by the Email Notifications step in Attio workflows. These endpoints manage settings, activity, and waiting alerts; they are not a general-purpose send-email API.

Delivery settings

Read settings to get the current version and allowed choices before changing delivery limits or expiry. Fields you omit from a partial update keep their existing value.

Changing a subject prefix or BCC address requires permission to change Email Notifications settings and the current settings version. The change applies directly. Stopping BCC copies with bcc: null is a direct settings change. The BCC address is displayed in Neon Deer rather than returned by the settings read.

Pause and cancel

Turning off email alerts refuses new alerts from workflows while they are off; those alerts are not queued for later. Waiting alerts remain queued while sending is off. They may send after you resume, unless canceled or expired. Emails already being sent cannot be recalled.

Use cancellation endpoints to cancel selected waiting alerts, or turn alerts off and cancel the whole waiting queue together. Already sent, failed, or expired alerts are not canceled. Canceling an alert does not recall an email.

Delivery activity

Activity returns delivery states and provider reports with record references such as workflow and recipient IDs. It does not return email subjects, messages, or addresses. Provider acceptance and delivery reports do not confirm that a person read the email. See the activity reference.