Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Delete a mailbox OAUTH app

Deletes a mailbox OAuth app; refused while a mailbox uses it.

Deletes a mailbox OAuth app; refused while a mailbox uses it.

  • Path DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_oauth_apps/mailbox-oauth-app
  • Scope notify:write
  • Effect destructive — a successful call removes data; the CLI asks before it runs.
  • Collection mailbox_oauth_apps
  • Query etag, allow_missing, validate_only

#Request

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

#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/mailbox_oauth_apps/mailbox-oauth-app" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"