Skip to main content
PATCH
Use este endpoint para alterar name, configuration ou os dois. Sua chave de API precisa de automations:write, e o corpo precisa conter um account_id acessível e expected_updated_at. Você precisa enviar pelo menos um entre name e configuration. Mudanças de status não são aceitas aqui. Use Ativar uma automação ou Desativar uma automação.

Envie a configuração completa

configuration é uma configuração de automação tipada e completa. Não é uma mesclagem parcial. Quando você a inclui, o objeto validado substitui por inteiro a configuração armazenada. Leia a automação primeiro, altere localmente a configuration devolvida e envie o resultado completo. Omitir uma seção não preserva o valor armazenado antes, porque as cinco seções são obrigatórias: O documento OpenAPI é a fonte de verdade de cada campo, enum, limite e formato de ação aninhada. O schema PublicAutomationUpdateV1 dele define o corpo completo da requisição e cobre:
  • A escolha do gatilho por type e os objetos publication, story, keywords e reactions que pertencem a ele.
  • A entrega de abertura por direct_message, com delay_seconds, o text da mensagem e até três botões do tipo start_follow_up ou url.
  • As respostas públicas por public_reply, com messages, rotation, mention_mode e max_per_post.
  • As etapas de acompanhamento por actions, incluindo send_message, send_media, send_carousel, ask_to_follow, ask_for_email, ask_for_phone, add_contact_tag e finish.
  • A proteção contra repetição por extras.cooldown.
Os campos chamados type, mode, match_mode, rotation ou mention_mode são enums. Use somente os valores que esse documento define. A API recusa propriedades desconhecidas e combinações inválidas com 422 e api_automation_invalid_configuration. Leia error.details.issues para descobrir o path, o code e a message que falharam. Use Listar mídias do Instagram para encontrar o id da mídia de um gatilho que observa uma publicação ou um story específico.

Automações criadas antes do contrato público

Uma automação cuja configuração armazenada é anterior ao contrato público volta com authoring_compatibility igual a read_only_legacy e configuration igual a null. Você ainda pode renomeá-la. Enviar uma configuration completa substitui a configuração antiga e converte a automação para o contrato público, o que não pode ser desfeito pela API.

Proteja as alterações concorrentes

Leia a automação primeiro e envie o valor exato de updated_at como expected_updated_at. Se outra requisição alterou a automação, a API retorna 409 com api_automation_version_conflict. Leia a automação de novo e monte uma nova atualização a partir do valor devolvido.

Exemplo de requisição

Se a API retornar api_automation_committed_response_unavailable com committed: true e retryable: false, a alteração foi aplicada, mas a API não conseguiu verificar a resposta. Não repita a chamada automaticamente. Leia a automação atual antes de decidir se outra atualização é necessária.

Exemplo de resposta de sucesso

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

Guias de criação

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

The body is of type any.

Resposta

Successful response.