> ## Documentation Index > Fetch the complete documentation index at: https://docs.yampi.ai/llms.txt > Use this file to discover all available pages before exploring further. # Add a new automation rule > Add a new automation rule to account ## OpenAPI ````yaml /openapi/application.json post /api/v1/accounts/{account_id}/automation_rules openapi: 3.1.0 info: title: API de Yampi description: >- API de cuenta de Yampi: chats, inventario, negocios, contratos, tesorería y Livia. Autenticación con el header `api_access_token`. version: 1.2.0 termsOfService: https://yampi.ai/terms/ contact: email: hola@yampi.ai license: name: MIT License url: https://opensource.org/licenses/MIT servers: - url: https://app.yampi.ai description: Producción security: [] tags: - name: Agents description: Agent management APIs - name: Canned Responses description: Pre-defined responses for common queries - name: Contacts description: Contact management APIs - name: Contact Labels description: Manage contact labels - name: Conversation Assignments description: Manage conversation assignments - name: Conversation Labels description: Manage conversation labels - name: Conversations description: Conversation management APIs - name: Custom Attributes description: Custom fields for contacts and conversations - name: Custom Filters description: Saved filters for conversations - name: Inboxes description: Communication channels setup - name: Integrations description: Third-party integrations - name: Messages description: Message management APIs - name: Profile description: User profile APIs - name: Reports description: Analytics and reporting APIs - name: Teams description: Team management APIs - name: Webhooks description: Event notification webhooks - name: Automation Rule description: Workflow automation rules - name: Help Center description: Knowledge base management - name: Account description: Current account profile and settings - name: Audit Logs description: Account audit log - name: Properties description: Property portfolio APIs - name: Companies description: Company CRM APIs - name: Opportunities description: Opportunity CRM APIs - name: Opportunity Reminders description: Reminders on opportunities - name: Contract Templates description: Contract template library - name: Contract Submissions description: Contract sending and tracking - name: Livia description: Livia assistants - name: Livia Tareas description: Livia one-shot AI tasks - name: SLA Policies description: SLA policy management - name: Applied SLAs description: SLA instances applied to conversations - name: SAML Settings description: Account SAML SSO settings - name: Treasury Subscriptions description: Recurring treasury subscriptions - name: Treasury Payments description: Treasury payment recording - name: Treasury Payouts description: Subscription payouts - name: Treasury Adjustments description: Debit and credit adjustments - name: Treasury Rules description: Notification, retry, collection and tax rules - name: Treasury Dashboard description: Treasury dashboard - name: Treasury Settings description: Treasury account settings - name: Treasury Owners description: Owner statements - name: Treasury Reports description: Aging and commission reports - name: Livia Documentos description: Livia knowledge documents - name: Livia Escenarios description: Livia assistant scenarios - name: Livia Herramientas description: Livia custom HTTP tools - name: Livia Desk description: Livia copilot threads and messages - name: Livia Preferencias description: Account-level Livia preferences - name: Documents description: Account document library - name: Document Folders description: Document library folders - name: Calendar Events description: Account calendar, availability and booking links - name: Agent Tasks description: Agent task inbox and lifecycle - name: Labels description: Account labels - name: Notifications description: User notifications and notification settings - name: Search description: Account search and AI search - name: Macros description: Conversation macros - name: Campaigns description: Outbound campaigns - name: Flow Definitions description: Livia flow builder - name: Custom Roles description: Custom agent roles - name: Assignment Policies description: Conversation assignment policies - name: Requirements description: Capture requirements - name: Zones description: Location zones and cities - name: Geocoding description: Authenticated geocoding - name: Domains description: Account custom domains - name: Connector Clients description: MCP connector client identifiers - name: Presigned Contracts description: Already-signed contracts uploaded to the account - name: Contract Webhooks description: Outbound contract webhook URLs - name: Contracts Settings description: Account contracts settings - name: Treasury Disbursements description: Owner and agency disbursements - name: Treasury Collections description: Collection steps, notices, agreements and exceptions - name: Treasury Guarantees description: Rental guarantees and claims - name: Treasury E-Invoices description: Electronic invoicing - name: Treasury Available Contracts description: Completed contracts that can seed subscriptions - name: Opportunity Pipelines description: CRM funnels - name: Opportunity Columns description: CRM kanban columns - name: Opportunity Lose Reasons description: CRM lose reasons - name: Requirement Quotes description: Priced quotes on capture requirements - name: Conversation Participants description: Agents participating in a conversation - name: Conversation Draft Messages description: Per-conversation composer drafts - name: MCP description: Account-scoped MCP JSON-RPC server - name: Treasury Bank Batches description: Bank payout files and beneficiary account confirmation - name: Contact Assignment Requests description: Requests to be assigned a contact - name: Onboarding description: Account onboarding details - name: Owner Portal Invites description: Owner portal invite, eligibility and revoke - name: Channel Authorizations description: Start OAuth or embedded signup for inbox channels - name: CSAT Survey Responses description: Account CSAT responses, metrics and review notes - name: Dashboard description: Account dashboard summary and trends - name: Dashboard Apps description: Embedded dashboard apps - name: Bulk Actions description: Bulk conversation and contact actions - name: Assignable Agents description: Agents assignable across a set of inboxes - name: Tracking Pixels description: Advertising tracking pixels - name: Calls description: Account call history - name: WhatsApp Calls description: WhatsApp voice calls paths: /api/v1/accounts/{account_id}/automation_rules: parameters: - $ref: '#/components/parameters/account_id' post: tags: - Automation Rule summary: Add a new automation rule description: Add a new automation rule to account operationId: add-new-automation-rule-to-account requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/automation_rule_create_update_payload' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/automation_rule' '403': description: Access denied content: application/json: schema: $ref: '#/components/schemas/bad_request_error' security: - userApiKey: [] components: parameters: account_id: in: path name: account_id schema: type: integer required: true description: The numeric ID of the account schemas: automation_rule_create_update_payload: type: object properties: name: type: string description: Rule name example: Add label on message create event description: type: string description: The description about the automation and actions example: >- Add label support and sales on message create event if incoming message content contains text help event_name: type: string enum: - conversation_created - conversation_updated - conversation_resolved - message_created example: message_created description: The event when you want to execute the automation actions active: type: boolean description: Enable/disable automation rule actions: type: array description: >- Array of actions which you want to perform when condition matches, e.g add label support if message contains content help. items: type: object example: action_name: add_label action_params: - support conditions: type: array description: >- Array of conditions on which conversation filter would work, e.g message content contains text help. items: type: object example: attribute_key: content filter_operator: contains query_operator: OR values: - help automation_rule: type: object properties: payload: description: Response payload that contains automation rule(s) oneOf: - type: array description: Array of automation rules (for listing endpoint) items: $ref: '#/components/schemas/automation_rule_item' - type: object description: Single automation rule (for show/create/update endpoints) allOf: - $ref: '#/components/schemas/automation_rule_item' bad_request_error: title: data type: object properties: description: type: string errors: type: array items: $ref: '#/components/schemas/request_error' automation_rule_item: type: object properties: id: type: integer description: The ID of the automation rule account_id: type: integer description: Account Id name: type: string description: The name of the rule example: Add label on message create event description: type: string description: Description to give more context about the rule example: >- Add label support and sales on message create event if incoming message content contains text help event_name: type: string description: >- Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created) enum: - conversation_created - conversation_updated - message_created example: message_created conditions: type: array description: Array of conditions on which conversation/message filter would work items: type: object properties: values: type: array items: type: string attribute_key: type: string query_operator: type: string filter_operator: type: string example: attribute_key: content filter_operator: contains values: - help query_operator: and actions: type: array description: Array of actions which we perform when condition matches items: type: object properties: action_name: type: string action_params: type: array items: type: string example: action_name: add_label action_params: - support - sales created_on: type: integer description: The timestamp when the rule was created active: type: boolean description: Enable/disable automation rule request_error: type: object properties: field: type: string message: type: string code: type: string securitySchemes: userApiKey: type: apiKey in: header name: api_access_token description: >- Token de usuario. Envía el valor en el header `api_access_token`. Lo obtienes en el perfil (`GET /api/v1/profile`) o al regenerarlo. ````