Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Delete a mail route

Deletes a route.

Deletes a route.

  • Path 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 — a successful call removes data; the CLI asks before it runs.
  • Collection mail_routes
  • Query etag, allow_missing, validate_only

#Request

FieldTypeWhat it is
namestringThe name of the route to delete. Required.
etagstringDelete only if the current etag matches.
allow_missingboolSucceed when the route does not exist.
validate_onlyboolValidate without deleting anything.

#Response

The call answers with an empty object.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl -X DELETE "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mail_domains/mail-domain/mail_routes/mail-route" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"