Create a forwarding rule
Creates an inbound email forwarding rule and returns it.
Creates an inbound email forwarding rule and returns it. Responds with 201. Priority is a non-negative integer, default 0; higher priority rules are tried first, and at equal priority an exact address outranks a wildcard pattern. An organization holds at most 100 forwarding rules.
Authorization
apiKey x-api-key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
name*string
description?string|null
domainId?|null
sourcePattern?string|null
forwardTo*array<string>
preserveHeaders?boolean|null
appendNote?string|null
conditions?|null
priority?|null
isActive?boolean|null
metadata?|null|null
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/email/forwarding" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "forwardTo": [ "string" ] }'{ "id": "string", "name": "string", "forwardTo": [ "string" ], "priority": 0, "isActive": true, "createdAt": "string"}