Send customer portal magic link via email

Key Features:

• Automated Delivery: Generates magic link and sends email in one operation
• Customer Lookup: Finds customer by email address automatically
• Branded Emails: Uses shop’s configured email templates and branding
• Subscription Validation: Only sends if customer has active subscriptions
• Time-Limited Links: Email contains token that expires after configured duration

Email Contents: The sent email typically includes:

• Magic Link Button: One-click access to customer portal
• Link URL: Full URL with embedded authentication token
• Expiration Notice: When the link will expire (e.g., “Valid for 24 hours”)
• Shop Branding: Store logo, colors, and custom messaging
• Help Text: Instructions on how to use the portal

Workflow:

1. API receives customer email address
2. System looks up customer in Shopify by email
3. Validates customer has active subscription contracts
4. Generates secure JWT authentication token
5. Constructs magic link URL with token
6. Sends branded email with magic link to customer
7. Returns success confirmation to API caller

Email Template Customization: Email appearance and content can be customized via:

• Shop’s email notification settings in admin
• Custom email templates for magic links
• Localization settings for customer’s language
• Custom branding (logo, colors, footer)

Common Use Cases:

• Customer support: send portal access link to customers over phone/chat
• Automated workflows: trigger magic link emails based on events
• Forgot password alternative: passwordless portal access
• Post-purchase flows: send portal access after first order
• Reactivation campaigns: re-engage paused/cancelled customers
• Customer onboarding: welcome emails with portal access
• Subscription reminders: include portal link in reminder emails

Integration Example:

GET /api/external/v2/subscription-contracts-email-magic-link?
  email=customer@example.com&
  api_key=your_api_key

This sends a magic link email to customer@example.com for portal access.

Error Handling:

• If customer not found, returns 400 Bad Request
• If customer has no active subscriptions, returns 400
• If email service fails, returns 500 Internal Server Error
• Invalid email format returns 400 Bad Request

Email Delivery Notes:

• Emails are sent asynchronously (may take 1-5 minutes to deliver)
• Check spam folders if customer doesn’t receive email
• Respect customer’s email preferences and unsubscribe status
• Rate limits may apply to prevent abuse

Security Considerations:

• Only send to verified customer email addresses
• Email contains passwordless authentication link
• Links expire after configured duration (default: 24-72 hours)
• Sending to wrong email grants that person subscription access
• Consider email verification before using this endpoint

Authentication: Requires API key authentication via X-API-Key header or api_key parameter