Skip to main content
PUT
/
api
/
automations
/
{id}
# Atualizar apenas o nome e descrição
curl -X PUT https://api.disparador.com/api/automations/10 \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: seu-access-token" \
  -d '{
    "name": "Aniversariantes - Novo Nome",
    "description": "Descrição atualizada"
  }'

# Desativar automação
curl -X PUT https://api.disparador.com/api/automations/10 \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: seu-access-token" \
  -d '{
    "isActive": false
  }'

# Alterar horário de execução
curl -X PUT https://api.disparador.com/api/automations/10 \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: seu-access-token" \
  -d '{
    "schedule": {
      "timeOfDay": "10:00",
      "timezone": "America/Sao_Paulo"
    }
  }'
{
  "id": 10,
  "name": "Aniversariantes - Novo Nome",
  "description": "Descrição atualizada",
  "isActive": true,
  "scheduleType": "DAILY",
  "schedule": {
    "timeOfDay": "10:00",
    "timezone": "America/Sao_Paulo",
    "weekdays": [2, 3, 4, 5, 6]
  },
  "databaseConfigId": 1,
  "evolutionConfigId": 2,
  "intervalMinSeconds": 10,
  "intervalMaxSeconds": 30,
  "notificationPhone": null,
  "dedupStrategy": "COOLDOWN_DAYS",
  "dedupCooldownDays": 30,
  "sendLimitPerRun": 200,
  "lastRunAt": "2024-01-21T09:00:00",
  "nextRunAt": "2024-01-22T10:00:00",
  "createdAt": "2024-01-01T10:00:00",
  "updatedAt": "2024-01-21T16:30:00"
}
Você pode atualizar qualquer campo da automação. Os campos não enviados mantêm seus valores atuais.
Alterações no agendamento ou filtros afetam apenas as próximas execuções. Execuções em andamento não são afetadas.

Path Parameters

id
number
required
ID da automação

Headers

Content-Type
string
required
application/json
X-Access-Token
string
required
Token de acesso da empresa

Body

Mesma estrutura da criação. Você pode enviar apenas os campos que deseja alterar:
name
string
Nome da automação
description
string
Descrição da automação
isActive
boolean
Ativar ou desativar a automação
scheduleType
string
Tipo de agendamento (DAILY, WEEKLY, MONTHLY, CRON)
schedule
object
Configuração do agendamento
databaseConfigId
number
ID da configuração de banco de dados
filters
array
Filtros de segmentação
messageConfig
object
Configuração da mensagem
evolutionConfigId
number
ID da configuração Evolution
intervalMinSeconds
number
Intervalo mínimo entre mensagens
intervalMaxSeconds
number
Intervalo máximo entre mensagens
notificationPhone
string
Telefone para notificação
dedupStrategy
string
Estratégia de deduplicação
dedupCooldownDays
number
Dias de cooldown
sendLimitPerRun
number
Limite por execução
# Atualizar apenas o nome e descrição
curl -X PUT https://api.disparador.com/api/automations/10 \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: seu-access-token" \
  -d '{
    "name": "Aniversariantes - Novo Nome",
    "description": "Descrição atualizada"
  }'

# Desativar automação
curl -X PUT https://api.disparador.com/api/automations/10 \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: seu-access-token" \
  -d '{
    "isActive": false
  }'

# Alterar horário de execução
curl -X PUT https://api.disparador.com/api/automations/10 \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: seu-access-token" \
  -d '{
    "schedule": {
      "timeOfDay": "10:00",
      "timezone": "America/Sao_Paulo"
    }
  }'

Response

Retorna o objeto completo da automação atualizada, com a mesma estrutura do endpoint GET.
{
  "id": 10,
  "name": "Aniversariantes - Novo Nome",
  "description": "Descrição atualizada",
  "isActive": true,
  "scheduleType": "DAILY",
  "schedule": {
    "timeOfDay": "10:00",
    "timezone": "America/Sao_Paulo",
    "weekdays": [2, 3, 4, 5, 6]
  },
  "databaseConfigId": 1,
  "evolutionConfigId": 2,
  "intervalMinSeconds": 10,
  "intervalMaxSeconds": 30,
  "notificationPhone": null,
  "dedupStrategy": "COOLDOWN_DAYS",
  "dedupCooldownDays": 30,
  "sendLimitPerRun": 200,
  "lastRunAt": "2024-01-21T09:00:00",
  "nextRunAt": "2024-01-22T10:00:00",
  "createdAt": "2024-01-01T10:00:00",
  "updatedAt": "2024-01-21T16:30:00"
}

Casos de Uso Comuns

1. Pausar Temporariamente

{
  "isActive": false
}

2. Alterar Horário

{
  "schedule": {
    "timeOfDay": "08:30"
  }
}

3. Adicionar Notificação

{
  "notificationPhone": "5511999999999"
}

4. Limitar Volume

{
  "sendLimitPerRun": 50,
  "intervalMinSeconds": 30,
  "intervalMaxSeconds": 60
}

5. Mudar para Mensal

{
  "scheduleType": "MONTHLY",
  "schedule": {
    "dayOfMonth": 15,
    "timeOfDay": "10:00"
  }
}

Observações

  • Alterações no scheduleType requerem enviar também o objeto schedule completo
  • Mudanças no agendamento recalculam automaticamente o nextRunAt
  • A automação precisa pertencer à empresa do token
  • Campos não enviados mantêm seus valores atuais
  • Não é possível alterar o ID da automação
  • Alterações em filters ou messageConfig afetam apenas próximas execuções
  • Se a automação estiver executando, as mudanças só terão efeito na próxima execução
I