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

# Adicionar um novo automation rule

> Adicionar uma nova regra de automação à conta



## OpenAPI

````yaml /pt-br/swagger/tag_groups/application_swagger.json post /api/v1/accounts/{account_id}/automation_rules
openapi: 3.1.0
info:
  title: Chatwoot
  description: Esta é a documentação da API para o servidor Chatwoot.
  version: 1.1.0
  termsOfService: https://www.chatwoot.com/terms-of-service/
  contact:
    email: hello@chatwoot.com
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://airys.chat/
security: []
tags:
  - name: AgentBots de Conta
    description: Agent Bots específicos da conta
  - name: Agentes
    description: APIs de gerenciamento de agentes
  - name: Respostas Prontas
    description: Respostas predefinidas para consultas comuns
  - name: Contatos
    description: APIs de gerenciamento de contatos
  - name: Rótulos de Contato
    description: Gerenciar rótulos de contato
  - name: Atribuições de Conversa
    description: Gerenciar atribuições de conversas
  - name: Rótulos de Conversa
    description: Gerenciar rótulos de conversas
  - name: Conversas
    description: APIs de gerenciamento de conversas
  - name: Atributos Personalizados
    description: Campos personalizados para contatos e conversas
  - name: Filtros Personalizados
    description: Filtros salvos para conversas
  - name: Caixas de Entrada
    description: Configuração de canais de comunicação
  - name: Integrações
    description: Integrações de terceiros
  - name: Rótulos
    description: APIs de gerenciamento de rótulos da conta
  - name: Mensagens
    description: APIs de gerenciamento de mensagens
  - name: Perfil
    description: APIs de perfil de usuário
  - name: Relatórios
    description: APIs de análise e relatórios
  - name: Equipes
    description: APIs de gerenciamento de equipe
  - name: Webhooks
    description: Webhooks de notificação de eventos
  - name: Regra de Automação
    description: Regras de automação de fluxo de trabalho
  - name: Central de Ajuda
    description: Gerenciamento da base de conhecimento
paths:
  /api/v1/accounts/{account_id}/automation_rules:
    parameters:
      - $ref: '#/components/parameters/account_id'
    post:
      tags:
        - Regra de Automação
      summary: Adicionar um novo automation rule
      description: Adicionar uma nova regra de automação à conta
      operationId: add-new-automation-rule-to-account
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/automation_rule_create_update_payload'
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/automation_rule'
        '403':
          description: Acesso negado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request_error'
      security:
        - userApiKey: []
components:
  parameters:
    account_id:
      in: path
      name: account_id
      schema:
        type: integer
      required: true
      description: O ID numérico da conta
  schemas:
    automation_rule_create_update_payload:
      type: object
      properties:
        name:
          type: string
          description: Nome da regra
          example: Add label on message create event
        description:
          type: string
          description: A descrição sobre a automação e ações
          example: >-
            Add label support and sales on message create event if incoming
            message content contains text help
        event_name:
          type: string
          enum:
            - conversation_created
            - conversation_updated
            - conversation_resolved
            - message_created
          example: message_created
          description: O evento quando você deseja executar as ações de automação
        active:
          type: boolean
          description: Ativar/desativar regra de automação
        actions:
          type: array
          description: >-
            Matriz de ações que você deseja executar quando a condição
            corresponder, por exemplo, adicionar suporte de rótulo se a mensagem
            contiver o conteúdo de ajuda.
          items:
            type: object
            example:
              action_name: add_label
              action_params:
                - support
        conditions:
          type: array
          description: >-
            Matriz de condições nas quais o filtro de conversa funcionaria, por
            exemplo, conteúdo da mensagem contém texto de ajuda.
          items:
            type: object
            example:
              attribute_key: content
              filter_operator: contains
              query_operator: OR
              values:
                - help
    automation_rule:
      type: object
      properties:
        payload:
          description: Carga útil (payload) da resposta que contém regra(s) de automação
          oneOf:
            - type: array
              description: Matriz de regras de automação (para endpoint de listagem)
              items:
                $ref: '#/components/schemas/automation_rule_item'
            - type: object
              description: >-
                Regra de automação única (para endpoints de
                exibição/criação/atualização)
              allOf:
                - $ref: '#/components/schemas/automation_rule_item'
    bad_request_error:
      title: data
      type: object
      properties:
        description:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/request_error'
    automation_rule_item:
      type: object
      properties:
        id:
          type: integer
          description: O ID da regra de automação
        account_id:
          type: integer
          description: ID da conta
        name:
          type: string
          description: O nome da regra
          example: Add label on message create event
        description:
          type: string
          description: Descrição para dar mais contexto sobre a regra
          example: >-
            Add label support and sales on message create event if incoming
            message content contains text help
        event_name:
          type: string
          description: >-
            Evento da regra de automação, no qual chamamos as ações
            (conversation_created, conversation_updated, message_created)
          enum:
            - conversation_created
            - conversation_updated
            - message_created
          example: message_created
        conditions:
          type: array
          description: >-
            Matriz de condições nas quais o filtro de conversa/mensagem
            funcionaria
          items:
            type: object
            properties:
              values:
                type: array
                items:
                  type: string
              attribute_key:
                type: string
              query_operator:
                type: string
              filter_operator:
                type: string
            example:
              attribute_key: content
              filter_operator: contains
              values:
                - help
              query_operator: and
        actions:
          type: array
          description: Matriz de ações que executamos quando a condição corresponde
          items:
            type: object
            properties:
              action_name:
                type: string
              action_params:
                type: array
                items:
                  type: string
            example:
              action_name: add_label
              action_params:
                - support
                - sales
        created_on:
          type: integer
          description: O timestamp de quando a regra foi criada
        active:
          type: boolean
          description: Ativar/desativar regra de automação
    request_error:
      type: object
      properties:
        field:
          type: string
        message:
          type: string
        code:
          type: string
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: >-
        Este token pode ser obtido visitando a página de perfil ou por meio do
        console rails. Fornece acesso a endpoints com base nos níveis de
        permissões do usuário. Este token pode ser salvo por um sistema externo
        quando o usuário é criado via API, para realizar atividades em nome do
        usuário.

````