1. AI agents
Wazapi
  • Raiz
    • Channels
      • List messaging channels
      • List channel events
      • Retire or un-retire a channel
    • Contacts
      • List contacts
      • Create a contact
      • Get a contact
      • Update a contact
      • Block a contact
      • Unblock a contact
      • Create or update a contact by external ID
      • List custom field definitions
      • Create a custom field definition
      • Update a custom field definition
      • Read conversation panel configuration
      • Update conversation panel configuration
      • Read unanswered conversation mode
      • Set unanswered conversation mode
      • Read ownerless conversation fallback
      • Configure ownerless conversation fallback
      • Preview or apply fallback to current ownerless stock
    • Flows
      • List flows
      • Get a flow
      • Start a flow execution
    • Templates
      • List WhatsApp templates
      • Get a WhatsApp template by name
      • Create an authentication template
    • Messages
      • Send a WhatsApp message
      • List messages in a conversation
      • React to a conversation message
    • Operations
      • Get an asynchronous operation
    • Conversations
      • List conversations
      • Get a conversation
      • Read a conversation select list
      • Replace a conversation select list
      • Patch conversation custom field values
    • Webhooks
      • Receive an event from Wazapi
      • List the integration webhooks
      • Register a webhook
      • Replace a webhook URL and events
      • Delete a webhook
      • Rotate a webhook signing secret
      • Send a test event
    • Store
      • Get the store summary
      • List store products
      • Create a store product
      • Create or update store products in batch
      • Get a store product
      • Update a store product
      • Delete a store product
      • List store categories
      • Create a store category
      • Update a store category
      • Delete a store category
      • List store orders
      • Create a store order
      • Get a store order
      • Transition an order status
      • List coupons
      • Create coupon
      • Replace coupon using current version
      • Read agent discount policy
      • Replace agent discount policy
      • List shipping options
    • CRM
      • List CRM stages
      • Create a CRM stage
      • Update a CRM stage
      • Delete a CRM stage
      • Reorder the stages of a board
      • List CRM opportunities
      • Create a CRM opportunity
      • Get a CRM opportunity
      • Update or move a CRM opportunity
      • Archive a CRM opportunity
      • Upsert a CRM opportunity by external ID
      • Upsert up to 100 CRM opportunities
    • Groups
      • List support groups
      • Get a support group
      • Update group waiting and distribution options
      • Read daily group distribution report
    • Entries
      • Read company entry settings
      • Update company entry settings
      • Read flows entries
      • Update flows entries
      • Read keywords entries
      • Update keywords entries
      • Read ai-agents entries
      • Update ai-agents entries
    • Automation settings
      • Read the stalled bot watchdog settings
      • Configure the stalled bot watchdog
    • Settings
      • Preview or recalculate team waiting markers
    • Knowledge
      • List knowledge sources without secrets
      • Create authenticated URL knowledge source
      • Update URL source configuration
      • Queue forced URL reread (may spend embeddings)
    • AI summaries
      • getAiSummarySettings
      • updateAiSummarySettings
      • getAiSummaryCosts
      • Preview a paid AI summary without operational writes
    • AI agents
      • Read AI usage and estimated cost by agent and day
        GET
      • List live company queries without credentials
        GET
      • Create a fixed HTTPS company query
        POST
      • Update a live company query
        PATCH
      • Delete query and remove it from company agents
        DELETE
      • Test GET without AI; also accepts inactive queries
        POST
      • Read agent configuration including allowed queries
        GET
      • Set agent query allowlist; empty list removes permissions
        PATCH
      • List reply guard rules
        GET
      • Create an ensaio reply guard rule
        POST
      • Patch reply guard rule
        PATCH
      • List reply guard hits
        GET
    • AI duty
      • Read AI duty settings
      • Replace AI duty settings
      • Preview or dismiss open AI seller tasks in bulk
  • Esquemas
    • PaginationMeta
    • KnowledgeUrlCreate
    • KnowledgeUrlPatch
    • Contact
    • KnowledgeSource
    • KnowledgeSourceResult
    • KnowledgeSourceList
    • Conversation
    • Channel
    • Flow
    • Template
    • Recipient
    • Message
    • ContactWrite
    • Operation
    • WebhookEventType
    • Error
    • WebhookEvent
    • WebhookTracking
    • MessageReceivedData
    • MessageStatusUpdatedData
    • MessageRequest
    • message.transcribed
    • MessageTranscribedData
    • message.updated
    • MessageUpdatedData
    • message.deleted
    • MessageDeletedData
    • MessageDeliveryError
    • ConversationCreatedData
    • ConversationUpdatedData
    • FlowExecutionUpdatedData
    • WebhookTestData
    • message.received
    • message.status.updated
    • conversation.created
    • conversation.updated
    • flow.execution.updated
    • webhook.test
    • ConversationDetail
    • StoreProductVariant
    • StoreOrderItem
    • StoreSummary
    • StoreProduct
    • StoreProductBatchResult
    • StoreProductWrite
    • order.created
    • StoreOrder
    • StoreCategory
    • StoreOrderPayment
    • StoreCategoryWrite
    • StoreOrderAgent
    • StoreCategoryPatch
    • OrderCreatedData
    • DiscountRules
    • StoreCouponInput
    • StoreProductPatch
    • StoreCoupon
    • AgentDiscountPolicyInput
    • OrderStatusUpdatedData
    • TemplateSendComponents
    • order.status.updated
    • StoreShippingOption
    • StoreOrderCreate
    • ContactTracking
    • CrmStage
    • CrmStageWrite
    • CrmStagePatch
    • CrmOpportunity
    • CrmOpportunityWrite
    • CrmOpportunityPatch
    • CrmOpportunityEventData
    • crm.opportunity.created
    • crm.opportunity.updated
    • crm.opportunity.stage_changed
    • crm.opportunity.archived
    • ConversationWebhookSnapshot
    • ConversationAssignedData
    • ConversationStatusChangedData
    • conversation.assigned
    • conversation.status_changed
    • ConversationWebhookActor
    • ConversationPanel
    • FieldOption
    • SupportGroup
    • FieldOptions
    • SupportGroupWaitPatch
    • FieldOptionsPatch
    • CustomFieldDefinition
    • CustomFieldCreate
    • CustomFieldPatch
    • ConversationFieldSnapshot
    • ConversationSelectSnapshot
    • ConversationFieldChange
    • conversation.fields_changed
    • ConversationFieldOptions
    • ConversationPanelPatch
    • ConversationFieldActor
    • EntryKind
    • EntrySettings
    • ConversationFieldsChangedData
    • CrmOpportunityUpsert
    • GroupDistributionReport
    • CrmOpportunityUpsertItem
    • CrmOpportunityUpsertResult
    • CrmOpportunityUpsertBatchResult
    • FlowEntries
    • StaleSessionSettings
    • StaleSessionSettingsPatch
    • MessageQuoteContext
    • TeamReplyRecalculation
    • InboxResponseSettings
    • OwnerlessFallbackPatch
    • OwnerlessFallbackSettings
    • OwnerlessFallbackApplication
    • AiSummarySettings
    • AiSummarySettingsPatch
    • AiSummaryUsage
    • AiSummaryCostReport
    • conversation.status_changed
    • AiAgentUsageDay
    • AiAgentUsage
    • ChannelActor
    • ChannelEvent
    • ChannelEventPage
    • ChannelAccountRejection
    • channel.status_changed
    • channel.account_status_changed
    • FlowMonitoringRule
    • EffectiveFlowMonitoringRule
    • MessageReactionResult
    • CompanyQueryParameter
    • CompanyQueryCreate
    • CompanyQueryPatch
    • CompanyQueryResult
    • CompanyQuery
    • CompanyQueryList
    • CompanyQueryTestResult
    • CompanyQueryTestInput
    • AiAgentQueryPatch
    • AiAgentQueryResult
    • CompanyQueryDeleteResult
    • ReplyGuardRuleCreate
    • ReplyGuardRulePatch
    • ReplyGuardRule
    • ReplyGuardRules
    • ReplyGuardSaved
    • ReplyGuardHit
    • ReplyGuardHits
    • ChannelRetirement
    • ChannelRetirementResult
    • AiDutySettingsResponse
    • AiDutySettings
    • WebhookEndpointWrite
    • WebhookEndpoint
    • WebhookEndpointWithSecret
    • MessageSendFailedData
    • message.send.failed
    • AiDutyPlantao
    • conversation.fields.updated
    • FieldMirror
    • ConversationFieldsUpdatedData
    • AiDutyDailyTriggerCounters
    • RateLimitError
    • AiDutySettingsRead
    • TemplateCreateRequest
    • QueuePolicy
    • QueuePolicyPatch
    • DismissAiSuggestionsInput
    • DismissAiSuggestionsResult
  1. AI agents

Patch reply guard rule

PATCH
/ai-agents/{agentUuid}/guard-rules/{ruleUuid}
Agent and rules are scoped to the token company. Requires Business plan, an active authorized user and settings.general. Configuration uses the same camelCase fields as MCP. No rules are seeded on installation. Requires explicit ai_agents:write. Omitted fields are preserved. Ativo may spend one text-only rewrite within the original turn deadline, then safe_text or direct handoff to the agent group. No tools are replayed.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200OK
application/json
Success
Bodyapplication/json

🟠401Não Autorizado
🟠403Proibido
🟠404Registo Não Encontrado
🟠422Erro de Parâmetro
🟠429
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH '/ai-agents//guard-rules/' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "kind": "text_pattern",
    "patterns": [
        "string"
    ],
    "minMatches": 1,
    "ignorePatterns": [],
    "dayWords": [
        "string"
    ],
    "condition": null,
    "correction": "string",
    "finalAction": {
        "type": "safe_text",
        "text": "string"
    },
    "mode": "ensaio",
    "enabled": true
}'
Response Response Example
200 - Exemplo 1
{
    "agentUuid": "7575cf62-4caa-4e7d-b264-bc807d805a6c",
    "rule": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "name": "string",
        "kind": "text_pattern",
        "patterns": [
            "string"
        ],
        "minMatches": 1,
        "ignorePatterns": [],
        "dayWords": [
            "string"
        ],
        "condition": null,
        "correction": "string",
        "finalAction": {
            "type": "safe_text",
            "text": "string"
        },
        "mode": "ensaio",
        "enabled": true,
        "createdAt": "2019-08-24T14:15:22.123Z",
        "updatedAt": "2019-08-24T14:15:22.123Z"
    }
}
Modificado em 2026-10-22 18:13:52
Página anterior
Create an ensaio reply guard rule
Próxima página
List reply guard hits
Built with