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

# Create a tracking pool

> Create a tracking pool binding a marketing source/campaign to a match rule set the DNI snippet uses to decide when to swap the displayed number. Newly created pools have no tracking DIDs — assign them separately. Owner/admin/developer only.



## OpenAPI

````yaml /openapi.yaml post /api/v1/numbers/tracking-pools
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/tracking-pools:
    post:
      tags:
        - Numbers
      summary: Create a tracking pool
      description: >-
        Create a tracking pool binding a marketing source/campaign to a match
        rule set the DNI snippet uses to decide when to swap the displayed
        number. Newly created pools have no tracking DIDs — assign them
        separately. Owner/admin/developer only.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - label
                - source
              properties:
                label:
                  type: string
                  minLength: 1
                  maxLength: 120
                source:
                  type: string
                  minLength: 1
                  maxLength: 120
                campaign:
                  type: string
                  maxLength: 200
                medium:
                  type: string
                  maxLength: 120
                match:
                  $ref: '#/components/schemas/TrackingPoolMatch'
                swapStrategy:
                  type: string
                  enum:
                    - sticky
                    - fixed
                enabled:
                  type: boolean
      responses:
        '201':
          description: The created tracking pool.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/TrackingPool'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '422':
          $ref: '#/components/responses/StandardError'
        '429':
          $ref: '#/components/responses/StandardError'
components:
  schemas:
    TrackingPoolMatch:
      type: object
      description: >-
        Match rule set the DNI resolver scores a visitor against. A pool matches
        when EVERY defined condition holds; an undefined condition is "don't
        care".
      properties:
        utmSource:
          type: string
          maxLength: 200
        utmMedium:
          type: string
          maxLength: 200
        utmCampaign:
          type: string
          maxLength: 200
        utmTerm:
          type: string
          maxLength: 200
        referrerContains:
          type: string
          maxLength: 300
          description: >-
            Case-insensitive substring of the document referrer (e.g.
            "google.").
        requireGclid:
          type: boolean
          description: >-
            When true, the pool only matches if a Google click id (gclid) is
            present.
    TrackingPool:
      type: object
      description: >-
        A CXaaS call-tracking (Dynamic Number Insertion) pool — a marketing
        source/campaign bound to a set of swappable inbound tracking DIDs.
        Persists in org-settings JSONB. Inbound termination only (Invariant
        #45): a tracking pool never wires an outbound (MT) voice/SMS path.
      required:
        - id
        - label
        - source
        - match
        - trackingDids
        - swapStrategy
        - enabled
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          description: Tracking-pool id.
        label:
          type: string
          description: Operator-facing label (e.g. "Google Ads — Brand").
        source:
          type: string
          description: Marketing source this pool attributes its inbound calls to.
        campaign:
          type: string
          description: Optional campaign the calls attribute to (paired with source).
        medium:
          type: string
          description: Optional marketing medium (cpc / organic / email …).
        match:
          $ref: '#/components/schemas/TrackingPoolMatch'
        trackingDids:
          type: array
          description: Swappable tracking DIDs (E.164) shown to matching visitors.
          items:
            type: string
        swapStrategy:
          type: string
          enum:
            - sticky
            - fixed
          description: >-
            "sticky" pins a visitor session to one DID via a deterministic hash
            of the session key; "fixed" always shows the pool's first DID.
        enabled:
          type: boolean
          description: Disabled pools are skipped by the resolver but retained for history.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    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
  responses:
    StandardError:
      description: >-
        Standard error envelope. `error.code` is machine-readable; see the
        [error reference](https://docs.orbit.devotel.io/reference/error-codes)
        for the catalogue.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                required:
                  - code
                  - message
                  - status
                properties:
                  code:
                    type: string
                    description: Machine-readable error code (e.g. INVALID_PHONE_NUMBER)
                  message:
                    type: string
                    description: Human-readable error description
                  status:
                    type: integer
                    description: HTTP status code
                  details:
                    type: object
                    additionalProperties: true
                    description: Additional context about the error
              meta:
                type: object
                properties:
                  request_id:
                    type: string
                  timestamp:
                    type: string
                    format: date-time
                  docs_url:
                    type: string
                    format: uri
                    description: Link to relevant error documentation
  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_*)

````