> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pilotstatus.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Publicar Flow

> Publica o Flow na Meta. **IRREVERSÍVEL**: um Flow publicado nunca mais é editado nem despublicado — só clonado num novo (`POST /v1/flows` com `cloneFromFlowId`).

**`confirm: true` é obrigatório, estritamente.** A checagem é `=== true`, então `"true"`, `1` e `{}` são todos recusados: o custo de aceitar de menos é um 400, o de aceitar demais é um Flow que ninguém despublica. Sem o campo, a resposta é 400 `FLOW_PUBLISH_REQUIRES_CONFIRMATION`.

Corpo truncado não é lido como corpo vazio — o payload é parseado do texto cru, então `{"confirm": true` (uma chave faltando) dá 400 `FLOW_BODY_INVALID` em vez de um confuso "confirmação necessária". Nunca alcançável por `PATCH`. Permissão `flows:manage`.

**Exige chave com escopo de número.** Uma chave de tenant precisa nomear o número no header `x-whatsapp-number-id`, senão recebe 403 `TENANT_SCOPE_NOT_ALLOWED`.



## OpenAPI

````yaml openapi.pt.json POST /v1/flows/{id}/publish
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/flows/{id}/publish:
    post:
      tags:
        - Flows
      summary: Publicar Flow
      description: >-
        Publica o Flow na Meta. **IRREVERSÍVEL**: um Flow publicado nunca mais é
        editado nem despublicado — só clonado num novo (`POST /v1/flows` com
        `cloneFromFlowId`).


        **`confirm: true` é obrigatório, estritamente.** A checagem é `===
        true`, então `"true"`, `1` e `{}` são todos recusados: o custo de
        aceitar de menos é um 400, o de aceitar demais é um Flow que ninguém
        despublica. Sem o campo, a resposta é 400
        `FLOW_PUBLISH_REQUIRES_CONFIRMATION`.


        Corpo truncado não é lido como corpo vazio — o payload é parseado do
        texto cru, então `{"confirm": true` (uma chave faltando) dá 400
        `FLOW_BODY_INVALID` em vez de um confuso "confirmação necessária". Nunca
        alcançável por `PATCH`. Permissão `flows:manage`.


        **Exige chave com escopo de número.** Uma chave de tenant precisa nomear
        o número no header `x-whatsapp-number-id`, senão recebe 403
        `TENANT_SCOPE_NOT_ALLOWED`.
      operationId: post_flows_id_publish
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O id **local** do Flow — o campo `id` que `GET /v1/flows` devolve,
            nunca o `metaFlowId`.
          schema:
            type: string
          example: cmf1a2b3c4d5e6f7g8h9i0j1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - confirm
              properties:
                confirm:
                  type: boolean
                  enum:
                    - true
                  description: >-
                    Tem de ser o booleano `true`, exatamente. Reconhece que
                    publicar não tem volta.
                  example: true
            example:
              confirm: true
      responses:
        '200':
          description: Flow publicado na Meta. Irreversível
          content:
            application/json:
              example:
                flowId: cmf1a2b3c4d5e6f7g8h9i0j1
                published: true
        '400':
          description: >-
            `FLOW_PUBLISH_REQUIRES_CONFIRMATION`, `FLOW_BODY_INVALID`,
            `FLOW_UNKNOWN_FIELDS`, `FLOW_NUMBER_FROM_KEY`, ou recusa da Meta
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Portuguese half
                  errorEN:
                    type: string
                    description: English half
                  code:
                    type: string
              example:
                error: >-
                  Publicar é irreversível: um Flow publicado não pode mais ser
                  editado, apenas clonado. Envie `"confirm": true` (booleano,
                  exatamente) para prosseguir.
                errorEN: >-
                  Publishing is irreversible: a published Flow can no longer be
                  edited, only cloned. Send `"confirm": true` (a boolean,
                  exactly) to proceed.
                code: FLOW_PUBLISH_REQUIRES_CONFIRMATION
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: >-
            Chave com escopo de tenant usada em endpoint com escopo de número,
            ou o papel da chave não tem a permissão
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Tenant-scoped keys cannot call number endpoints
                code: TENANT_SCOPE_NOT_ALLOWED
        '404':
          description: >-
            Nenhum Flow com esse id dentro da WABA da própria chave. Nunca 403:
            um Flow de outro tenant é indistinguível de um que não existe, de
            propósito — um 403 confirmaria o id alheio a quem o adivinhou
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Portuguese half
                  errorEN:
                    type: string
                    description: English half
                  code:
                    type: string
              example:
                error: Flow não encontrado para o número desta chave.
                errorEN: Flow not found for this key's number.
                code: FLOW_NOT_FOUND
        '409':
          description: >-
            O Flow saiu de `DRAFT`. Publicar é irreversível na Meta — clone para
            começar uma versão nova
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Portuguese half
                  errorEN:
                    type: string
                    description: English half
                  code:
                    type: string
              example:
                error: >-
                  Este Flow já foi publicado na Meta e não pode mais ser
                  alterado. Clone-o para criar uma nova versão.
                errorEN: >-
                  This Flow is already published on Meta and can no longer be
                  changed. Clone it to create a new version.
                code: FLOW_NOT_DRAFT
        '422':
          description: >-
            O número da chave não é Meta (API Oficial), ou não tem WABA
            associada
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Portuguese half
                  errorEN:
                    type: string
                    description: English half
                  code:
                    type: string
              example:
                error: >-
                  Flows existem apenas em números Meta (API Oficial). O número
                  desta chave não é Meta ou não tem uma WABA associada — use uma
                  chave de um número Meta.
                errorEN: >-
                  Flows only exist on Meta (Cloud API) numbers. This key's
                  number is not a Meta number, or has no WABA behind it — use a
                  key bound to a Meta number.
                code: FLOW_REQUIRES_META_NUMBER
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
        '500':
          description: Erro interno. Nunca carrega a mensagem interna — essa fica no log
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Portuguese half
                  errorEN:
                    type: string
                    description: English half
                  code:
                    type: string
              example:
                error: Erro interno do servidor.
                errorEN: Internal server error.
                code: INTERNAL_ERROR
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````