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

# Update Flow

> Renames and/or re-categorises a Flow that is still in `DRAFT`. Accepts **exactly** `name` and `categories` — and the omission is the guard: publishing is irreversible, so it has its own route (`POST /v1/flows/{id}/publish`), as does deprecating. An unknown field is REFUSED with 400 `FLOW_UNKNOWN_FIELDS`, never ignored. Sending neither field is 400 `FLOW_PATCH_EMPTY` — not a 200 over a change that never happened. Permission `flows:manage`.

**Requires a number-scoped key.** A tenant-scoped key must name the number with the `x-whatsapp-number-id` header, or it gets 403 `TENANT_SCOPE_NOT_ALLOWED`.



## OpenAPI

````yaml openapi.json PATCH /v1/flows/{id}
openapi: 3.1.0
info:
  title: Pilot Status API
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    Public REST API for Pilot Status. Authenticate with the `x-api-key: ps_...`
    header (or `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/flows/{id}:
    patch:
      tags:
        - Flows
      summary: Update Flow
      description: >-
        Renames and/or re-categorises a Flow that is still in `DRAFT`. Accepts
        **exactly** `name` and `categories` — and the omission is the guard:
        publishing is irreversible, so it has its own route (`POST
        /v1/flows/{id}/publish`), as does deprecating. An unknown field is
        REFUSED with 400 `FLOW_UNKNOWN_FIELDS`, never ignored. Sending neither
        field is 400 `FLOW_PATCH_EMPTY` — not a 200 over a change that never
        happened. Permission `flows:manage`.


        **Requires a number-scoped key.** A tenant-scoped key must name the
        number with the `x-whatsapp-number-id` header, or it gets 403
        `TENANT_SCOPE_NOT_ALLOWED`.
      operationId: patch_flows_id
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            The **local** id of the Flow — the `id` field `GET /v1/flows`
            returns, never `metaFlowId`.
          schema:
            type: string
          example: cmf1a2b3c4d5e6f7g8h9i0j1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  description: New name. Empty or whitespace-only is refused.
                  example: Agendamento (matriz)
                categories:
                  type: array
                  minItems: 1
                  items:
                    type: string
                    enum:
                      - SIGN_UP
                      - SIGN_IN
                      - APPOINTMENT_BOOKING
                      - LEAD_GENERATION
                      - CONTACT_US
                      - CUSTOMER_SUPPORT
                      - SURVEY
                      - OTHER
                  example:
                    - APPOINTMENT_BOOKING
            example:
              name: Agendamento (matriz)
              categories:
                - APPOINTMENT_BOOKING
      responses:
        '200':
          description: Flow updated
          content:
            application/json:
              example:
                ok: true
                id: cmf1a2b3c4d5e6f7g8h9i0j1
        '400':
          description: >-
            `FLOW_NAME_INVALID`, `FLOW_CATEGORY_INVALID`, `FLOW_PATCH_EMPTY`,
            `FLOW_UNKNOWN_FIELDS`, `FLOW_NUMBER_FROM_KEY` (in the body **or**
            the query), or a Meta refusal
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Portuguese half
                  errorEN:
                    type: string
                    description: English half
                  code:
                    type: string
              example:
                error: 'Nada a atualizar: envie name e/ou categories.'
                errorEN: 'Nothing to update: provide name and/or categories.'
                code: FLOW_PATCH_EMPTY
        '401':
          description: Missing or invalid `x-api-key` / `x-api-key-id` header
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: >-
            Tenant-scoped key used on a number-scoped endpoint, or the key's
            role lacks the permission
          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: >-
            No Flow with that id inside the key's own WABA. Never 403: a Flow of
            another tenant is indistinguishable from one that does not exist, on
            purpose — a 403 would confirm someone else's id to whoever guessed
            it
          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: >-
            The Flow has left `DRAFT`. Publishing is irreversible on Meta —
            clone it to start a new version
          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: >-
            The key's number is not a Meta (Cloud API) number, or has no WABA
            behind it
          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: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
        '500':
          description: >-
            Internal error. Never carries the internal message — that belongs in
            the 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: Your ps_ API key
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: API key id (alternative to x-api-key)

````