POST/v1/delivery?squid={squid_hash}

Configure Email Delivery

Set up email notifications for squid run completions

Configure email delivery to receive notifications when your squid runs complete. You can choose to receive immediate notifications or attach results for later use.

Headers

Key	Value	Required
Authorization	Token YOUR_API_KEY	Yes
Content-Type	application/json	Yes

Request Body

emailstring

Required

The email address to receive notifications

Example: user@example.com

notificationsboolean

Required

Set to true to send email immediately upon completion, or false to attach it for later use

Example: true

Response Field Explanations

string

The configured email address

Example: user@example.com

notifications

boolean

Whether immediate notifications are enabled

Example: true

notifications_activation_date

string

ISO timestamp when notifications were activated

Example: 2025-02-26T15:48:48.538226

Parameters

squidstring

Required

The unique identifier (hash) of the squid for which to configure email delivery

Example: c106a44a98044ef18acc59986ae10967

Pro Tip

Set notifications to false if you want to manage email delivery manually rather than receiving automatic notifications.

Note

The notifications_activation_date is automatically set when you enable notifications for the first time.

Warning

Make sure the email address is valid and can receive emails. Invalid addresses will cause delivery failures.

Pro Tip

Use the Test Email endpoint to verify your email configuration before activating notifications.