> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chatclean.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Inbox

> Update an existing inbox



## OpenAPI

````yaml /openapi.json patch /api/v1/accounts/{account_id}/inboxes/{id}
openapi: 3.1.0
info:
  title: ChatClean API
  description: API REST do ChatClean.
  version: 1.1.0
  contact:
    email: contato@chatclean.com.br
servers:
  - url: https://chat.chatclean.com.br
security: []
tags:
  - name: Account AgentBots
    description: Account-specific Agent Bots
  - name: Agents
    description: Agent management APIs
  - name: Campaigns
    description: >-
      Create, schedule, and manage campaigns. Requires an account administrator
      and API access enabled for the account.
  - 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: Labels
    description: Account label management APIs
  - 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: Contacts API
    description: Public contact APIs
  - name: Conversations API
    description: Public conversation APIs
  - name: Messages API
    description: Public message APIs
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:
        - userBearerAuth: []
        - 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
        branded_email_layout:
          type:
            - string
            - 'null'
          maxLength: 262144
          description: >
            Liquid HTML layout for outbound email replies. Must include `{{
            content_for_layout }}` and be 262,144 characters or shorter.


            Available for: `Email`
          example: <html><body>{{ content_for_layout }}</body></html>
        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
            - 'null'
          description: Website URL
        page_id:
          type:
            - string
            - 'null'
          description: Facebook Page ID associated with the inbox
        instagram_id:
          type:
            - string
            - 'null'
          description: Instagram account ID associated with the inbox
        business_id:
          type:
            - string
            - 'null'
          description: TikTok business ID associated with the inbox
        provider_name:
          type:
            - string
            - 'null'
          description: Provider username or page name associated with the social inbox
        profile_id:
          type:
            - string
            - 'null'
          description: X profile ID associated with the inbox
        line_channel_id:
          type:
            - string
            - 'null'
          description: LINE channel ID associated with the inbox
        email:
          type:
            - string
            - 'null'
          description: Email address associated with the inbox
        bot_name:
          type:
            - string
            - 'null'
          description: Telegram bot name associated with the inbox
        inbox_identifier:
          type:
            - string
            - 'null'
          description: Public identifier associated with an API inbox
        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
            - 'null'
          description: Widget Color used for customization of the widget
        website_token:
          type:
            - string
            - 'null'
          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
            - 'null'
          description: Script used to load the website widget
        welcome_title:
          type:
            - string
            - 'null'
          description: Welcome title to be displayed on the widget
        welcome_tagline:
          type:
            - string
            - 'null'
          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
            - 'null'
          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
            - 'null'
          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
                  - 'null'
                description: Hour when inbox opens (0-23)
              open_minutes:
                type:
                  - number
                  - 'null'
                description: Minutes of the hour when inbox opens (0-59)
              close_hour:
                type:
                  - number
                  - 'null'
                description: Hour when inbox closes (0-23)
              close_minutes:
                type:
                  - number
                  - 'null'
                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
            - 'null'
          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
            - 'null'
          description: Business name associated with the inbox
        branded_email_layout:
          type:
            - string
            - 'null'
          description: >-
            Liquid HTML layout for branded email replies. Available to
            administrators for Email inbox show/update responses.
        hmac_mandatory:
          type:
            - boolean
            - 'null'
          description: Whether HMAC verification is mandatory
        selected_feature_flags:
          type:
            - array
            - 'null'
          description: Selected feature flags for the inbox
          items:
            type: string
        reply_time:
          type:
            - string
            - 'null'
          description: Expected reply time
        messaging_service_sid:
          type:
            - string
            - 'null'
          description: Messaging service SID for SMS providers
        phone_number:
          type:
            - string
            - 'null'
          description: Phone number associated with the inbox
        medium:
          type: string
          description: Medium of communication (e.g., sms, email)
        provider:
          type:
            - string
            - 'null'
          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:
    userBearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate with `Authorization: Bearer <token>` using a user API token
        from **Profile Settings**.
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: >-
        Find your API token in **Profile Settings**. The `api_access_token`
        header remains supported, but will be deprecated in a future release.
        For new integrations, use Bearer authentication.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.