Skip to main content
PATCH
Atualizar automação

Permissões

Requer um usuário de serviço com a permissão ManageOrgAutomations no nível da organização.

Semântica de merge

Na semântica padrão merge_patch, os campos PATCH fazem merge membro a membro (no estilo da RFC 7396): membros omitidos mantêm o valor armazenado, nulos explícitos limpam valores e grupos vazios não geram alterações. Os metadados fazem merge por chave, e valores nulos excluem chaves. As listas são substituídas integralmente, enquanto cada elemento enviado faz merge com o elemento armazenado do mesmo tipo quando esse tipo ocorre exatamente uma vez nos dois lados. Na semântica replace_groups, nada faz merge: um grupo de objetos enviado substitui integralmente o grupo armazenado, e uma lista enviada de triggers ou actions substitui integralmente a lista armazenada, sem merge elemento a elemento. Reenvie todos os membros que quiser manter — membros omitidos são limpos ou redefinidos para o valor padrão. metadata também é um conjunto de substituição completa; portanto, remover uma chave significa reenviar o conjunto sem ela. Valores nulos de metadados são rejeitados com um 400, em vez de excluir chaves. Campos de nível superior omitidos permanecem inalterados. Verifique o campo update_semantics do endpoint de esquemas de eventos para identificar a semântica ativa na sua organização antes de depender de qualquer um desses comportamentos. Trate-o como um enum aberto e aceite valores além dos dois mencionados acima.

Gatilhos de webhook

Adicionar novamente um gatilho webhook:incoming gera um novo segredo e o retorna na resposta de atualização. Essa é a única vez que o segredo é exibido, portanto, salve-o ao recebê-lo. Substituir ou manter um gatilho de webhook existente preserva o segredo atual.

Autorizações

Authorization
string
header
obrigatório

Credencial de usuário de serviço (prefixo: cog_)

Parâmetros de caminho

automation_id
string
obrigatório
org_id
string
obrigatório

ID da organização (prefixo: org-)

Exemplo:

"org-abc123def456"

Corpo

application/json

Por padrão, os campos PATCH são mesclados propriedade por propriedade: propriedades omitidas são mantidas, nulls explícitos limpam valores e grupos vazios não têm efeito. Os metadados são mesclados por chave, com valores null excluindo chaves. As listas são substituídas integralmente (exclusão = reenviar a lista sem o elemento), enquanto cada elemento enviado é mesclado com o elemento armazenado do mesmo tipo quando esse tipo ocorre exatamente uma vez em ambos os lados. Propriedades de elementos obrigatórias na criação (prompt, setup_prompt, as configurações de Slack de monitoramento/triagem, scan_id) podem ser omitidas quando existe uma contraparte — são mantidas como qualquer outra propriedade; null explícito é rejeitado.

actions
(AutomationStartSessionActionUpdate · object | AutomationMessageSessionActionUpdate · object | AutomationMonitorSessionActionUpdate · object)[] | null
concurrency
AutomationConcurrency · object | null
enabled
boolean | null
limits
AutomationLimits · object | null
metadata
Metadata · object | null
name
string | null
Required string length: 1 - 500
notifications
AutomationNotifications · object | null
run_as
AutomationRunAsOrganization · object

Identidade sob a qual as sessões geradas são executadas. organization: a identidade de automação da organização (o Usuário do Sistema no app) — as sessões usam permissões do sistema; portanto, servidores MCP instalados com uma conexão pessoal (no escopo do usuário) não podem ser selecionados, e mudar uma automação para organization os remove de sua seleção. creator: automação pessoal — é executada com as permissões do próprio criador e é visível apenas para o criador e administradores da organização; rejeitada para automações criadas por usuário de serviço. Obrigatório na criação; null na atualização redefine para organization.

security_profile
AutomationSecurityProfileSelection · object | null

A associação de perfil de segurança da própria automação: um profile_id fixa esse perfil, {"profile_id": null} registra uma desativação explícita, e null explícito volta a herdar da organização/Enterprise. Exige a permissão de gerenciamento de perfis de segurança.

session_settings
AutomationSessionSettings · object | null

Aplicado a todas as sessões geradas por esta automação (incluindo sessões de monitoramento).

tools
AutomationTools · object | null
triggers
AutomationTriggerRequest · object[] | null

Resposta

Resposta bem-sucedida

actions
(AutomationStartSessionAction · object | AutomationMessageSessionAction · object | AutomationMonitorSessionAction · object)[]
obrigatório
automation_id
string
obrigatório
created_at
integer
obrigatório
created_by
ActorResponse · object
obrigatório

Um principal de usuário ou de usuário de serviço atribuído a uma ação ou recurso.

enabled
boolean
obrigatório
name
string
obrigatório
triggers
AutomationTriggerResponse · object[]
obrigatório
updated_at
integer
obrigatório
concurrency
AutomationConcurrency · object | null
last_edited_by
ActorResponse · object | null

Um principal de usuário ou de usuário de serviço atribuído a uma ação ou recurso.

last_invocation
AutomationLastInvocation · object | null
limits
AutomationLimits · object | null
metadata
Metadata · object
notifications
AutomationNotifications · object | null
run_as
AutomationRunAsOrganization · object

Identidade sob a qual as sessões geradas são executadas. organization: a identidade de automação da organização (o Usuário do sistema no app) — as sessões usam permissões do sistema; portanto, servidores MCP instalados com uma conexão pessoal (com escopo de usuário) não podem ser selecionados, e alterar uma automação para organization os remove da seleção. creator: automação pessoal — é executada com as permissões do próprio criador e fica visível apenas para o criador e administradores da organização; rejeitada para automações criadas por usuário de serviço. Obrigatório na criação; null na atualização redefine para organization.

security_profile
AutomationSecurityProfileResponse · object | null

A associação da automação ao perfil de segurança e os perfis aplicáveis determinados. null quando os perfis de segurança não estão ativados para a organização.

session_settings
AutomationSessionSettings · object | null

Aplicado a todas as sessões geradas por esta automação (incluindo sessões de monitoramento).

template_id
string | null
tools
AutomationTools · object | null