ai-agents15

answers-history4

automations6

business-areas6

channels5

contacts7

customers9

dynamic-forms7

form-publications9

forms6

funnel-steps8

goals7

integrations4

invites3

project-funnels13

project-groups9

projects42

search-activities1

spreadsheet-operations7

squads9

step-assistants8

system3

tags5

user-alias4

users2

step-assistants

Assistentes

Atualizar um assistente da etapa

Substitui a configuração do assistente. O corpo é o mesmo da criação e não aceita atualização parcial: name, funnel_step_id, ai_agent_id, prompt e execute_on precisam vir a cada requisição, e ao menos um destino de resultado continua obrigatório.

Enviar active: false tira o assistente de operação sem apagar nada: a configuração e o histórico de execuções permanecem, mas ele deixa de disparar.

put/api/management/steps/{step}/assistants/{assistant}

Request body

namestring required

Nome do assistente. Obrigatório, até 255 caracteres.

activeboolean

Define se o assistente entra em operação. Padrão true.

funnel_step_idinteger required

ID da etapa do funil à qual o assistente pertence. Obrigatório — é este campo que vale, e não o ID da URL.

ai_agent_idstring uuid required

ID (UUID) do agente de IA que executa a tarefa. Obrigatório e precisa pertencer à mesma conta.

promptstring required

Instrução dada ao agente. Obrigatória. Aceita a sintaxe avançada, com dados do projeto e da etapa.

execute_on'moved' | 'unlinked' | 'manual' required

Gatilho do assistente: moved ao entrar na etapa, unlinked ao sair dela e manual só sob demanda.

manual_execution_enabledboolean

Permite disparar o assistente sob demanda mesmo com gatilho automático. Padrão false.

failure_funnel_step_idinteger nullable

Etapa para onde o projeto vai se a execução falhar. Precisa ser da mesma conta e diferente de funnel_step_id. null deixa o projeto onde está.

result_as_mediaboolean

Grava o resultado como conteúdo do projeto. Obrigatório quando result_as_dynamic_form não é enviado.

Response

Sucesso

responseboolean required

Sempre true quando a operação é concluída.

Changes

Changed in 3 of the 80 revisions of this API.20322

Aug 24, 20263c590152d5b520320See the full diff
- ▲
  request property was restricted to a list of enum values
  request-property-became-enum
- ▲
  the request property became required
  request-property-became-required
- ▲
  the request property became required
  request-property-became-required
- ▲
  the request property became required
  request-property-became-required
- ▲
  the request property became required
  request-property-became-required
- ▲
  the request property became required
  request-property-became-required
- ▲
  the request property / became required
  request-property-became-required
- ▲
  the request property / became required
  request-property-became-required
- ▲
  the request property / became required
  request-property-became-required
- ▲
  the request property type changed from number to boolean
  request-property-type-changed
- ▲
  the request property format changed from no format to uuid
  request-property-type-changed
- ▲
  the request property type changed from string to integer
  request-property-type-changed
- ▲
  the request property type changed from number to integer
  request-property-type-changed
- ▲
  the request property type changed from number to boolean
  request-property-type-changed
- ▲
  the / request property type changed from number to integer
  request-property-type-changed
- ▲
  the / request property type changed from number to integer
  request-property-type-changed
- ▲
  the request property type changed from number to boolean
  request-property-type-changed
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the / response's property type changed from no type to string, and format from no format to date-time for status
  response-property-type-changed
- ▲
  the / response's property type changed from no type to object for status
  response-property-type-changed
- ●
  added the new manual enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new moved enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new unlinked enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property / became nullable
  request-property-became-nullable
- ○
  the request property / became nullable
  request-property-became-nullable
- ○
  the request property / became nullable
  request-property-became-nullable
- ○
  the request property / became nullable
  request-property-became-nullable
- ○
  the request property / became nullable
  request-property-became-nullable
- ○
  added the new manual enum value to the request property
  request-property-enum-value-added
- ○
  added the new moved enum value to the request property
  request-property-enum-value-added
- ○
  added the new unlinked enum value to the request property
  request-property-enum-value-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
Aug 19, 2026d49d48cd1ce01See the full diff
- ○
  api tag Assistentes added
  api-tag-added
Aug 19, 202669f9300dc0451See the full diff
- ○
  added the media type application/json for the response with the status
  response-media-type-added

Full history