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

# Ativar flow

> Ativa um flow revisado, que passa a enviar mensagens reais. Exige a revision revisada pela pessoa; se o flow mudou depois dela, a chamada falha com 409 e informa a revisão atual. Faz as mesmas verificações do botão Ativar no editor. Exige uma API key com o escopo write.



## OpenAPI

````yaml /openapi.json post /v1/flows/{flow_id}/activate
openapi: 3.1.0
info:
  title: Bevits API
  version: 1.0.0
  description: >-
    API pública para consultar dados de CRM, compras e automação de uma
    organização Bevits e criar automações como rascunho para revisão e ativação.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.bevits.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Sistema
    description: Disponibilidade da API.
  - name: Identidade
    description: Identidade da organização e da API key.
  - name: Clientes
    description: Clientes e suas relações.
  - name: Segmentos
    description: Segmentos de clientes.
  - name: Compras
    description: Compras importadas das integrações.
  - name: Dados do CRM
    description: Tags e definições de atributos.
  - name: Automações
    description: Flows de automação.
  - name: Campanhas
    description: Campanhas de e-mail.
paths:
  /v1/flows/{flow_id}/activate:
    post:
      tags:
        - Automações
      summary: Ativar flow
      description: >-
        Ativa um flow revisado, que passa a enviar mensagens reais. Exige a
        revision revisada pela pessoa; se o flow mudou depois dela, a chamada
        falha com 409 e informa a revisão atual. Faz as mesmas verificações do
        botão Ativar no editor. Exige uma API key com o escopo write.
      operationId: activateFlow
      parameters:
        - $ref: '#/components/parameters/FlowId'
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivateFlowRequest'
            example:
              revision: rev_3f9a1c2b7d4e
      responses:
        '200':
          $ref: '#/components/responses/Flow'
        '400':
          $ref: '#/components/responses/InvalidBody'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/WriteScopeRequired'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/RevisionConflict'
        '422':
          $ref: '#/components/responses/FlowValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    FlowId:
      name: flow_id
      in: path
      required: true
      description: ID público do flow.
      schema:
        type: string
        pattern: ^flw_[A-Za-z0-9_-]+$
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      description: >-
        Chave única da operação. Repetir a mesma chave com o mesmo corpo devolve
        a resposta original em vez de executar de novo.
      schema:
        type: string
  schemas:
    ActivateFlowRequest:
      type: object
      required:
        - revision
      properties:
        revision:
          type: string
          pattern: ^rev_[0-9a-f]+$
          description: >-
            Revisão revisada pela pessoa, retornada na criação do rascunho ou na
            consulta do flow.
    Flow:
      type: object
      required:
        - object
        - id
        - status
        - created_at
        - updated_at
        - html_url
      properties:
        object:
          type: string
          const: flow
        id:
          type: string
          pattern: ^flw_[A-Za-z0-9_-]+$
        name:
          type: string
        description:
          type: string
        status:
          type: string
        trigger_event_type:
          type: string
        origin:
          type: string
        run_count:
          deprecated: true
          description: >-
            Campo legado descontinuado, mantido por compatibilidade. Quando
            presente, retorna sempre 0; não representa o total real de
            execuções.
          type: integer
          minimum: 0
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        html_url:
          type: string
          format: uri
        revision:
          type: string
          description: >-
            Identifica o conteúdo atual do flow (blocos e conexões). Informe-a
            ao ativar o flow para garantir que só o conteúdo revisado entre no
            ar.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
    RateLimitErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          required:
            - retry_after
          properties:
            retry_after:
              type: integer
              minimum: 1
              description: Segundos até uma nova tentativa.
    Error:
      type: object
      required:
        - type
        - message
        - request_id
      properties:
        type:
          type: string
          enum:
            - authentication_error
            - conflict
            - internal_error
            - invalid_request
            - not_found
            - permission_denied
            - rate_limited
            - validation_error
        message:
          type: string
        param:
          type: string
        request_id:
          type: string
          pattern: ^req_[a-f0-9]{24}$
  responses:
    Flow:
      description: Flow encontrado.
      headers:
        ETag:
          $ref: '#/components/headers/ETag'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Flow'
    InvalidBody:
      description: >-
        Corpo da requisição ausente, que não é um objeto JSON, ou parâmetro de
        rota inválido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: API key ausente, inválida, expirada ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: authentication_error
              message: Invalid API key.
              request_id: req_07f6cdc3c20249d6afcd90b4
    WriteScopeRequired:
      description: A API key não tem o escopo write.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: permission_denied
              message: This API key does not have the required "write" scope.
              param: scope
              request_id: req_07f6cdc3c20249d6afcd90b4
    NotFound:
      description: Recurso inexistente ou pertencente a outra organização.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RevisionConflict:
      description: >-
        O flow mudou depois da revision informada. A mensagem traz a revisão
        atual; peça uma nova revisão antes de ativar.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: conflict
              message: >-
                The flow changed after revision rev_3f9a1c2b7d4e; its current
                revision is rev_9b2e7c1a5f30.
              param: revision
              request_id: req_07f6cdc3c20249d6afcd90b4
    FlowValidationError:
      description: >-
        O flow não pode ser criado ou ativado. A mensagem lista todos os
        problemas, cada um com o caminho, a chave do bloco e as opções válidas.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: Limite de requisições excedido.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
    InternalError:
      description: Erro inesperado no servidor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  headers:
    ETag:
      description: Identificador da versão do conteúdo para cache condicional.
      schema:
        type: string
        example: '"v1-4ad31f5efb6b8f35"'
    RetryAfter:
      description: Segundos até uma nova tentativa.
      schema:
        type: integer
        minimum: 1
    RateLimitLimit:
      description: Limite total da janela atual.
      schema:
        type: integer
        example: 600
    RateLimitRemaining:
      description: Requisições restantes na janela atual.
      schema:
        type: integer
        example: 599
    RateLimitReset:
      description: Instante UTC em que a janela atual termina.
      schema:
        type: string
        format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: bvt_live_...
      description: API key criada nas configurações da organização.

````

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