> ## 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. # Update Inbox > Update an existing inbox ## OpenAPI ````yaml /openapi/application.json patch /api/v1/accounts/{account_id}/inboxes/{id} 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}/inboxes/{id}: patch: tags: - Inboxes summary: Update Inbox description: Update an existing inbox operationId: updateInbox parameters: - $ref: '#/components/parameters/account_id' - name: id in: path schema: type: number description: ID of the inbox required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/inbox_update_payload' examples: web_widget: summary: Website inbox settings value: name: Support greeting_enabled: true greeting_message: Hello, how can I help you? enable_email_collect: true enable_auto_assignment: true working_hours_enabled: true timezone: America/New_York allow_messages_after_resolved: true channel: website_url: https://example.com welcome_title: Welcome to our support welcome_tagline: We are here to help you widget_color: '#FF5733' reply_time: in_a_few_minutes pre_chat_form_enabled: false continuity_via_email: true hmac_mandatory: false selected_feature_flags: - attachments - emoji_picker - end_conversation api: summary: API channel settings value: name: API Inbox greeting_enabled: true greeting_message: Hello, how can I help you? enable_auto_assignment: true working_hours_enabled: true timezone: America/New_York channel: webhook_url: https://example.com/webhook hmac_mandatory: false additional_attributes: source: mobile_app email: summary: Email channel settings value: name: Email Inbox greeting_enabled: true greeting_message: Hello, how can I help you? enable_auto_assignment: true working_hours_enabled: true timezone: America/New_York channel: email: support@example.com imap_enabled: false smtp_enabled: false line: summary: LINE channel settings value: name: LINE Inbox greeting_enabled: true greeting_message: Hello, how can I help you? enable_auto_assignment: true working_hours_enabled: true timezone: America/New_York channel: line_channel_id: '1234567890' line_channel_secret: line-channel-secret line_channel_token: line-channel-token telegram: summary: Telegram channel settings value: name: Telegram Inbox greeting_enabled: true greeting_message: Hello, how can I help you? enable_auto_assignment: true working_hours_enabled: true timezone: America/New_York channel: bot_token: 123456789:telegram-bot-token whatsapp: summary: WhatsApp channel settings value: name: WhatsApp Inbox greeting_enabled: true greeting_message: Hello, how can I help you? enable_auto_assignment: true working_hours_enabled: true timezone: America/New_York channel: phone_number: '+15551234567' provider: whatsapp_cloud provider_config: api_key: your-api-key phone_number_id: your-phone-number-id business_account_id: your-business-account-id sms: summary: SMS channel settings value: name: SMS Inbox greeting_enabled: true greeting_message: Hello, how can I help you? enable_auto_assignment: true working_hours_enabled: true timezone: America/New_York channel: phone_number: '+15551234567' provider_config: api_key: your-api-key api_secret: your-api-secret application_id: your-application-id account_id: your-account-id responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/inbox' '403': description: Access denied content: application/json: schema: $ref: '#/components/schemas/bad_request_error' '404': description: Inbox not found 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: inbox_update_payload: type: object properties: name: type: string description: The name of the inbox. example: Support avatar: type: string format: binary description: Image file for avatar. greeting_enabled: type: boolean description: Enable greeting message. example: true greeting_message: type: string description: Greeting message to send when greeting messages are enabled. example: Hello, how can I help you? enable_email_collect: type: boolean description: | Enable email collection. Available for: `Website` example: true csat_survey_enabled: type: boolean description: Enable CSAT survey. example: true csat_config: type: object description: CSAT survey configuration. properties: display_type: type: string description: Display style for the CSAT survey. enum: - emoji - star example: emoji message: type: string description: Message shown with the CSAT survey. example: Please rate your conversation button_text: type: string description: Text shown on the CSAT survey button. example: Please rate us language: type: string description: Language code for the CSAT survey. example: en survey_rules: type: object description: Rules that decide when to show the CSAT survey. properties: operator: type: string example: contains values: type: array items: type: string example: - billing enable_auto_assignment: type: boolean description: Enable Auto Assignment. example: true working_hours_enabled: type: boolean description: Enable working hours. example: true out_of_office_message: type: string description: Out of office message to send outside working hours. example: >- We are currently out of office. Please leave a message and we will get back to you. timezone: type: string description: Timezone of the inbox. example: America/New_York allow_messages_after_resolved: type: boolean description: | Allow messages after conversation is resolved. Available for: `Website` example: true lock_to_single_conversation: type: boolean description: | Lock contact messages to a single active conversation. Available for: `API` `LINE` `Telegram` `WhatsApp` `SMS` example: true portal_id: type: integer description: Id of the help center portal to attach to the inbox. example: 1 sender_name_type: type: string description: | Sender name type for outbound email replies. Available for: `Website` `Email` enum: - friendly - professional example: friendly business_name: type: string description: | Business name for outbound email replies. Available for: `Website` `Email` example: My Business channel: anyOf: - $ref: '#/components/schemas/inbox_update_web_widget_channel_payload' - $ref: '#/components/schemas/inbox_update_api_channel_payload' - $ref: '#/components/schemas/inbox_update_email_channel_payload' - $ref: '#/components/schemas/inbox_update_line_channel_payload' - $ref: '#/components/schemas/inbox_update_telegram_channel_payload' - $ref: '#/components/schemas/inbox_update_whatsapp_channel_payload' - $ref: '#/components/schemas/inbox_update_sms_channel_payload' inbox: type: object properties: id: type: number description: ID of the inbox name: type: string description: The name of the inbox website_url: type: string description: Website URL channel_type: type: string description: The type of the inbox avatar_url: type: string description: The avatar image of the inbox widget_color: type: string description: Widget Color used for customization of the widget website_token: type: string description: Website Token enable_auto_assignment: type: boolean description: The flag which shows whether Auto Assignment is enabled or not web_widget_script: type: string description: Script used to load the website widget welcome_title: type: string description: Welcome title to be displayed on the widget welcome_tagline: type: string description: Welcome tagline to be displayed on the widget greeting_enabled: type: boolean description: The flag which shows whether greeting is enabled greeting_message: type: string description: A greeting message when the user starts the conversation channel_id: type: number description: ID of the channel this inbox belongs to working_hours_enabled: type: boolean description: The flag which shows whether working hours feature is enabled enable_email_collect: type: boolean description: The flag to enable collecting email from contacts csat_survey_enabled: type: boolean description: The flag to enable CSAT survey auto_assignment_config: type: object description: Configuration settings for auto assignment out_of_office_message: type: string description: Message to show when agents are out of office working_hours: type: array description: Configuration for working hours of the inbox items: type: object properties: day_of_week: type: number description: Day of the week (0-6, where 0 is Sunday) closed_all_day: type: boolean description: Whether the inbox is closed for the entire day open_hour: type: number description: Hour when inbox opens (0-23) open_minutes: type: number description: Minutes of the hour when inbox opens (0-59) close_hour: type: number description: Hour when inbox closes (0-23) close_minutes: type: number description: Minutes of the hour when inbox closes (0-59) open_all_day: type: boolean description: Whether the inbox is open for the entire day timezone: type: string description: Timezone configuration for the inbox callback_webhook_url: type: string description: Webhook URL for callbacks allow_messages_after_resolved: type: boolean description: Whether to allow messages after a conversation is resolved lock_to_single_conversation: type: boolean description: Whether to lock a contact to a single conversation sender_name_type: type: string description: Type of sender name to display (e.g., friendly) business_name: type: string description: Business name associated with the inbox hmac_mandatory: type: boolean description: Whether HMAC verification is mandatory selected_feature_flags: type: object description: Selected feature flags for the inbox reply_time: type: string description: Expected reply time messaging_service_sid: type: string description: Messaging service SID for SMS providers phone_number: type: string description: Phone number associated with the inbox medium: type: string description: Medium of communication (e.g., sms, email) provider: type: string description: Provider of the channel bad_request_error: title: data type: object properties: description: type: string errors: type: array items: $ref: '#/components/schemas/request_error' inbox_update_web_widget_channel_payload: type: object title: Website channel settings properties: website_url: type: string description: URL at which the widget will be loaded example: https://example.com welcome_title: type: string description: Welcome title to be displayed on the widget example: Welcome to our support welcome_tagline: type: string description: Welcome tagline to be displayed on the widget example: We are here to help you widget_color: type: string description: A Hex-color string used to customize the widget example: '#FF5733' reply_time: type: string description: Expected reply time shown on the widget enum: - in_a_few_minutes - in_a_few_hours - in_a_day example: in_a_few_minutes pre_chat_form_enabled: type: boolean description: Enable the pre-chat form before starting a conversation example: false pre_chat_form_options: type: object description: Pre-chat form configuration example: pre_chat_message: Share your queries or comments here. pre_chat_fields: - field_type: standard label: Email Id name: emailAddress type: email required: true enabled: true continuity_via_email: type: boolean description: >- Continue conversations over email when the contact leaves the website example: true hmac_mandatory: type: boolean description: Require HMAC verification for contacts using the widget example: false allowed_domains: type: string description: Comma-separated list of domains where the widget is allowed to load example: example.com selected_feature_flags: type: array description: Enabled widget feature flags items: type: string enum: - attachments - emoji_picker - end_conversation - use_inbox_avatar_for_bot - allow_mobile_webview example: - attachments - emoji_picker - end_conversation inbox_update_api_channel_payload: type: object title: API channel settings properties: webhook_url: type: string description: Webhook URL for API channel inbox callbacks example: https://example.com/webhook hmac_mandatory: type: boolean description: Require HMAC verification for incoming API channel messages example: false additional_attributes: type: object description: >- Additional attributes stored on contacts created through the API channel example: source: mobile_app inbox_update_email_channel_payload: type: object title: Email channel settings properties: email: type: string description: Email address for the inbox example: support@example.com imap_enabled: type: boolean description: Enable IMAP for inbound emails example: true imap_login: type: string description: IMAP login username example: support@example.com imap_password: type: string description: IMAP login password example: your-imap-password imap_address: type: string description: IMAP server address example: imap.example.com imap_port: type: integer description: IMAP server port example: 993 imap_enable_ssl: type: boolean description: Enable SSL for IMAP example: true imap_authentication: type: string description: IMAP authentication method example: plain smtp_enabled: type: boolean description: Enable SMTP for outbound emails example: true smtp_login: type: string description: SMTP login username example: support@example.com smtp_password: type: string description: SMTP login password example: your-smtp-password smtp_address: type: string description: SMTP server address example: smtp.example.com smtp_port: type: integer description: SMTP server port example: 587 smtp_domain: type: string description: SMTP HELO domain example: example.com smtp_enable_starttls_auto: type: boolean description: Automatically enable STARTTLS for SMTP example: true smtp_enable_ssl_tls: type: boolean description: Enable SSL/TLS for SMTP example: false smtp_openssl_verify_mode: type: string description: OpenSSL certificate verification mode for SMTP example: none smtp_authentication: type: string description: SMTP authentication method example: login provider: type: string description: Email provider example: google verified_for_sending: type: boolean description: Whether the inbox is verified for sending emails example: false inbox_update_line_channel_payload: type: object title: LINE channel settings properties: line_channel_id: type: string description: LINE channel ID example: '1234567890' line_channel_secret: type: string description: LINE channel secret example: line-channel-secret line_channel_token: type: string description: LINE channel access token example: line-channel-token inbox_update_telegram_channel_payload: type: object title: Telegram channel settings properties: bot_token: type: string description: Telegram bot token example: 123456789:telegram-bot-token inbox_update_whatsapp_channel_payload: type: object title: WhatsApp channel settings properties: phone_number: type: string description: WhatsApp phone number example: '+15551234567' provider: type: string description: >- WhatsApp provider. `default` is supported only for existing deprecated 360dialog setups. enum: - whatsapp_cloud - default example: whatsapp_cloud provider_config: type: object description: >- WhatsApp provider configuration. Cloud channels use `api_key`, `phone_number_id`, and `business_account_id`; legacy 360dialog channels use `api_key`. properties: api_key: type: string description: Provider API key example: your-api-key phone_number_id: type: string description: Phone number ID for WhatsApp Cloud example: your-phone-number-id business_account_id: type: string description: Business account ID for WhatsApp Cloud example: your-business-account-id example: api_key: your-api-key phone_number_id: your-phone-number-id business_account_id: your-business-account-id inbox_update_sms_channel_payload: type: object title: SMS channel settings properties: phone_number: type: string description: SMS phone number example: '+15551234567' provider_config: type: object description: Provider-specific SMS configuration example: api_key: your-api-key api_secret: your-api-secret application_id: your-application-id account_id: your-account-id 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. ````