> ## Documentation Index > Fetch the complete documentation index at: https://docs.jurichat.com/llms.txt > Use this file to discover all available pages before exploring further. # Atualizar regra de automação > Atualiza parcialmente uma regra de automação. Remover o filtro IF limpa o ramo Senão, mesmo que elseActions ainda exista no payload ou no banco. **Como montar** 1. `triggerEvent`: pegue o `name` em `GET /webhooks/events` — é o mesmo catálogo dos webhooks. 2. `conditions` (opcional): filtra o *Quando*. Sem nenhuma condição efetiva, `elseActions` é recusado. 3. `actions`: de 1 a 5 ações do ramo *Então*. `elseActions`: até 5 ações do ramo *Senão*. 4. `integrationId`: `null` aplica a regra a todas as integrações. Ids em `GET /integration`. **Parâmetros por ação** (`actions[].actionParams`) | `action` | chave obrigatória | de onde vem o id | | --- | --- | --- | | `SEND_FAST_MESSAGE` | `fastMessageId` **ou** `templateName` | `GET /fast-message?inboxId={inboxId}` | | `SCHEDULE_MESSAGE` | `text` **ou** `templateName` | — | | `MOVE_CARD` | `targetFunnelColumnId` | `GET /funnel-column` | | `TAG_CONVERSATION` | `tagId` | `GET /tag` | | `ASSIGN_LEGAL_AREA` | `legalAreaId` | `GET /legal-areas` | | `CREATE_TICKET` | `title` | status em `GET /ticket-statuses` | | `FIRE_WEBHOOK` | `url` (http/https) | — | | `PAUSE_AUTOMATION` | nenhuma | `durationMinutes` opcional; `resumeOnTemplateSent` opcional | **Exemplo — enviar uma resposta rápida quando o lead entra numa coluna** ```json { "name": "Boas-vindas do funil", "enabled": true, "triggerEvent": "crm.lead.created", "conditions": { "funnelColumnId": "" }, "actions": [ { "action": "SEND_FAST_MESSAGE", "actionParams": { "fastMessageId": "" } } ] } ``` A resposta rápida pode ser `TEXT`, `AUDIO` ou `SEQUENCE`. Numa `SEQUENCE`, os blocos saem em ordem, no ritmo (`typingSeconds` / `waitSeconds`) salvo na própria resposta rápida. ## OpenAPI ````yaml https://api.jurichat.com/docs/client/openapi.json patch /automation-rules/{id} openapi: 3.1.0 info: title: JuriChat API — Documentação para Integradores description: '' version: 1.0.0 servers: - url: https://api.jurichat.com description: Production server security: - apiKeyAuth: [] tags: [] paths: /automation-rules/{id}: patch: tags: - Automation Rules summary: Atualizar regra de automação description: >- Atualiza parcialmente uma regra de automação. Remover o filtro IF limpa o ramo Senão, mesmo que elseActions ainda exista no payload ou no banco. **Como montar** 1. `triggerEvent`: pegue o `name` em `GET /webhooks/events` — é o mesmo catálogo dos webhooks. 2. `conditions` (opcional): filtra o *Quando*. Sem nenhuma condição efetiva, `elseActions` é recusado. 3. `actions`: de 1 a 5 ações do ramo *Então*. `elseActions`: até 5 ações do ramo *Senão*. 4. `integrationId`: `null` aplica a regra a todas as integrações. Ids em `GET /integration`. **Parâmetros por ação** (`actions[].actionParams`) | `action` | chave obrigatória | de onde vem o id | | --- | --- | --- | | `SEND_FAST_MESSAGE` | `fastMessageId` **ou** `templateName` | `GET /fast-message?inboxId={inboxId}` | | `SCHEDULE_MESSAGE` | `text` **ou** `templateName` | — | | `MOVE_CARD` | `targetFunnelColumnId` | `GET /funnel-column` | | `TAG_CONVERSATION` | `tagId` | `GET /tag` | | `ASSIGN_LEGAL_AREA` | `legalAreaId` | `GET /legal-areas` | | `CREATE_TICKET` | `title` | status em `GET /ticket-statuses` | | `FIRE_WEBHOOK` | `url` (http/https) | — | | `PAUSE_AUTOMATION` | nenhuma | `durationMinutes` opcional; `resumeOnTemplateSent` opcional | **Exemplo — enviar uma resposta rápida quando o lead entra numa coluna** ```json { "name": "Boas-vindas do funil", "enabled": true, "triggerEvent": "crm.lead.created", "conditions": { "funnelColumnId": "" }, "actions": [ { "action": "SEND_FAST_MESSAGE", "actionParams": { "fastMessageId": "" } } ] } ``` A resposta rápida pode ser `TEXT`, `AUDIO` ou `SEQUENCE`. Numa `SEQUENCE`, os blocos saem em ordem, no ritmo (`typingSeconds` / `waitSeconds`) salvo na própria resposta rápida. parameters: - schema: type: string in: path name: id required: true description: ID da regra de automação. requestBody: content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 100 description: Nome da regra. enabled: type: boolean description: Indica se a regra está ativa. triggerEvent: type: string enum: - crm.lead.created - crm.lead.updated - crm.lead.deleted - crm.lead.moved - crm.lead.overdue - chat.conversation.created - chat.conversation.updated - chat.conversation.assigned - chat.message.received - chat.message.sent - contact.created - contact.updated - contact.deleted - webhook.test description: Evento que dispara a automação. integrationId: type: string nullable: true description: ID da integração. Null para aplicar a todas. conditions: type: object properties: funnelColumnId: type: string description: >- Restringe a automação à coluna atual do lead (crm.lead.created/updated/overdue e chat.message.*). fromFunnelColumnId: type: string description: >- Restringe a automação a leads movidos a partir dessa coluna (crm.lead.moved). toFunnelColumnId: type: string description: >- Restringe a automação a leads movidos para essa coluna (crm.lead.moved). status: type: string enum: - INACTIVE - ROBOT_INTERACTIVE - HUMAN_INTERACTIVE - WAITING_HUMAN - PAUSED description: >- Restringe a automação a esse status da conversa (chat.conversation.updated). assignedToUserId: type: string description: >- Restringe a automação a atribuições para esse usuário (chat.conversation.assigned). assignedToDepartmentId: type: string description: >- Restringe a automação quando esse setor estiver entre os atribuídos (chat.conversation.assigned.assignedToDepartmentIds). messageText: type: string minLength: 1 description: >- Compara o texto da mensagem (chat.message.received/sent). messageMatchMode: type: string enum: - equals - contains description: >- Modo de comparação do texto: equals ou contains (default contains). templateName: type: string minLength: 1 description: >- Nome do template da API oficial (igualdade exata). Em chat.message.received, refere-se ao template respondido (botão ou mensagem anterior). restartOnReturn: type: boolean description: >- Quando true, permite que a sequência de SCHEDULE_MESSAGE dessa regra rode de novo toda vez que o lead retornar à coluna (após a passagem anterior terminar/ser cancelada). Default false: a sequência roda uma única vez por lead. additionalProperties: false nullable: true description: Condições que restringem a execução da regra. actions: type: array items: type: object properties: action: type: string enum: - MOVE_CARD - SCHEDULE_MESSAGE - TAG_CONVERSATION - ASSIGN_LEGAL_AREA - SEND_FAST_MESSAGE - CREATE_TICKET - FIRE_WEBHOOK - PAUSE_AUTOMATION description: Tipo da ação a executar. actionParams: anyOf: - type: object properties: targetFunnelColumnId: type: string description: >- Coluna de destino do card. Obtenha o id em `GET /funnel-column`. required: - targetFunnelColumnId additionalProperties: true description: >- MOVE_CARD — move o card do lead para outra coluna do funil. - type: object properties: tagId: type: string description: >- Etiqueta a aplicar na conversa. Obtenha o id em `GET /tag`. required: - tagId additionalProperties: true description: TAG_CONVERSATION — etiqueta a conversa. - type: object properties: legalAreaId: type: string description: >- Área do direito a atribuir. Obtenha o id em `GET /legal-areas`. required: - legalAreaId additionalProperties: true description: >- ASSIGN_LEGAL_AREA — atribui a área do direito à conversa. - type: object properties: url: type: string description: >- URL http(s) absoluta que recebe o POST. Timeout de 10 segundos. required: - url additionalProperties: true description: >- FIRE_WEBHOOK — dispara um POST para uma URL externa. - type: object properties: title: type: string description: Título do ticket. description: type: string description: Descrição do ticket. priority: type: string enum: - LOW - MEDIUM - HIGH description: Prioridade do ticket. Default MEDIUM. statusId: type: string description: >- Status inicial. Obtenha o id em `GET /ticket-statuses`. Ausente usa o default. assigneeIds: type: array items: type: string description: >- Responsáveis pelo ticket. Obtenha os ids em `GET /user`. departmentIds: type: array items: type: string description: >- Setores do ticket. Obtenha os ids em `GET /departments`. linkConversation: type: boolean description: >- Vincula a conversa que disparou o evento ao ticket. Default true. required: - title additionalProperties: true description: CREATE_TICKET — abre um ticket. - type: object properties: durationMinutes: type: integer minimum: 0 maximum: 43200 description: >- Minutos até reativar nesta conversa. Ausente ou 0: sem prazo (fica pausada até um evento de retomada). Máximo 43200 (30 dias). resumeOnTemplateSent: type: boolean description: >- Quando true, um template enviado nesta conversa depois da pausa reativa a regra. Default false na API; o builder liga por padrão. additionalProperties: true description: >- PAUSE_AUTOMATION — pausa esta regra nesta conversa. Outras automações continuam. - type: object properties: fastMessageId: type: string description: >- Resposta rápida a enviar. Obtenha o id em `GET /fast-message?inboxId={inboxId}` — é o campo `id` da lista. Vale para os três tipos: `TEXT`, `AUDIO` e `SEQUENCE` (a sequência sai bloco a bloco, no ritmo salvo). Obrigatório quando `templateName` não for enviado. templateName: type: string description: >- Nome do template aprovado na API oficial. Liste os disponíveis em `GET /integration/templates/{integrationId}`. variables: type: array items: type: string description: >- Valores das variáveis do corpo do template, na ordem em que aparecem. bodyVariableNames: type: array items: type: string description: >- Nomes das variáveis do corpo, na mesma ordem de `variables`. headerVariables: type: array items: type: string description: >- Valores das variáveis do cabeçalho do template. headerVariableNames: type: array items: type: string description: >- Nomes das variáveis do cabeçalho, na mesma ordem de `headerVariables`. headerMedia: description: >- Mídia do cabeçalho: `{ format: IMAGE | VIDEO | DOCUMENT | LOCATION, link, fileName, latitude, longitude, name, address }`. buttonVariables: description: >- Variáveis de botões dinâmicos: `[{ index, parameters: string[], parameterNames?: string[] }]`. additionalProperties: true description: >- SEND_FAST_MESSAGE — envia uma resposta rápida na conversa. Informe `fastMessageId` OU `templateName`. - type: object properties: text: type: string description: >- Texto da mensagem. Obrigatório quando `templateName` não for enviado. delayMinutes: type: number description: >- Minutos de espera entre o disparo do evento e o envio. Ausente envia na hora. sendWindowEnabled: type: boolean description: >- Quando true, o envio é adiado para dentro da janela abaixo. sendWindowStart: type: string description: >- Início da janela de envio, `HH:mm` no fuso America/Sao_Paulo. sendWindowEnd: type: string description: >- Fim da janela de envio, `HH:mm` no fuso America/Sao_Paulo. templateName: type: string description: >- Nome do template aprovado na API oficial. Liste os disponíveis em `GET /integration/templates/{integrationId}`. variables: type: array items: type: string description: >- Valores das variáveis do corpo do template, na ordem em que aparecem. bodyVariableNames: type: array items: type: string description: >- Nomes das variáveis do corpo, na mesma ordem de `variables`. headerVariables: type: array items: type: string description: >- Valores das variáveis do cabeçalho do template. headerVariableNames: type: array items: type: string description: >- Nomes das variáveis do cabeçalho, na mesma ordem de `headerVariables`. headerMedia: description: >- Mídia do cabeçalho: `{ format: IMAGE | VIDEO | DOCUMENT | LOCATION, link, fileName, latitude, longitude, name, address }`. buttonVariables: description: >- Variáveis de botões dinâmicos: `[{ index, parameters: string[], parameterNames?: string[] }]`. additionalProperties: true description: >- SCHEDULE_MESSAGE — agenda uma mensagem na conversa. Informe `text` OU `templateName`. - type: object additionalProperties: {} description: Qualquer outro conjunto de parâmetros. description: >- Parâmetros da ação. As chaves dependem do valor de `action` — cada alternativa abaixo é a de uma ação. required: - action - actionParams additionalProperties: false minItems: 1 maxItems: 5 description: >- Ações do ramo Então, executadas quando a condição é verdadeira. elseActions: type: array items: type: object properties: action: type: string enum: - MOVE_CARD - SCHEDULE_MESSAGE - TAG_CONVERSATION - ASSIGN_LEGAL_AREA - SEND_FAST_MESSAGE - CREATE_TICKET - FIRE_WEBHOOK - PAUSE_AUTOMATION description: Tipo da ação a executar. actionParams: anyOf: - type: object properties: targetFunnelColumnId: type: string description: >- Coluna de destino do card. Obtenha o id em `GET /funnel-column`. required: - targetFunnelColumnId additionalProperties: true description: >- MOVE_CARD — move o card do lead para outra coluna do funil. - type: object properties: tagId: type: string description: >- Etiqueta a aplicar na conversa. Obtenha o id em `GET /tag`. required: - tagId additionalProperties: true description: TAG_CONVERSATION — etiqueta a conversa. - type: object properties: legalAreaId: type: string description: >- Área do direito a atribuir. Obtenha o id em `GET /legal-areas`. required: - legalAreaId additionalProperties: true description: >- ASSIGN_LEGAL_AREA — atribui a área do direito à conversa. - type: object properties: url: type: string description: >- URL http(s) absoluta que recebe o POST. Timeout de 10 segundos. required: - url additionalProperties: true description: >- FIRE_WEBHOOK — dispara um POST para uma URL externa. - type: object properties: title: type: string description: Título do ticket. description: type: string description: Descrição do ticket. priority: type: string enum: - LOW - MEDIUM - HIGH description: Prioridade do ticket. Default MEDIUM. statusId: type: string description: >- Status inicial. Obtenha o id em `GET /ticket-statuses`. Ausente usa o default. assigneeIds: type: array items: type: string description: >- Responsáveis pelo ticket. Obtenha os ids em `GET /user`. departmentIds: type: array items: type: string description: >- Setores do ticket. Obtenha os ids em `GET /departments`. linkConversation: type: boolean description: >- Vincula a conversa que disparou o evento ao ticket. Default true. required: - title additionalProperties: true description: CREATE_TICKET — abre um ticket. - type: object properties: durationMinutes: type: integer minimum: 0 maximum: 43200 description: >- Minutos até reativar nesta conversa. Ausente ou 0: sem prazo (fica pausada até um evento de retomada). Máximo 43200 (30 dias). resumeOnTemplateSent: type: boolean description: >- Quando true, um template enviado nesta conversa depois da pausa reativa a regra. Default false na API; o builder liga por padrão. additionalProperties: true description: >- PAUSE_AUTOMATION — pausa esta regra nesta conversa. Outras automações continuam. - type: object properties: fastMessageId: type: string description: >- Resposta rápida a enviar. Obtenha o id em `GET /fast-message?inboxId={inboxId}` — é o campo `id` da lista. Vale para os três tipos: `TEXT`, `AUDIO` e `SEQUENCE` (a sequência sai bloco a bloco, no ritmo salvo). Obrigatório quando `templateName` não for enviado. templateName: type: string description: >- Nome do template aprovado na API oficial. Liste os disponíveis em `GET /integration/templates/{integrationId}`. variables: type: array items: type: string description: >- Valores das variáveis do corpo do template, na ordem em que aparecem. bodyVariableNames: type: array items: type: string description: >- Nomes das variáveis do corpo, na mesma ordem de `variables`. headerVariables: type: array items: type: string description: >- Valores das variáveis do cabeçalho do template. headerVariableNames: type: array items: type: string description: >- Nomes das variáveis do cabeçalho, na mesma ordem de `headerVariables`. headerMedia: description: >- Mídia do cabeçalho: `{ format: IMAGE | VIDEO | DOCUMENT | LOCATION, link, fileName, latitude, longitude, name, address }`. buttonVariables: description: >- Variáveis de botões dinâmicos: `[{ index, parameters: string[], parameterNames?: string[] }]`. additionalProperties: true description: >- SEND_FAST_MESSAGE — envia uma resposta rápida na conversa. Informe `fastMessageId` OU `templateName`. - type: object properties: text: type: string description: >- Texto da mensagem. Obrigatório quando `templateName` não for enviado. delayMinutes: type: number description: >- Minutos de espera entre o disparo do evento e o envio. Ausente envia na hora. sendWindowEnabled: type: boolean description: >- Quando true, o envio é adiado para dentro da janela abaixo. sendWindowStart: type: string description: >- Início da janela de envio, `HH:mm` no fuso America/Sao_Paulo. sendWindowEnd: type: string description: >- Fim da janela de envio, `HH:mm` no fuso America/Sao_Paulo. templateName: type: string description: >- Nome do template aprovado na API oficial. Liste os disponíveis em `GET /integration/templates/{integrationId}`. variables: type: array items: type: string description: >- Valores das variáveis do corpo do template, na ordem em que aparecem. bodyVariableNames: type: array items: type: string description: >- Nomes das variáveis do corpo, na mesma ordem de `variables`. headerVariables: type: array items: type: string description: >- Valores das variáveis do cabeçalho do template. headerVariableNames: type: array items: type: string description: >- Nomes das variáveis do cabeçalho, na mesma ordem de `headerVariables`. headerMedia: description: >- Mídia do cabeçalho: `{ format: IMAGE | VIDEO | DOCUMENT | LOCATION, link, fileName, latitude, longitude, name, address }`. buttonVariables: description: >- Variáveis de botões dinâmicos: `[{ index, parameters: string[], parameterNames?: string[] }]`. additionalProperties: true description: >- SCHEDULE_MESSAGE — agenda uma mensagem na conversa. Informe `text` OU `templateName`. - type: object additionalProperties: {} description: Qualquer outro conjunto de parâmetros. description: >- Parâmetros da ação. As chaves dependem do valor de `action` — cada alternativa abaixo é a de uma ação. required: - action - actionParams additionalProperties: false maxItems: 5 nullable: true description: >- Ações do ramo Senão. Null remove o ramo. Se o IF for removido, o Senão é limpo mesmo que este campo ainda venha preenchido. priority: type: integer description: Prioridade da regra. additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: id: type: string officeId: type: string integrationId: type: string nullable: true name: type: string enabled: type: boolean triggerEvent: type: string conditions: type: object additionalProperties: {} nullable: true actions: type: array items: type: object properties: action: type: string actionParams: type: object additionalProperties: {} required: - action - actionParams additionalProperties: false elseActions: type: array items: type: object properties: action: type: string actionParams: type: object additionalProperties: {} required: - action - actionParams additionalProperties: false nullable: true priority: type: number createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - officeId - integrationId - name - enabled - triggerEvent - conditions - actions - elseActions - priority - createdAt - updatedAt additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: message: type: string statusCode: type: number code: type: string details: anyOf: - type: string - type: number - type: boolean - type: object properties: {} additionalProperties: true description: Detalhes adicionais do erro. required: - message - statusCode additionalProperties: false security: - apiKeyAuth: [] components: securitySchemes: apiKeyAuth: type: apiKey in: header name: x-jurichat-api-key description: >- Chave de API do escritório (criada no painel). Envie o valor no header x-jurichat-api-key. ````