Skip to main content
POST
/
v1
/
emails
/
forwarding-rules
Create forwarding rule
curl --request POST \
  --url https://api.emailr.dev/v1/emails/forwarding-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "from_pattern": "<string>",
  "to_addresses": [
    "jsmith@example.com"
  ],
  "active": true
}
'
{
  "id": "<string>",
  "success": true
}

Authorizations

​
Authorization
string
header
required

API key authentication. Use your API key as the bearer token.

Body

application/json
​
name
string
required
Minimum string length: 1
​
from_pattern
string
required
Minimum string length: 1
​
to_addresses
string<email>[]
required
Minimum array length: 1
​
active
boolean
default:true

Response

201 - application/json

Forwarding rule created

​
id
string
required
​
success
boolean
required