Skip to content
Console
On this page

Mail routes

A Route sends the mail a receiving Email Domain accepts for one address, a pattern of addresses, or every other address to actions: deliver…

A Route sends the mail a receiving Email Domain accepts for one address, a pattern of addresses, or every other address to actions: deliver to mailboxes, forward, or reject. Every accepted message also publishes sylphx.notify.inbound_email.received.

Service Sylphx Notify · Resource type notify.sylphx.com/Route · Name pattern orgs/{org}/projects/{project}/envs/{env}/mail_domains/{mail_domain}/mail_routes/{mail_route} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/mail_domains/{mail_domain}/mail_routes/{mail_route}.
uidstringrte_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specRouteSpecDesired state. Required.
statusRouteStatusObserved state. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a route.
GETlistLists an email domain's routes.
POSTcreateCreates a route.
PATCHupdateUpdates a route.
DELETEdeleteDeletes a route.

get

Gets a route.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mail_domains/mail-domain/mail_routes/mail-route · scope notify:read · effect read · Request, response and examples

list

Lists an email domain's routes.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mail_domains/mail-domain/mail_routes · scope notify:read · effect read · paginated · Request, response and examples

create

Creates a route.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mail_domains/mail-domain/mail_routes · scope notify:write · effect write · Request, response and examples

update

Updates a route.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mail_domains/mail-domain/mail_routes/mail-route · scope notify:write · effect write · Request, response and examples

delete

Deletes a route.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mail_domains/mail-domain/mail_routes/mail-route · scope notify:write · effect destructive · Request, response and examples