> ## 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.

# Set the scheduled release for a number

> Schedule (or replace) a FUTURE automatic release of a tenant-owned DID for cost / capacity planning. `release_at` must be a strictly-future ISO-8601 timestamp within 730 days; an out-of-range or past date returns 422. The number is NOT released on write — it is captured with `status: scheduled` and actioned later by the due-date sweeper. Org-ownership is enforced; scoped on `numbers:write` (owner / admin / developer).



## OpenAPI

````yaml /openapi.yaml put /api/v1/numbers/{id}/scheduled-release
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}/scheduled-release:
    put:
      tags:
        - Numbers
      summary: Set the scheduled release for a number
      description: >-
        Schedule (or replace) a FUTURE automatic release of a tenant-owned DID
        for cost / capacity planning. `release_at` must be a strictly-future
        ISO-8601 timestamp within 730 days; an out-of-range or past date returns
        422. The number is NOT released on write — it is captured with `status:
        scheduled` and actioned later by the due-date sweeper. Org-ownership is
        enforced; scoped on `numbers:write` (owner / admin / developer).
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - release_at
              properties:
                release_at:
                  type: string
                  format: date-time
                  description: >-
                    Strictly-future ISO-8601 instant at which the held DID
                    should auto-release back to inventory (within 730 days from
                    now).
                reason:
                  type: string
                  minLength: 1
                  maxLength: 280
                  description: Optional operator capacity-planning note.
      responses:
        '200':
          description: The persisted scheduled release
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      scheduled_release:
                        $ref: '#/components/schemas/StoredScheduledRelease'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '404':
          description: No phone number with the given id exists in this tenant
        '422':
          description: >-
            release_at is missing, not a valid ISO-8601 timestamp, in the past,
            or more than 730 days in the future
components:
  schemas:
    StoredScheduledRelease:
      type: object
      required:
        - release_at
        - reason
        - status
        - scheduled_at
        - updated_at
      additionalProperties: false
      description: >-
        A pending future auto-release captured on a tenant-owned DID
        (`phone_numbers.metadata.scheduled_release`). The number is NOT released
        on write — a separate due-date sweeper runs the existing release
        pipeline when `release_at` arrives. Mirrors the backend
        `StoredScheduledRelease`.
      properties:
        release_at:
          type: string
          format: date-time
          description: >-
            Normalised UTC ISO-8601 instant at which the held DID is scheduled
            to auto-release back to inventory.
        reason:
          type: string
          nullable: true
          maxLength: 280
          description: Optional operator capacity-planning note, or null.
        status:
          type: string
          enum:
            - scheduled
            - released
            - cancelled
            - failed
          description: >-
            Lifecycle status. Always `scheduled` when first captured; the
            remaining values are produced by the due-date release sweeper.
        scheduled_at:
          type: string
          format: date-time
          description: When the schedule was first attached.
        updated_at:
          type: string
          format: date-time
          description: When the schedule was last mutated.
    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_*)

````