Skip to main content
POST
/
v1
/
delivery
Configure Email Delivery
curl --request POST \
  --url https://api.lobstr.io/v1/delivery \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "email": "<string>",
  "notifications": true
}
'
{
  "email": "<string>",
  "notifications": true,
  "notifications_activation_date": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY
​
Content-Type
string
required
Must be application/json. Value: application/json

​
Query Parameters

​
squid
string
required
The unique identifier (hash) of the squid for which to configure email delivery. Example: c106a44a98044ef18acc59986ae10967

​
Request Body

​
email
string
required
The email address to receive notifications. Example: "user@example.com"
​
notifications
boolean
required
Set to true to send email immediately upon completion, or false to attach it for later use. Example: true

​
Response Field Explanations

​
email
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"
Set notifications to false if you want to manage email delivery manually rather than receiving automatic notifications.
The notifications_activation_date is automatically set when you enable notifications for the first time.
Make sure the email address is valid and can receive emails. Invalid addresses will cause delivery failures.
Use the Test Email endpoint to verify your email configuration before activating notifications.

​
Code Examples

curl -X POST "https://api.lobstr.io/v1/delivery?squid=YOUR_SQUID_HASH" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "notifications": true
  }'

​
Response

201
{
  "email": "user@example.com",
  "notifications": true,
  "notifications_activation_date": "2025-02-26T15:48:48.538226"
}