Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Delete a mailbox
Deletes a mailbox and its inbound email.
Deletes a mailbox and its inbound email.
- Path
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox - Scope
notify:write - Effect
destructive— a successful call removes data; the CLI asks before it runs. - Collection mailboxes
- Query
etag,allow_missing,validate_only,force
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the mailbox to delete. Required. |
etag | string | Delete only if the current etag matches. |
allow_missing | bool | Succeed when the mailbox does not exist. |
validate_only | bool | Validate without deleting anything. |
force | bool | Delete its inbound email with it; a mailbox holding inbound email is not deleted without it. |
#Response
The call answers with an empty object.
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.ETAG_MISMATCH— The etag sent does not match the Resource's current etag.RESOURCE_IN_USE— The Resource is attached to or held by another Resource, for example a volume attached to a running lease.
Every error arrives in the body Errors describes.
#Examples
curl -X DELETE "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox" \
-H "Authorization: Bearer $SYLPHX_API_KEY"