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

> Create a new automation flow at version 1 in `draft` status. Supply a `name`, the builder `definition` graph (`nodes` + `edges`), and a `trigger_type`. When `trigger_type` is `schedule` a valid 5-field `cron_expr` is required (with an optional IANA `cron_tz`, default UTC). Requires an operator role (owner / admin / developer) and the `flows:write` scope.



## OpenAPI

````yaml /openapi.yaml post /api/v1/flows/
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/flows/:
    post:
      tags:
        - Flows
      summary: Create a flow
      description: >-
        Create a new automation flow at version 1 in `draft` status. Supply a
        `name`, the builder `definition` graph (`nodes` + `edges`), and a
        `trigger_type`. When `trigger_type` is `schedule` a valid 5-field
        `cron_expr` is required (with an optional IANA `cron_tz`, default UTC).
        Requires an operator role (owner / admin / developer) and the
        `flows:write` scope.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - definition
                - trigger_type
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 200
                description:
                  type: string
                  maxLength: 1000
                definition:
                  type: object
                  description: Builder graph — `nodes` and `edges`.
                trigger_type:
                  type: string
                  enum:
                    - manual
                    - webhook
                    - schedule
                    - event
                    - workflow
                cron_expr:
                  type: string
                  maxLength: 200
                  description: >-
                    5-field cron expression; required when `trigger_type` is
                    `schedule`.
                cron_tz:
                  type: string
                  maxLength: 64
                  description: IANA timezone for `cron_expr` (defaults to UTC).
            example:
              name: Welcome SMS
              description: Send a welcome SMS when a new contact is created.
              trigger_type: event
              definition:
                nodes:
                  - id: trigger-1
                    type: trigger
                    data:
                      label: Trigger
                      triggerType: Incoming SMS
                  - id: sendSms-1
                    type: sendSms
                    data:
                      label: Send Welcome SMS
                      to: '{{phone}}'
                      body: Welcome to {{company}}!
                edges:
                  - id: e-trigger-sms
                    source: trigger-1
                    target: sendSms-1
      responses:
        '201':
          description: The created flow.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Flow'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
components:
  schemas:
    Flow:
      type: object
      description: >-
        A saved automation flow — its builder graph (`definition`), trigger
        configuration, lifecycle status, and current version.
      properties:
        id:
          type: string
          description: Flow identifier (prefixed `flow_`).
        name:
          type: string
        description:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - draft
            - published
            - archived
          description: Lifecycle state. Only `published` flows execute live.
        definition:
          type: object
          description: >-
            The builder graph describing triggers, messaging / agent / delay /
            condition steps and their connections.
          properties:
            nodes:
              type: array
              items:
                type: object
            edges:
              type: array
              items:
                type: object
        trigger_type:
          type: string
          enum:
            - manual
            - webhook
            - schedule
            - event
            - workflow
          description: How the flow is entered.
        trigger_config:
          type: object
          nullable: true
        cron_expr:
          type: string
          nullable: true
          description: 5-field cron expression; present when `trigger_type` is `schedule`.
        cron_tz:
          type: string
          nullable: true
          description: IANA timezone for `cron_expr` (defaults to UTC).
        last_scheduled_run_at:
          type: string
          format: date-time
          nullable: true
        version:
          type: integer
          nullable: true
        published_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          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
  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_*)

````