Skip to content
Console
On this page

Delete a recipient

Deletes a recipient.

Deletes a recipient.

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

Request

FieldTypeWhat it is
namestringThe name of the recipient to delete. Required.
etagstringDelete only if the current etag matches.
allow_missingboolSucceed when the recipient does not exist.
validate_onlyboolValidate without deleting anything.
forceboolAlso delete the recipient's preferences and inbox items.

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/recipients/recipient" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"