Add a forwarding rule to a domain

POST

inbound

domains

{uuid}

forward-rules

curl --request POST \
  --url https://api.jetemail.com/inbound/domains/{uuid}/forward-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "localpart": "support",
  "destination": "team@theirinbox.com"
}
'

{
  "success": true,
  "result": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "localpart": "<string>",
    "destination": "*@theirinbox.com",
    "last_modified": 123,
    "created_at": 123
  }
}

{
  "success": false,
  "error": "destination must be a bare email address (local@domain) or wildcard destination (*@domain)"
}

{
  "success": false,
  "error": "User information not found"
}

{
  "success": false,
  "error": "Domain not found"
}

{
  "success": false,
  "error": "A forwarding rule with this localpart and destination already exists"
}

{
  "success": false,
  "error": "Failed to create forwarding rule"
}

Authorizations

Authorization

string

header

required

API key for account management endpoints. Use your api_ prefixed token.

Path Parameters

uuid

string<uuid>

required

UUID of the domain

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Body

application/json

localpart

string

required

Address prefix to match. Use the literal "*" for catch-all. Otherwise must be a valid RFC 5321 local-part (max 64 chars). Stored lowercased; plus-addressing is handled at match time, so a rule for "support" also matches "support+anything".

Example:

"support"

destination

string

required

Bare email address (local@domain), or wildcard destination (*@domain). No display names, no quoted local-parts.

Example:

"team@theirinbox.com"

active

boolean

default:true

Inactive rules are stored but ignored at RCPT TO. Use this for soft-disable rather than DELETE if you plan to re-enable.

Response

Rule created

success

boolean

Example:

true

result

object

Show child attributes

curl --request POST \
  --url https://api.jetemail.com/inbound/domains/{uuid}/forward-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "localpart": "support",
  "destination": "team@theirinbox.com"
}
'

{
  "success": true,
  "result": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "localpart": "<string>",
    "destination": "*@theirinbox.com",
    "last_modified": 123,
    "created_at": 123
  }
}

{
  "success": false,
  "error": "destination must be a bare email address (local@domain) or wildcard destination (*@domain)"
}

{
  "success": false,
  "error": "User information not found"
}

{
  "success": false,
  "error": "Domain not found"
}

{
  "success": false,
  "error": "A forwarding rule with this localpart and destination already exists"
}

{
  "success": false,
  "error": "Failed to create forwarding rule"
}

Overview

Endpoints

Add a forwarding rule to a domain

Authorizations

Path Parameters

Body

Response