API Reference
The Mailcast API allows you to programmatically manage your email aliases, domains, and other resources.
Base URL
All API requests should be made to:
https://api.mailcast.io/v1Authentication
All API requests require authentication using a Bearer token. Include your API token in the Authorization header:
Authorization: Bearer YOUR_API_TOKENYou can generate API tokens in your Mailcast dashboard under the API section.
Response Format
All API responses are returned in JSON format with the following structure:
Success Response
{
  "id": "alias_abc123",
  "match": "support",
  "state": "active",
  "actions": [...],
  "created_at": "2024-01-01T00:00:00.000000Z",
  "updated_at": "2024-01-01T00:00:00.000000Z"
}Error Response
{
  "error": "error message",
  "details": {
    "field": "validation error message"
  }
}HTTP Status Codes
- 
200- Success
- 
201- Created
- 
204- No Content
- 
400- Bad Request
- 
401- Unauthorized
- 
404- Not Found
- 
422- Validation Error
- 
429- Rate Limited
- 
500- Internal Server Error
Endpoints
Aliases
Manage email aliases for your domains.
- Create Alias - Create a new email alias
- List Aliases - List all aliases for a domain
- Get Alias - Get details of a specific alias
- Update Alias - Update an existing alias
- Delete Alias - Delete an alias