ImprovMX Guides

https://improvmx.com/guides/
Admin
ImprovMX provides email forwarding services, allowing users to set up aliases, manage email routing,...
Tokens:37,750
Snippets:377
Trust Score:9.9
Update:10 months ago
Show doc for...
Tokens:
Raw
### Webhooks

Source: https://improvmx.com/guides/emails-refused-spamhaus

Endpoints for managing webhooks to receive real-time event notifications.

```APIDOC
## Webhooks API

### Description
Manage your ImprovMX webhooks to receive real-time notifications about events like email delivery, alias creation, and more. This allows for automated workflows and integrations.

### Method
GET, POST, DELETE

### Endpoint
`/api/v1/webhooks`

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body (for POST)
*   `url` (string) - Required - The URL to send webhook notifications to.
*   `events` (array) - Optional - A list of event types to subscribe to (e.g., `['email_delivered', 'alias_created']`). If not specified, all events are sent.

### Request Example (Create Webhook)
```json
{
  "url": "https://your-service.com/webhook-receiver",
  "events": ["email_delivered"]
}
```

### Response
#### Success Response (200)
*   `webhooks` (array) - A list of configured webhook objects.
    *   `id` (string) - Unique identifier for the webhook.
    *   `url` (string) - The registered webhook URL.
    *   `events` (array) - The list of subscribed event types.

#### Response Example (List Webhooks)
```json
{
  "webhooks": [
    {
      "id": "whk_abc",
      "url": "https://your-service.com/webhook-receiver",
      "events": ["email_delivered"]
    }
  ]
}
```

### Error Handling
*   400 Bad Request: Invalid URL or event types.
*   401 Unauthorized: Invalid API key.
*   409 Conflict: A webhook with the same URL already exists.
```

--------------------------------

### Managing Aliases

Source: https://improvmx.com/guides/emails-refused-spamhaus

Endpoints for creating, retrieving, updating, and deleting email aliases.

```APIDOC
## Aliases API

### Description
This section details the API endpoints for managing your email aliases within ImprovMX. You can create, view, modify, and remove aliases programmatically.

### Method
GET, POST, PUT, DELETE

### Endpoint
`/api/v1/aliases`

### Parameters
#### Path Parameters
N/A

#### Query Parameters
*   `domain` (string) - Optional - Filter aliases by a specific domain.

#### Request Body (for POST/PUT)
*   `source` (string) - Required - The email address or pattern to forward from.
*   `destination` (string) - Required - The email address to forward to.
*   `type` (string) - Optional - Type of alias ('catchall', 'regex', 'standard'). Defaults to 'standard'.

### Request Example (Create Alias)
```json
{
  "source": "info@example.com",
  "destination": "support@yourdomain.com"
}
```

### Response
#### Success Response (200)
*   `aliases` (array) - A list of alias objects.
    *   `id` (string) - Unique identifier for the alias.
    *   `source` (string) - The source email address or pattern.
    *   `destination` (string) - The destination email address.
    *   `type` (string) - The type of alias.

#### Response Example (List Aliases)
```json
{
  "aliases": [
    {
      "id": "alias_123",
      "source": "info@example.com",
      "destination": "support@yourdomain.com",
      "type": "standard"
    }
  ]
}
```

### Error Handling
*   400 Bad Request: Invalid input data.
*   401 Unauthorized: Invalid API key or insufficient permissions.
*   404 Not Found: Alias not found.
```

--------------------------------

### API Rate Limits

Source: https://improvmx.com/guides/emails-refused-spamhaus

Details on the rate limits imposed on API requests to ensure fair usage and system stability.

```APIDOC
## API Rate Limits

### Description
This section outlines the API rate limits that are in place. Understanding these limits is crucial for efficient and uninterrupted use of the ImprovMX API.

### Method
N/A (Informational)

### Endpoint
N/A (Informational)

### Parameters
N/A

### Request Example
N/A

### Response
N/A

**General Limits:**
*   **Requests per second:** X requests/sec per API key
*   **Requests per minute:** Y requests/min per API key
*   **Requests per hour:** Z requests/hour per API key

**Specific Endpoint Limits (if applicable):**
*   *Endpoint A*: Rate Limit Details
*   *Endpoint B*: Rate Limit Details

**Consequences of Exceeding Limits:**
*   Temporary IP/API key ban
*   Throttling of requests
*   Error responses (e.g., HTTP 429 Too Many Requests)
```

--------------------------------

### Add ImprovMX SPF TXT Record

Source: https://improvmx.com/guides/gsuite-legacy-free-edition-alternative

Add an SPF (Sender Policy Framework) TXT record to your DNS Zone to authorize ImprovMX to send emails on behalf of your domain. This helps prevent email spoofing and improves deliverability.

```text
TYPE  HOST  VALUE
TXT   @     v=spf1 include:spf.improvmx.com ~all
```

--------------------------------

### Add ImprovMX MX Records

Source: https://improvmx.com/guides/gsuite-legacy-free-edition-alternative

Configure your DNS Zone with ImprovMX's MX records for email routing. These records specify the mail servers responsible for accepting email for your domain, with different priorities to ensure redundancy.

```text
Host  Value             Priority
@     mx1.improvmx.com  10
@     mx2.improvmx.com  20
```
Tokens:
Raw