Configure Email Delivery
Delivery
Configure Email Delivery
Set up email notifications for squid run completions
POST
Configure Email Delivery
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
string
required
Your API authentication token. Value:
Token YOUR_API_KEYstring
required
Must be application/json. Value:
application/jsonQuery Parameters
string
required
The unique identifier (hash) of the squid for which to configure email delivery. Example:
c106a44a98044ef18acc59986ae10967Request Body
string
required
The email address to receive notifications. Example:
"user@example.com"boolean
required
Set to true to send email immediately upon completion, or false to attach it for later use. Example:
trueResponse Field Explanations
string
The configured email address. Example:
"user@example.com"boolean
Whether immediate notifications are enabled. Example:
truestring
ISO timestamp when notifications were activated. Example:
"2025-02-26T15:48:48.538226"The notifications_activation_date is automatically set when you enable notifications for the first time.
Code Examples
Response
201