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

# Submit a port-out request for a number

> Start moving a number to another carrier without contacting support: the platform dispatches the port-out to the number's current provider and, on success, records the carrier-confirmed order id and FOC date. Requires the losing-carrier account number, an authorized signatory, and the winning carrier's OCN; include the port-out PIN when protection is enabled on the number.



## OpenAPI

````yaml /openapi.yaml post /api/v1/numbers/{id}/port-out
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
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/numbers/{id}/port-out:
    post:
      tags:
        - Numbers
      summary: Submit a port-out request for a number
      description: >-
        Start moving a number to another carrier without contacting support: the
        platform dispatches the port-out to the number's current provider and,
        on success, records the carrier-confirmed order id and FOC date.
        Requires the losing-carrier account number, an authorized signatory, and
        the winning carrier's OCN; include the port-out PIN when protection is
        enabled on the number.
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - losing_carrier_account_number
                - authorized_person
                - target_carrier_ocn
              properties:
                losing_carrier_account_number:
                  type: string
                  description: Account number with the number's current carrier.
                authorized_person:
                  type: string
                  description: Name of the LoA signatory authorizing the release.
                target_carrier_ocn:
                  type: string
                  description: Operating Company Number (OCN) of the winning carrier.
                port_out_pin:
                  type: string
                  description: >-
                    Required only when port-out PIN protection is enabled on the
                    number (4-32 characters).
            example:
              losing_carrier_account_number: '1234567890'
              authorized_person: Jane Operator
              target_carrier_ocn: '0451'
              port_out_pin: '8321'
      responses:
        '201':
          description: The carrier-confirmed port-out order
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      phoneNumber:
                        type: string
                      provider:
                        type: string
                        enum:
                          - telnyx
                          - didww
                      providerOrderId:
                        type: string
                      providerStatus:
                        type: string
                      focDate:
                        type: string
                        format: date-time
                        nullable: true
                      portStatus:
                        type: string
                        example: port_out_pending
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
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_*)

````