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

# Register a 10DLC campaign under a brand

> Registers a US A2P 10DLC campaign under an already-registered brand. Supply the target `brand_id`, the use case, a description, sample messages, and the opt-in/help/opt-out language carriers require; the campaign is submitted to The Campaign Registry for CSP and per-MNO review. Political use cases must include a Campaign Verify `cv_token`. Owner/admin only.



## OpenAPI

````yaml /openapi.yaml post /api/v1/compliance/10dlc/campaign
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/compliance/10dlc/campaign:
    post:
      tags:
        - Compliance
      summary: Register a 10DLC campaign under a brand
      description: >-
        Registers a US A2P 10DLC campaign under an already-registered brand.
        Supply the target `brand_id`, the use case, a description, sample
        messages, and the opt-in/help/opt-out language carriers require; the
        campaign is submitted to The Campaign Registry for CSP and per-MNO
        review. Political use cases must include a Campaign Verify `cv_token`.
        Owner/admin only.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - brand_id
                - description
                - sample_message
                - message_flow
                - help_message
                - optout_message
              properties:
                brand_id:
                  type: string
                  description: Registrar brand id the campaign is registered under.
                usecase:
                  type: string
                  default: MIXED
                description:
                  type: string
                  minLength: 40
                sample_message:
                  type: array
                  items:
                    type: string
                  minItems: 1
                  maxItems: 10
                message_flow:
                  type: string
                  description: How recipients opt in to the campaign.
                help_message:
                  type: string
                optout_message:
                  type: string
                is_political:
                  type: boolean
                cv_token:
                  type: string
                  description: Campaign Verify JWT — required for political verticals.
            example:
              brand_id: BXYZ123
              usecase: MARKETING
              description: >-
                Order status alerts and promotional offers for Acme Rewards
                members.
              sample_message:
                - 'Acme: your order #1234 has shipped. Reply STOP to opt out.'
              message_flow: >-
                Users opt in at checkout by ticking the SMS updates box on
                acme.example.
              help_message: >-
                Acme: reply HELP for help or visit acme.example/support.
                Msg&data rates may apply.
              optout_message: You have been unsubscribed. Reply START to resubscribe.
      responses:
        '201':
          description: >-
            Campaign registration submitted. Returns the registrar campaign id
            and status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      campaignId:
                        type: string
                      status:
                        type: string
                      rejectionReason:
                        type: string
                        nullable: true
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
              example:
                data:
                  campaignId: CABC456
                  status: PENDING
                meta:
                  request_id: req_9s8d7f6g5h4j
                  timestamp: '2026-08-03T12:34:56.000Z'
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_*)

````