Skip to main content
POST
Deactivate an automation
Desativar uma automação faz com que ela pare de processar novos gatilhos e muda o status para paused. Sua chave de API precisa do escopo automations:activate e de acesso à conta informada no corpo da requisição. Envie o ID da automação no caminho. Envie account_id e o valor mais recente de updated_at como expected_updated_at no corpo. Os dois campos são obrigatórios e nenhum outro campo é aceito. Uma requisição bem-sucedida retorna 200 com a automação pausada e a configuration tipada completa dela.

O que a desativação não muda

A desativação interrompe o processamento de novos gatilhos. Ela não exclui a automação, a configuração dela, as métricas nem o histórico de contatos. Ative a mesma automação outra vez com Ativar uma automação quando quiser retomá-la. Use Excluir uma automação quando quiser arquivar a automação em vez de pausá-la.

Proteja alterações simultâneas

Leia a automação imediatamente antes de desativá-la e envie o valor exato de updated_at dela. Se a automação mudou depois dessa leitura, a API retorna 409 com api_automation_version_conflict. Leia a automação de novo e monte uma nova requisição a partir do valor retornado.

Exemplo de requisição

Esta operação não é idempotente. Não repita a chamada automaticamente depois de uma resposta desconhecida.
Se a API retornar api_automation_committed_response_unavailable com committed: true e retryable: false, a automação foi pausada, mas a API não conseguiu verificar a resposta. Leia a automação antes de executar outra ação.

Exemplo de resposta de sucesso

IDs, horários e conteúdo ilustrativos. HTTP 200.

Autorizações

Authorization
string
header
obrigatório

Levios API key sent as a Bearer token.

Parâmetros de caminho

automationId
string<uuid>
obrigatório

Corpo

application/json
account_id
string<uuid>
obrigatório
expected_updated_at
string
obrigatório
Required string length: 20 - 32
Pattern: ^(?:(?:(?!0000)\d{4})-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|02-(?:0[1-9]|1\d|2[0-8]))|(?:(?!0000)(?:\d{2}(?:0[48]|[2468][048]|[13579][26])|(?:[02468][048]|[13579][26])00))-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,6})?(?:Z|[+-](?:[01]\d|2[0-3]):[0-5]\d)$

Resposta

Successful response.