Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Delete a sms number

Requests carrier release and stops recurring number billing.

Requests carrier release and stops recurring number billing. Read status until retired_time is set. Historical messages stay readable.

  • Path DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers/sms-number
  • Scope notify:write
  • Effect destructive — a successful call removes data; the CLI asks before it runs.
  • Collection sms_numbers

#Request

FieldTypeWhat it is
namestringThe name of the number to release. Required.

#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/sms_numbers/sms-number" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"