Retire a phone number (soft, default) or hard-delete (force=true, internal only)
Changed onRetire (default) or hard-delete (force=true, internal only) a phone number.
Default — soft-retire (ENG-847, HV-17): flips status to RETIRED, tears down per-number SIP infra best-effort, stamps actor/timestamp, and keeps the row and every dependent evidence row (SMS/voice usage, and the ENG-846 durable chunk/attempt/outbox/operation chain) intact. This is now the day-to-day, audited, reversible path (see .../restore).
force=true is the internal-only escape hatch that performs the actual, permanent hard delete (evidence-safe: dependent SMS/voice usage rows detach via ON DELETE SET NULL rather than cascading away) — the explicit, policy-driven purge, not an accidental cascade. Non-internal callers that pass force=true are rejected with 403.
Request
- The document declares no server URL.
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Query parameters
Response
Successful Response
Changes
- info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status
- info