> ## Documentation Index
> Fetch the complete documentation index at: https://omniflow-vpn.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Post v1panelbulk

> Requires customers.write, a reason, and an idempotency key. This only previews: nothing is applied until the operation is started, and only a previewed operation may start.



## OpenAPI

````yaml https://raw.githubusercontent.com/kewldan/omniflow/main/api/openapi.yaml post /v1/panel/bulk
openapi: 3.0.3
info:
  title: Omniflow API
  version: 1.0.0
  description: >-
    Customer, commerce, payment, wallet, fulfillment, and operations API for
    Omniflow.
servers: []
security: []
paths:
  /v1/panel/bulk:
    post:
      tags:
        - panel
      description: >-
        Requires customers.write, a reason, and an idempotency key. This only
        previews: nothing is applied until the operation is started, and only a
        previewed operation may start.
      operationId: previewPanelBulkOperation
      parameters:
        - $ref: '#/components/parameters/CSRFToken'
        - $ref: '#/components/parameters/IdempotencyKey'
        - $ref: '#/components/parameters/OperatorReason'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PanelBulkInput'
      responses:
        '201':
          description: Previewed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PanelBulkOperation'
        '403':
          $ref: '#/components/responses/Problem'
        '422':
          $ref: '#/components/responses/Problem'
components:
  parameters:
    CSRFToken:
      in: header
      name: X-CSRF-Token
      required: true
      description: >-
        Echoes the token from the current session. Required on every unsafe
        method.
      schema:
        type: string
    IdempotencyKey:
      in: header
      name: Idempotency-Key
      required: true
      schema:
        type: string
        minLength: 8
        maxLength: 128
    OperatorReason:
      in: header
      name: X-Operator-Reason
      required: true
      description: >-
        Why the change is being made. Carried as a header because almost every
        operations mutation needs one; the API refuses a change that requires a
        reason and did not get one.
      schema:
        type: string
        minLength: 1
        maxLength: 400
  schemas:
    PanelBulkInput:
      type: object
      required:
        - kind
        - targets
      properties:
        kind:
          type: string
          enum:
            - customer_export
            - subscription_extend
            - subscription_disable
            - subscription_enable
            - wallet_credit
        targets:
          type: array
          minItems: 1
          maxItems: 1000
          items:
            $ref: '#/components/schemas/PanelBulkTarget'
        parameters:
          type: object
          additionalProperties: true
    PanelBulkOperation:
      type: object
      required:
        - id
        - kind
        - status
        - requestedBy
        - reason
        - total
        - succeeded
        - failed
        - skipped
        - createdAt
      properties:
        id:
          type: string
          format: uuid
        kind:
          type: string
        status:
          type: string
          enum:
            - previewing
            - ready
            - running
            - completed
            - failed
            - cancelled
        requestedBy:
          type: string
          format: uuid
        reason:
          type: string
        parameters:
          type: object
          additionalProperties: true
        total:
          type: integer
        succeeded:
          type: integer
        failed:
          type: integer
        skipped:
          type: integer
        createdAt:
          type: string
          format: date-time
        completedAt:
          type: string
          format: date-time
    PanelBulkTarget:
      type: object
      required:
        - type
        - id
      properties:
        type:
          type: string
          enum:
            - customer
            - subscription
        id:
          type: string
          format: uuid
    Problem:
      type: object
      required:
        - type
        - title
        - status
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        request_id:
          type: string
  responses:
    Problem:
      description: Request failed
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.