> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Suspend an active number

> Temporarily suspend an active number — stop inbound routing and outbound use WITHOUT releasing the DID back to inventory. Only a number in `active` status can be suspended; suspending a released / parked / pending number returns 409. The row flips to `suspended` and every inbound resolver + outbound from-number gate (which already whitelist `status='active'`) stops routing immediately. Org-ownership is enforced per call so a sibling sub-org sharing the tenant schema cannot pause a number it does not own. The inverse of `POST /api/v1/numbers/{id}/reactivate`. Scoped on `numbers:write` (owner / admin / developer).



## OpenAPI

````yaml /openapi.yaml post /api/v1/numbers/{id}/suspend
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
paths:
  /api/v1/numbers/{id}/suspend:
    post:
      tags:
        - Numbers
      summary: Suspend an active number
      description: >-
        Temporarily suspend an active number — stop inbound routing and outbound
        use WITHOUT releasing the DID back to inventory. Only a number in
        `active` status can be suspended; suspending a released / parked /
        pending number returns 409. The row flips to `suspended` and every
        inbound resolver + outbound from-number gate (which already whitelist
        `status='active'`) stops routing immediately. Org-ownership is enforced
        per call so a sibling sub-org sharing the tenant schema cannot pause a
        number it does not own. The inverse of `POST
        /api/v1/numbers/{id}/reactivate`. Scoped on `numbers:write` (owner /
        admin / developer).
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                reason:
                  type: string
                  maxLength: 500
                  description: >-
                    Optional free-text suspension note, persisted to the
                    lifecycle audit fields.
      responses:
        '200':
          description: The updated, suspended phone number record
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '404':
          description: No phone number with the given id exists in this tenant
        '409':
          description: The number is not in `active` status and cannot be suspended
components:
  schemas:
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````