API_USER

This comprehensive guide covers everything you need to know about API_USER credentials, which serve as your primary authentication method for accessing our Email Delivery API and SMTP services.

What is an API_USER?

An API_USER is a specialized credential system designed exclusively for programmatic email sending. Unlike your platform login account, API_USERs are purpose-built for:

• Automated email sending via API calls or SMTP
• Secure authentication without exposing your main account credentials
• Granular access control with specific permissions and limitations
• Isolated credential management for different applications or environments

💡

Think of API_USERs as service accounts - each one is tailored for a specific email sending purpose and can be managed independently.

Creating Your First API_USER

When setting up an API_USER, you'll configure three essential properties that determine its capabilities and behavior.

1. Email Type

Choose the appropriate type based on your sending needs:

⚠️

Important: Email type cannot be changed after creation. Plan carefully based on your intended use case.

2. Sending Domain Configuration

Every API_USER must be bound to an authenticated sending domain:

• Domain Authentication Required: The domain must be verified and have proper DNS records configured
• Sender Reputation: All emails will originate from this domain, affecting your sender reputation
• Deliverability Impact: Proper domain setup is crucial for inbox placement

Domain Setup Checklist

Before binding a domain to your API_USER:

1. ✅ Domain is verified in your account
2. ✅ SPF record is properly configured
3. ✅ DKIM signing is enabled
4. ✅ DMARC policy is set (recommended)
5. ✅ Domain has positive sending reputation

3. Tracking and Analytics

Enable tracking to monitor email performance:

When Tracking is Enabled:

• Open rate tracking
• Click-through tracking
• Unsubscribe monitoring
• Spam complaint tracking

Privacy Considerations:

• Tracking uses invisible pixels and link redirects
• Consider privacy regulations in your jurisdiction
• Provide clear opt-out mechanisms for recipients

API_KEY Management

The API_KEY functions as the "password" for your API_USER and requires careful handling.

Troubleshooting Common Issues

Authentication Failures

Symptoms: 401 Unauthorized errors, authentication failures

Common Causes:

• Incorrect API_USER name or API_KEY
• Using expired credentials after reset
• API_USER not properly configured

Solutions:

1. Verify API_USER name matches exactly (case-sensitive)
2. Ensure API_KEY is current and not expired
3. Check if API_USER is active and not suspended
4. Regenerate API_KEY if in doubt

Domain-Related Errors

Symptoms: Domain verification errors, sending failures

Common Causes:

• Sending domain not bound to API_USER
• Domain not properly authenticated
• DNS configuration issues

Solutions:

1. Verify domain is bound to the API_USER
2. Check domain authentication status
3. Validate DNS records (SPF, DKIM, DMARC)
4. Contact support for domain-specific issues

Email Type Restrictions

Symptoms: Emails rejected due to type mismatch

Common Causes:

• Trigger API_USER trying to send marketing emails
• Batch API_USER trying to send transactional emails
• Incorrect email classification

Solutions:

1. Review your API_USER type configuration
2. Create separate API_USERs for different email types
3. Ensure email content matches API_USER type
4. Update your application logic accordingly

Security and Compliance

Security Framework

Compliance Considerations

• Data Protection: Ensure recipient data is handled according to applicable privacy laws
• Consent Management: Maintain proper opt-in/opt-out mechanisms
• Audit Trails: Keep records of email sending activities
• Geographic Restrictions: Understand regional sending limitations

Next Steps

---

🆘

Need Help? If you encounter issues not covered in this guide, our support team is ready to assist with API_USER configuration and troubleshooting.