Provider username or page name associated with the social inbox
profile_id
string | null
X profile ID associated with the inbox
line_channel_id
string | null
LINE channel ID associated with the inbox
email
string | null
Email address associated with the inbox
bot_name
string | null
Telegram bot name associated with the inbox
inbox_identifier
string | null
Public identifier associated with an API inbox
channel_type
string
The type of the inbox
avatar_url
string
The avatar image of the inbox
widget_color
string | null
Widget Color used for customization of the widget
website_token
string | null
Website Token
enable_auto_assignment
boolean
The flag which shows whether Auto Assignment is enabled or not
web_widget_script
string | null
Script used to load the website widget
welcome_title
string | null
Welcome title to be displayed on the widget
welcome_tagline
string | null
Welcome tagline to be displayed on the widget
greeting_enabled
boolean
The flag which shows whether greeting is enabled
greeting_message
string | null
A greeting message when the user starts the conversation
channel_id
number
ID of the channel this inbox belongs to
working_hours_enabled
boolean
The flag which shows whether working hours feature is enabled
enable_email_collect
boolean
The flag to enable collecting email from contacts
csat_survey_enabled
boolean
The flag to enable CSAT survey
auto_assignment_config
object
Configuration settings for auto assignment
out_of_office_message
string | null
Message to show when agents are out of office
working_hours
object[]
Configuration for working hours of the inbox
Show child attributes
timezone
string
Timezone configuration for the inbox
callback_webhook_url
string | null
Webhook URL for callbacks
allow_messages_after_resolved
boolean
Whether to allow messages after a conversation is resolved
lock_to_single_conversation
boolean
Whether to lock a contact to a single conversation
sender_name_type
string
Type of sender name to display (e.g., friendly)
business_name
string | null
Business name associated with the inbox
branded_email_layout
string | null
Liquid HTML layout for branded email replies. Available to administrators for Email inbox show/update responses.
hmac_mandatory
boolean | null
Whether HMAC verification is mandatory
selected_feature_flags
string[] | null
Selected feature flags for the inbox
reply_time
string | null
Expected reply time
messaging_service_sid
string | null
Messaging service SID for SMS providers
phone_number
string | null
Phone number associated with the inbox
medium
string
Medium of communication (e.g., sms, email)
provider
string | null
Provider of the channel
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"ChatClean Docs","colors":{"primary":"#007a2a","light":"#71d083","dark":"#007a2a"},"logo":{"light":"https://mintcdn.com/chatclean/pm82rvBlHsXfnPWu/logo/light.png?fit=max\u0026auto=format\u0026n=pm82rvBlHsXfnPWu\u0026q=85\u0026s=edcaa9d2c42c176e3bceaae6644055a2","dark":"https://mintcdn.com/chatclean/pm82rvBlHsXfnPWu/logo/dark.png?fit=max\u0026auto=format\u0026n=pm82rvBlHsXfnPWu\u0026q=85\u0026s=7f4bf0e8307b49606f1e74d72a28a0fb","href":"https://docs.chatclean.com.br"},"favicon":"https://mintcdn.com/chatclean/pm82rvBlHsXfnPWu/logo/favicon.png?fit=max\u0026auto=format\u0026n=pm82rvBlHsXfnPWu\u0026q=85\u0026s=5e5cfa9365f749434b51890b690c7238","appearance":{"default":"light"},"navbar":{"links":[{"href":"mailto:contato@chatclean.com.br","label":"Suporte"}],"primary":{"type":"button","label":"Acessar o ChatClean","href":"https://chat.chatclean.com.br"}},"footer":{"socials":{"website":"https://chatclean.com.br"}},"seo":{"metatags":{"canonical":"https://docs.chatclean.com.br"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"chatclean","hasAudioNarration":false,"actualSubdomain":"chatclean","customDomains":["docs.chatclean.com.br"],"gitSource":{"type":"github","owner":"chat-clean","repo":"docs-chatclean","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":"","_id":"6afc65ac799281c7b11aae1e"},"entitlements":{},"buildId":"6afc68dbc86394d12be90851","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Referência da API","count":138},{"language":"default","tag":"API da aplicação","count":135},{"language":"default","tag":"Documentação","count":41},{"language":"default","tag":"Conversations","count":15},{"language":"default","tag":"Inboxes","count":13},{"language":"default","tag":"Reports","count":12},{"language":"default","tag":"Contacts","count":11},{"language":"default","tag":"Canais","count":9},{"language":"default","tag":"Teams","count":9},{"language":"default","tag":"Configurações","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/inboxes/update-inbox","slug":"/api-reference/inboxes/update-inbox","pageMetadata":{"title":"Update Inbox","description":"Update an existing inbox","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/inboxes/{id}","href":"/api-reference/inboxes/update-inbox","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Update an existing inbox\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update Inbox","description":"Update an existing inbox","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/inboxes/{id}","href":"/api-reference/inboxes/update-inbox","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Inboxes"],"operationId":"updateInbox","summary":"Update Inbox","security":["f2602884-0f5d-4331-b424-b894a8452325","53612f18-1b54-4f79-8246-ea1fcf0c7481"],"description":"Update an existing inbox","parameters":["45548e62-7c06-4bbf-bdfc-36021761599f","ddfa04ae-21b0-4efb-8604-30c25d69bf3f"],"requestBody":"76569d65-7cc2-45a3-8bab-b3e75ad3b466","responses":{"200":"32b52a37-fb38-4b88-83d5-30485e2b8af7","403":"cc951e67-d238-4cc2-bfe2-9395130a9958","404":"c2e2e22b-64c3-4944-afd5-06845ae5dcd9"},"method":"patch","type":"path","servers":["3aee7a20-f52f-42b4-bfc3-0b66705cdd66"],"path":"/api/v1/accounts/{account_id}/inboxes/{id}","baseUrlOptions":["https://chat.chatclean.com.br"],"title":"Update Inbox","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"45548e62-7c06-4bbf-bdfc-36021761599f":{"in":"path","name":"account_id","schema":{"type":"integer","isRequired":true,"description":"The numeric ID of the account","uniqueKey":"","typeLabel":"integer"},"required":true,"description":"The numeric ID of the account"},"ddfa04ae-21b0-4efb-8604-30c25d69bf3f":{"name":"id","in":"path","schema":{"type":"number","isRequired":true,"description":"ID of the inbox","uniqueKey":"","typeLabel":"number"},"description":"ID of the inbox","required":true}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the inbox.","example":"Support","uniqueKey":"name","typeLabel":"string"},"avatar":{"type":"string","format":"binary","description":"Image file for avatar.","uniqueKey":"avatar","typeLabel":"file"},"greeting_enabled":{"type":"boolean","description":"Enable greeting message.","example":true,"uniqueKey":"greeting_enabled","typeLabel":"boolean"},"greeting_message":{"type":"string","description":"Greeting message to send when greeting messages are enabled.","example":"Hello, how can I help you?","uniqueKey":"greeting_message","typeLabel":"string"},"enable_email_collect":{"type":"boolean","description":"Enable email collection.\n\nAvailable for: `Website`\n","example":true,"uniqueKey":"enable_email_collect","typeLabel":"boolean"},"csat_survey_enabled":{"type":"boolean","description":"Enable CSAT survey.","example":true,"uniqueKey":"csat_survey_enabled","typeLabel":"boolean"},"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","uniqueKey":"csat_config.display_type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Message shown with the CSAT survey.","example":"Please rate your conversation","uniqueKey":"csat_config.message","typeLabel":"string"},"button_text":{"type":"string","description":"Text shown on the CSAT survey button.","example":"Please rate us","uniqueKey":"csat_config.button_text","typeLabel":"string"},"language":{"type":"string","description":"Language code for the CSAT survey.","example":"en","uniqueKey":"csat_config.language","typeLabel":"string"},"survey_rules":{"type":"object","description":"Rules that decide when to show the CSAT survey.","properties":{"operator":{"type":"string","example":"contains","uniqueKey":"csat_config.survey_rules.operator","typeLabel":"string"},"values":{"type":"array","items":{"type":"string","uniqueKey":"csat_config.survey_rules.values.items.[INDEX]","typeLabel":"string"},"example":["billing"],"uniqueKey":"csat_config.survey_rules.values","typeLabel":"string[]"}},"uniqueKey":"csat_config.survey_rules","typeLabel":"object"}},"uniqueKey":"csat_config","typeLabel":"object"},"enable_auto_assignment":{"type":"boolean","description":"Enable Auto Assignment.","example":true,"uniqueKey":"enable_auto_assignment","typeLabel":"boolean"},"working_hours_enabled":{"type":"boolean","description":"Enable working hours.","example":true,"uniqueKey":"working_hours_enabled","typeLabel":"boolean"},"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.","uniqueKey":"out_of_office_message","typeLabel":"string"},"timezone":{"type":"string","description":"Timezone of the inbox.","example":"America/New_York","uniqueKey":"timezone","typeLabel":"string"},"allow_messages_after_resolved":{"type":"boolean","description":"Allow messages after conversation is resolved.\n\nAvailable for: `Website`\n","example":true,"uniqueKey":"allow_messages_after_resolved","typeLabel":"boolean"},"lock_to_single_conversation":{"type":"boolean","description":"Lock contact messages to a single active conversation.\n\nAvailable for: `API` `LINE` `Telegram` `WhatsApp` `SMS`\n","example":true,"uniqueKey":"lock_to_single_conversation","typeLabel":"boolean"},"portal_id":{"type":"integer","description":"Id of the help center portal to attach to the inbox.","example":1,"uniqueKey":"portal_id","typeLabel":"integer"},"sender_name_type":{"type":"string","description":"Sender name type for outbound email replies.\n\nAvailable for: `Website` `Email`\n","enum":["friendly","professional"],"example":"friendly","uniqueKey":"sender_name_type","typeLabel":"enum\u003cstring>"},"business_name":{"type":"string","description":"Business name for outbound email replies.\n\nAvailable for: `Website` `Email`\n","example":"My Business","uniqueKey":"business_name","typeLabel":"string"},"branded_email_layout":{"oneOf":[{"type":"string","maxLength":262144,"description":"Liquid HTML layout for outbound email replies. Must include `{{ content_for_layout }}` and be 262,144 characters or shorter.\n\nAvailable for: `Email`\n","example":"\u003chtml>\u003cbody>{{ content_for_layout }}\u003c/body>\u003c/html>","uniqueKey":"branded_email_layout.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":262144,"description":"Liquid HTML layout for outbound email replies. Must include `{{ content_for_layout }}` and be 262,144 characters or shorter.\n\nAvailable for: `Email`\n","example":"\u003chtml>\u003cbody>{{ content_for_layout }}\u003c/body>\u003c/html>","uniqueKey":"branded_email_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"branded_email_layout","typeLabel":"string | null"},"channel":{"oneOf":[{"type":"object","title":"Website channel settings","properties":{"website_url":{"type":"string","description":"URL at which the widget will be loaded","example":"https://example.com","uniqueKey":"channel.oneOf.0.website_url","typeLabel":"string"},"welcome_title":{"type":"string","description":"Welcome title to be displayed on the widget","example":"Welcome to our support","uniqueKey":"channel.oneOf.0.welcome_title","typeLabel":"string"},"welcome_tagline":{"type":"string","description":"Welcome tagline to be displayed on the widget","example":"We are here to help you","uniqueKey":"channel.oneOf.0.welcome_tagline","typeLabel":"string"},"widget_color":{"type":"string","description":"A Hex-color string used to customize the widget","example":"#FF5733","uniqueKey":"channel.oneOf.0.widget_color","typeLabel":"string"},"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","uniqueKey":"channel.oneOf.0.reply_time","typeLabel":"enum\u003cstring>"},"pre_chat_form_enabled":{"type":"boolean","description":"Enable the pre-chat form before starting a conversation","example":false,"uniqueKey":"channel.oneOf.0.pre_chat_form_enabled","typeLabel":"boolean"},"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}]},"uniqueKey":"channel.oneOf.0.pre_chat_form_options","typeLabel":"object"},"continuity_via_email":{"type":"boolean","description":"Continue conversations over email when the contact leaves the website","example":true,"uniqueKey":"channel.oneOf.0.continuity_via_email","typeLabel":"boolean"},"hmac_mandatory":{"type":"boolean","description":"Require HMAC verification for contacts using the widget","example":false,"uniqueKey":"channel.oneOf.0.hmac_mandatory","typeLabel":"boolean"},"allowed_domains":{"type":"string","description":"Comma-separated list of domains where the widget is allowed to load","example":"example.com","uniqueKey":"channel.oneOf.0.allowed_domains","typeLabel":"string"},"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"],"uniqueKey":"channel.oneOf.0.selected_feature_flags.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["attachments","emoji_picker","end_conversation"],"uniqueKey":"channel.oneOf.0.selected_feature_flags","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"channel.oneOf.0","typeLabel":"Website channel settings · object"},{"type":"object","title":"API channel settings","properties":{"webhook_url":{"type":"string","description":"Webhook URL for API channel inbox callbacks","example":"https://example.com/webhook","uniqueKey":"channel.oneOf.1.webhook_url","typeLabel":"string"},"hmac_mandatory":{"type":"boolean","description":"Require HMAC verification for incoming API channel messages","example":false,"uniqueKey":"channel.oneOf.1.hmac_mandatory","typeLabel":"boolean"},"additional_attributes":{"type":"object","description":"Additional attributes stored on contacts created through the API channel","example":{"source":"mobile_app"},"uniqueKey":"channel.oneOf.1.additional_attributes","typeLabel":"object"}},"uniqueKey":"channel.oneOf.1","typeLabel":"API channel settings · object"},{"type":"object","title":"Email channel settings","properties":{"email":{"type":"string","description":"Email address for the inbox","example":"support@example.com","uniqueKey":"channel.oneOf.2.email","typeLabel":"string"},"imap_enabled":{"type":"boolean","description":"Enable IMAP for inbound emails","example":true,"uniqueKey":"channel.oneOf.2.imap_enabled","typeLabel":"boolean"},"imap_login":{"type":"string","description":"IMAP login username","example":"support@example.com","uniqueKey":"channel.oneOf.2.imap_login","typeLabel":"string"},"imap_password":{"type":"string","description":"IMAP login password","example":"your-imap-password","uniqueKey":"channel.oneOf.2.imap_password","typeLabel":"string"},"imap_address":{"type":"string","description":"IMAP server address","example":"imap.example.com","uniqueKey":"channel.oneOf.2.imap_address","typeLabel":"string"},"imap_port":{"type":"integer","description":"IMAP server port","example":993,"uniqueKey":"channel.oneOf.2.imap_port","typeLabel":"integer"},"imap_enable_ssl":{"type":"boolean","description":"Enable SSL for IMAP","example":true,"uniqueKey":"channel.oneOf.2.imap_enable_ssl","typeLabel":"boolean"},"imap_authentication":{"type":"string","description":"IMAP authentication method","example":"plain","uniqueKey":"channel.oneOf.2.imap_authentication","typeLabel":"string"},"smtp_enabled":{"type":"boolean","description":"Enable SMTP for outbound emails","example":true,"uniqueKey":"channel.oneOf.2.smtp_enabled","typeLabel":"boolean"},"smtp_login":{"type":"string","description":"SMTP login username","example":"support@example.com","uniqueKey":"channel.oneOf.2.smtp_login","typeLabel":"string"},"smtp_password":{"type":"string","description":"SMTP login password","example":"your-smtp-password","uniqueKey":"channel.oneOf.2.smtp_password","typeLabel":"string"},"smtp_address":{"type":"string","description":"SMTP server address","example":"smtp.example.com","uniqueKey":"channel.oneOf.2.smtp_address","typeLabel":"string"},"smtp_port":{"type":"integer","description":"SMTP server port","example":587,"uniqueKey":"channel.oneOf.2.smtp_port","typeLabel":"integer"},"smtp_domain":{"type":"string","description":"SMTP HELO domain","example":"example.com","uniqueKey":"channel.oneOf.2.smtp_domain","typeLabel":"string"},"smtp_enable_starttls_auto":{"type":"boolean","description":"Automatically enable STARTTLS for SMTP","example":true,"uniqueKey":"channel.oneOf.2.smtp_enable_starttls_auto","typeLabel":"boolean"},"smtp_enable_ssl_tls":{"type":"boolean","description":"Enable SSL/TLS for SMTP","example":false,"uniqueKey":"channel.oneOf.2.smtp_enable_ssl_tls","typeLabel":"boolean"},"smtp_openssl_verify_mode":{"type":"string","description":"OpenSSL certificate verification mode for SMTP","example":"none","uniqueKey":"channel.oneOf.2.smtp_openssl_verify_mode","typeLabel":"string"},"smtp_authentication":{"type":"string","description":"SMTP authentication method","example":"login","uniqueKey":"channel.oneOf.2.smtp_authentication","typeLabel":"string"},"provider":{"type":"string","description":"Email provider","example":"google","uniqueKey":"channel.oneOf.2.provider","typeLabel":"string"},"verified_for_sending":{"type":"boolean","description":"Whether the inbox is verified for sending emails","example":false,"uniqueKey":"channel.oneOf.2.verified_for_sending","typeLabel":"boolean"}},"uniqueKey":"channel.oneOf.2","typeLabel":"Email channel settings · object"},{"type":"object","title":"LINE channel settings","properties":{"line_channel_id":{"type":"string","description":"LINE channel ID","example":"1234567890","uniqueKey":"channel.oneOf.3.line_channel_id","typeLabel":"string"},"line_channel_secret":{"type":"string","description":"LINE channel secret","example":"line-channel-secret","uniqueKey":"channel.oneOf.3.line_channel_secret","typeLabel":"string"},"line_channel_token":{"type":"string","description":"LINE channel access token","example":"line-channel-token","uniqueKey":"channel.oneOf.3.line_channel_token","typeLabel":"string"}},"uniqueKey":"channel.oneOf.3","typeLabel":"LINE channel settings · object"},{"type":"object","title":"Telegram channel settings","properties":{"bot_token":{"type":"string","description":"Telegram bot token","example":"123456789:telegram-bot-token","uniqueKey":"channel.oneOf.4.bot_token","typeLabel":"string"}},"uniqueKey":"channel.oneOf.4","typeLabel":"Telegram channel settings · object"},{"type":"object","title":"WhatsApp channel settings","properties":{"phone_number":{"type":"string","description":"WhatsApp phone number","example":"+15551234567","uniqueKey":"channel.oneOf.5.phone_number","typeLabel":"string"},"provider":{"type":"string","description":"WhatsApp provider. `default` is supported only for existing deprecated 360dialog setups.","enum":["whatsapp_cloud","default"],"example":"whatsapp_cloud","uniqueKey":"channel.oneOf.5.provider","typeLabel":"enum\u003cstring>"},"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","uniqueKey":"channel.oneOf.5.provider_config.api_key","typeLabel":"string"},"phone_number_id":{"type":"string","description":"Phone number ID for WhatsApp Cloud","example":"your-phone-number-id","uniqueKey":"channel.oneOf.5.provider_config.phone_number_id","typeLabel":"string"},"business_account_id":{"type":"string","description":"Business account ID for WhatsApp Cloud","example":"your-business-account-id","uniqueKey":"channel.oneOf.5.provider_config.business_account_id","typeLabel":"string"}},"example":{"api_key":"your-api-key","phone_number_id":"your-phone-number-id","business_account_id":"your-business-account-id"},"uniqueKey":"channel.oneOf.5.provider_config","typeLabel":"object"}},"uniqueKey":"channel.oneOf.5","typeLabel":"WhatsApp channel settings · object"},{"type":"object","title":"SMS channel settings","properties":{"phone_number":{"type":"string","description":"SMS phone number","example":"+15551234567","uniqueKey":"channel.oneOf.6.phone_number","typeLabel":"string"},"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"},"uniqueKey":"channel.oneOf.6.provider_config","typeLabel":"object"}},"uniqueKey":"channel.oneOf.6","typeLabel":"SMS channel settings · object"}],"uniqueKey":"channel","typeLabel":"Website channel settings · object | API channel settings · object | Email channel settings · object | LINE channel settings · object | Telegram channel settings · object | WhatsApp channel settings · object | SMS channel settings · object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"web_widget":{"title":"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":{"title":"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":{"title":"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":{"title":"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":{"title":"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":{"title":"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":{"title":"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"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"32b52a37-fb38-4b88-83d5-30485e2b8af7":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"ID of the inbox","uniqueKey":"id","typeLabel":"number"},"name":{"type":"string","description":"The name of the inbox","uniqueKey":"name","typeLabel":"string"},"website_url":{"oneOf":[{"type":"string","description":"Website URL","uniqueKey":"website_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Website URL","uniqueKey":"website_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"website_url","typeLabel":"string | null"},"page_id":{"oneOf":[{"type":"string","description":"Facebook Page ID associated with the inbox","uniqueKey":"page_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Facebook Page ID associated with the inbox","uniqueKey":"page_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"page_id","typeLabel":"string | null"},"instagram_id":{"oneOf":[{"type":"string","description":"Instagram account ID associated with the inbox","uniqueKey":"instagram_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Instagram account ID associated with the inbox","uniqueKey":"instagram_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"instagram_id","typeLabel":"string | null"},"business_id":{"oneOf":[{"type":"string","description":"TikTok business ID associated with the inbox","uniqueKey":"business_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"TikTok business ID associated with the inbox","uniqueKey":"business_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_id","typeLabel":"string | null"},"provider_name":{"oneOf":[{"type":"string","description":"Provider username or page name associated with the social inbox","uniqueKey":"provider_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Provider username or page name associated with the social inbox","uniqueKey":"provider_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_name","typeLabel":"string | null"},"profile_id":{"oneOf":[{"type":"string","description":"X profile ID associated with the inbox","uniqueKey":"profile_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"X profile ID associated with the inbox","uniqueKey":"profile_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile_id","typeLabel":"string | null"},"line_channel_id":{"oneOf":[{"type":"string","description":"LINE channel ID associated with the inbox","uniqueKey":"line_channel_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"LINE channel ID associated with the inbox","uniqueKey":"line_channel_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"line_channel_id","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"Email address associated with the inbox","uniqueKey":"email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email address associated with the inbox","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string | null"},"bot_name":{"oneOf":[{"type":"string","description":"Telegram bot name associated with the inbox","uniqueKey":"bot_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Telegram bot name associated with the inbox","uniqueKey":"bot_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"bot_name","typeLabel":"string | null"},"inbox_identifier":{"oneOf":[{"type":"string","description":"Public identifier associated with an API inbox","uniqueKey":"inbox_identifier.oneOf.0","typeLabel":"string"},{"type":"null","description":"Public identifier associated with an API inbox","uniqueKey":"inbox_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"inbox_identifier","typeLabel":"string | null"},"channel_type":{"type":"string","description":"The type of the inbox","uniqueKey":"channel_type","typeLabel":"string"},"avatar_url":{"type":"string","description":"The avatar image of the inbox","uniqueKey":"avatar_url","typeLabel":"string"},"widget_color":{"oneOf":[{"type":"string","description":"Widget Color used for customization of the widget","uniqueKey":"widget_color.oneOf.0","typeLabel":"string"},{"type":"null","description":"Widget Color used for customization of the widget","uniqueKey":"widget_color.oneOf.1","typeLabel":"null"}],"uniqueKey":"widget_color","typeLabel":"string | null"},"website_token":{"oneOf":[{"type":"string","description":"Website Token","uniqueKey":"website_token.oneOf.0","typeLabel":"string"},{"type":"null","description":"Website Token","uniqueKey":"website_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"website_token","typeLabel":"string | null"},"enable_auto_assignment":{"type":"boolean","description":"The flag which shows whether Auto Assignment is enabled or not","uniqueKey":"enable_auto_assignment","typeLabel":"boolean"},"web_widget_script":{"oneOf":[{"type":"string","description":"Script used to load the website widget","uniqueKey":"web_widget_script.oneOf.0","typeLabel":"string"},{"type":"null","description":"Script used to load the website widget","uniqueKey":"web_widget_script.oneOf.1","typeLabel":"null"}],"uniqueKey":"web_widget_script","typeLabel":"string | null"},"welcome_title":{"oneOf":[{"type":"string","description":"Welcome title to be displayed on the widget","uniqueKey":"welcome_title.oneOf.0","typeLabel":"string"},{"type":"null","description":"Welcome title to be displayed on the widget","uniqueKey":"welcome_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"welcome_title","typeLabel":"string | null"},"welcome_tagline":{"oneOf":[{"type":"string","description":"Welcome tagline to be displayed on the widget","uniqueKey":"welcome_tagline.oneOf.0","typeLabel":"string"},{"type":"null","description":"Welcome tagline to be displayed on the widget","uniqueKey":"welcome_tagline.oneOf.1","typeLabel":"null"}],"uniqueKey":"welcome_tagline","typeLabel":"string | null"},"greeting_enabled":{"type":"boolean","description":"The flag which shows whether greeting is enabled","uniqueKey":"greeting_enabled","typeLabel":"boolean"},"greeting_message":{"oneOf":[{"type":"string","description":"A greeting message when the user starts the conversation","uniqueKey":"greeting_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A greeting message when the user starts the conversation","uniqueKey":"greeting_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"greeting_message","typeLabel":"string | null"},"channel_id":{"type":"number","description":"ID of the channel this inbox belongs to","uniqueKey":"channel_id","typeLabel":"number"},"working_hours_enabled":{"type":"boolean","description":"The flag which shows whether working hours feature is enabled","uniqueKey":"working_hours_enabled","typeLabel":"boolean"},"enable_email_collect":{"type":"boolean","description":"The flag to enable collecting email from contacts","uniqueKey":"enable_email_collect","typeLabel":"boolean"},"csat_survey_enabled":{"type":"boolean","description":"The flag to enable CSAT survey","uniqueKey":"csat_survey_enabled","typeLabel":"boolean"},"auto_assignment_config":{"type":"object","description":"Configuration settings for auto assignment","uniqueKey":"auto_assignment_config","typeLabel":"object"},"out_of_office_message":{"oneOf":[{"type":"string","description":"Message to show when agents are out of office","uniqueKey":"out_of_office_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Message to show when agents are out of office","uniqueKey":"out_of_office_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"out_of_office_message","typeLabel":"string | null"},"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)","uniqueKey":"working_hours.items.[INDEX].day_of_week","typeLabel":"number"},"closed_all_day":{"type":"boolean","description":"Whether the inbox is closed for the entire day","uniqueKey":"working_hours.items.[INDEX].closed_all_day","typeLabel":"boolean"},"open_hour":{"oneOf":[{"type":"number","description":"Hour when inbox opens (0-23)","uniqueKey":"working_hours.items.[INDEX].open_hour.oneOf.0","typeLabel":"number"},{"type":"null","description":"Hour when inbox opens (0-23)","uniqueKey":"working_hours.items.[INDEX].open_hour.oneOf.1","typeLabel":"null"}],"uniqueKey":"working_hours.items.[INDEX].open_hour","typeLabel":"number | null"},"open_minutes":{"oneOf":[{"type":"number","description":"Minutes of the hour when inbox opens (0-59)","uniqueKey":"working_hours.items.[INDEX].open_minutes.oneOf.0","typeLabel":"number"},{"type":"null","description":"Minutes of the hour when inbox opens (0-59)","uniqueKey":"working_hours.items.[INDEX].open_minutes.oneOf.1","typeLabel":"null"}],"uniqueKey":"working_hours.items.[INDEX].open_minutes","typeLabel":"number | null"},"close_hour":{"oneOf":[{"type":"number","description":"Hour when inbox closes (0-23)","uniqueKey":"working_hours.items.[INDEX].close_hour.oneOf.0","typeLabel":"number"},{"type":"null","description":"Hour when inbox closes (0-23)","uniqueKey":"working_hours.items.[INDEX].close_hour.oneOf.1","typeLabel":"null"}],"uniqueKey":"working_hours.items.[INDEX].close_hour","typeLabel":"number | null"},"close_minutes":{"oneOf":[{"type":"number","description":"Minutes of the hour when inbox closes (0-59)","uniqueKey":"working_hours.items.[INDEX].close_minutes.oneOf.0","typeLabel":"number"},{"type":"null","description":"Minutes of the hour when inbox closes (0-59)","uniqueKey":"working_hours.items.[INDEX].close_minutes.oneOf.1","typeLabel":"null"}],"uniqueKey":"working_hours.items.[INDEX].close_minutes","typeLabel":"number | null"},"open_all_day":{"type":"boolean","description":"Whether the inbox is open for the entire day","uniqueKey":"working_hours.items.[INDEX].open_all_day","typeLabel":"boolean"}},"uniqueKey":"working_hours.items.[INDEX]","typeLabel":"object"},"uniqueKey":"working_hours","typeLabel":"object[]"},"timezone":{"type":"string","description":"Timezone configuration for the inbox","uniqueKey":"timezone","typeLabel":"string"},"callback_webhook_url":{"oneOf":[{"type":"string","description":"Webhook URL for callbacks","uniqueKey":"callback_webhook_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Webhook URL for callbacks","uniqueKey":"callback_webhook_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"callback_webhook_url","typeLabel":"string | null"},"allow_messages_after_resolved":{"type":"boolean","description":"Whether to allow messages after a conversation is resolved","uniqueKey":"allow_messages_after_resolved","typeLabel":"boolean"},"lock_to_single_conversation":{"type":"boolean","description":"Whether to lock a contact to a single conversation","uniqueKey":"lock_to_single_conversation","typeLabel":"boolean"},"sender_name_type":{"type":"string","description":"Type of sender name to display (e.g., friendly)","uniqueKey":"sender_name_type","typeLabel":"string"},"business_name":{"oneOf":[{"type":"string","description":"Business name associated with the inbox","uniqueKey":"business_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Business name associated with the inbox","uniqueKey":"business_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_name","typeLabel":"string | null"},"branded_email_layout":{"oneOf":[{"type":"string","description":"Liquid HTML layout for branded email replies. Available to administrators for Email inbox show/update responses.","uniqueKey":"branded_email_layout.oneOf.0","typeLabel":"string"},{"type":"null","description":"Liquid HTML layout for branded email replies. Available to administrators for Email inbox show/update responses.","uniqueKey":"branded_email_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"branded_email_layout","typeLabel":"string | null"},"hmac_mandatory":{"oneOf":[{"type":"boolean","description":"Whether HMAC verification is mandatory","uniqueKey":"hmac_mandatory.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether HMAC verification is mandatory","uniqueKey":"hmac_mandatory.oneOf.1","typeLabel":"null"}],"uniqueKey":"hmac_mandatory","typeLabel":"boolean | null"},"selected_feature_flags":{"oneOf":[{"type":"array","description":"Selected feature flags for the inbox","items":{"type":"string","uniqueKey":"selected_feature_flags.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"selected_feature_flags.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Selected feature flags for the inbox","items":{"type":"string"},"uniqueKey":"selected_feature_flags.oneOf.1","typeLabel":"null"}],"uniqueKey":"selected_feature_flags","typeLabel":"string[] | null"},"reply_time":{"oneOf":[{"type":"string","description":"Expected reply time","uniqueKey":"reply_time.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expected reply time","uniqueKey":"reply_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"reply_time","typeLabel":"string | null"},"messaging_service_sid":{"oneOf":[{"type":"string","description":"Messaging service SID for SMS providers","uniqueKey":"messaging_service_sid.oneOf.0","typeLabel":"string"},{"type":"null","description":"Messaging service SID for SMS providers","uniqueKey":"messaging_service_sid.oneOf.1","typeLabel":"null"}],"uniqueKey":"messaging_service_sid","typeLabel":"string | null"},"phone_number":{"oneOf":[{"type":"string","description":"Phone number associated with the inbox","uniqueKey":"phone_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone number associated with the inbox","uniqueKey":"phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone_number","typeLabel":"string | null"},"medium":{"type":"string","description":"Medium of communication (e.g., sms, email)","uniqueKey":"medium","typeLabel":"string"},"provider":{"oneOf":[{"type":"string","description":"Provider of the channel","uniqueKey":"provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Provider of the channel","uniqueKey":"provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":123,"name":"\u003cstring>","website_url":"\u003cstring>","page_id":"\u003cstring>","instagram_id":"\u003cstring>","business_id":"\u003cstring>","provider_name":"\u003cstring>","profile_id":"\u003cstring>","line_channel_id":"\u003cstring>","email":"\u003cstring>","bot_name":"\u003cstring>","inbox_identifier":"\u003cstring>","channel_type":"\u003cstring>","avatar_url":"\u003cstring>","widget_color":"\u003cstring>","website_token":"\u003cstring>","enable_auto_assignment":true,"web_widget_script":"\u003cstring>","welcome_title":"\u003cstring>","welcome_tagline":"\u003cstring>","greeting_enabled":true,"greeting_message":"\u003cstring>","channel_id":123,"working_hours_enabled":true,"enable_email_collect":true,"csat_survey_enabled":true,"auto_assignment_config":{},"out_of_office_message":"\u003cstring>","working_hours":[{"day_of_week":123,"closed_all_day":true,"open_hour":123,"open_minutes":123,"close_hour":123,"close_minutes":123,"open_all_day":true}],"timezone":"\u003cstring>","callback_webhook_url":"\u003cstring>","allow_messages_after_resolved":true,"lock_to_single_conversation":true,"sender_name_type":"\u003cstring>","business_name":"\u003cstring>","branded_email_layout":"\u003cstring>","hmac_mandatory":true,"selected_feature_flags":["\u003cstring>"],"reply_time":"\u003cstring>","messaging_service_sid":"\u003cstring>","phone_number":"\u003cstring>","medium":"\u003cstring>","provider":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"cc951e67-d238-4cc2-bfe2-9395130a9958":{"description":"Access denied","content":{"application/json":{"schema":{"title":"data","type":"object","properties":{"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"data · object"},"examples":{"Example":{"title":"Example","value":{"description":"\u003cstring>","errors":[{"field":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"c2e2e22b-64c3-4944-afd5-06845ae5dcd9":{"description":"Inbox not found","content":{"application/json":{"schema":{"title":"data","type":"object","properties":{"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"data · object"},"examples":{"Example":{"title":"Example","value":{"description":"\u003cstring>","errors":[{"field":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f2602884-0f5d-4331-b424-b894a8452325":{"userBearerAuth":{"type":"http","scheme":"bearer","description":"Authenticate with `Authorization: Bearer \u003ctoken>` using a user API token from **Profile Settings**.","scopes":[],"schemeName":"userBearerAuth"}},"53612f18-1b54-4f79-8246-ea1fcf0c7481":{"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.","scopes":[],"schemeName":"userApiKey"}}},"servers":{"3aee7a20-f52f-42b4-bfc3-0b66705cdd66":{"url":"https://chat.chatclean.com.br"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Authenticate with `Authorization: Bearer \u003ctoken>` using a user API token from **Profile Settings**.","scopes":[],"schemeName":"userBearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Authenticate with `Authorization: Bearer \u003ctoken>` using a user API token from **Profile Settings**.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"userBearerAuth","name":"Authorization"}],"title":"userBearerAuth"},{"schemes":[{"scheme":{"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.","scopes":[],"schemeName":"userApiKey"},"schema":{"title":"api_access_token","type":"string","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.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"userApiKey","name":"api_access_token"}],"title":"userApiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"chatclean","siteName":"ChatClean Docs","title":"Update Inbox - ChatClean Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T14:47:10.271Z","originalFileLocation":"api-reference/inboxes/update-inbox.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Update an existing inbox\">\u003cmeta data-mint-head name=\"application-name\" content=\"ChatClean Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/chatclean/F026zPgEQG54LQ_i/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/chatclean/F026zPgEQG54LQ_i/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/chatclean/F026zPgEQG54LQ_i/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/chatclean/F026zPgEQG54LQ_i/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/chatclean/F026zPgEQG54LQ_i/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/chatclean/F026zPgEQG54LQ_i/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/chatclean/F026zPgEQG54LQ_i/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/chatclean/F026zPgEQG54LQ_i/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/chatclean/F026zPgEQG54LQ_i/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Inbox - ChatClean Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update an existing inbox\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ChatClean Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.chatclean.com.br/api-reference/inboxes/update-inbox\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://chatclean.mintlify.site/_mintlify/api/og/v2?division=Inboxes\u0026amp;title=Update+Inbox\u0026amp;description=Update+an+existing+inbox\u0026amp;theme=cb9da6e5e9f7a8480ce80e47\u0026amp;signature=dbf4a2cdd2e49cc6e2238c5ec27f85046d0d3622bb5cdf9a0ebcba5f764aa543\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update Inbox - ChatClean Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update an existing inbox\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://chatclean.mintlify.site/_mintlify/api/og/v2?division=Inboxes\u0026amp;title=Update+Inbox\u0026amp;description=Update+an+existing+inbox\u0026amp;theme=cb9da6e5e9f7a8480ce80e47\u0026amp;signature=dbf4a2cdd2e49cc6e2238c5ec27f85046d0d3622bb5cdf9a0ebcba5f764aa543\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/chatclean/F026zPgEQG54LQ_i/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ChatClean Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#007a2a\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.chatclean.com.br/api-reference/inboxes/update-inbox\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/inboxes/update-inbox.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.chatclean.com.br/#organization\",\"name\":\"ChatClean Docs\",\"url\":\"https://docs.chatclean.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/chatclean/pm82rvBlHsXfnPWu/logo/light.png?fit=max\u0026auto=format\u0026n=pm82rvBlHsXfnPWu\u0026q=85\u0026s=edcaa9d2c42c176e3bceaae6644055a2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.chatclean.com.br#website\",\"name\":\"ChatClean Docs\",\"url\":\"https://docs.chatclean.com.br\",\"publisher\":{\"@id\":\"https://docs.chatclean.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.chatclean.com.br/api-reference/inboxes/update-inbox#webpage\",\"url\":\"https://docs.chatclean.com.br/api-reference/inboxes/update-inbox\",\"name\":\"Update Inbox\",\"description\":\"Update an existing inbox\",\"dateModified\":\"2026-11-17T14:47:10.271Z\",\"isPartOf\":{\"@id\":\"https://docs.chatclean.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://docs.chatclean.com.br/api-reference/inboxes/update-inbox#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.chatclean.com.br/api-reference/inboxes/update-inbox#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API da aplicação\",\"item\":\"https://docs.chatclean.com.br/api-reference/contacts-api/create-a-contact\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Inboxes\",\"item\":\"https://docs.chatclean.com.br/api-reference/inboxes/get-account-branded-email-layout\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update Inbox\",\"item\":\"https://docs.chatclean.com.br/api-reference/inboxes/update-inbox\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.chatclean.com.br/api-reference/inboxes/update-inbox#apireference\",\"headline\":\"Update Inbox\",\"name\":\"Update Inbox\",\"description\":\"Update an existing inbox\",\"url\":\"https://docs.chatclean.com.br/api-reference/inboxes/update-inbox\",\"mainEntityOfPage\":{\"@id\":\"https://docs.chatclean.com.br/api-reference/inboxes/update-inbox#webpage\"},\"dateModified\":\"2026-11-17T14:47:10.271Z\",\"publisher\":{\"@id\":\"https://docs.chatclean.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.chatclean.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ChatClean Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ChatClean Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/inboxes/update-inbox.md","siteName":"ChatClean Docs","nav":{"global":null,"tabs":[{"tab":"Documentação","icon":"book-open","pages":[{"title":"Documentação","href":""}]},{"tab":"Referência da API","icon":"code","groups":[{"group":"Visão geral","pages":[{"title":"Introdução","icon":"book-open","href":"/api-reference/introduction"},{"title":"Enviar mensagens","icon":"paper-plane","href":"/api-reference/guides/enviar-mensagens"},{"title":"Webhooks","icon":"webhook","href":"/api-reference/guides/webhooks"}]},{"group":"API da aplicação","pages":[{"group":"Contacts API","pages":[{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /public/api/v1/inboxes/{inbox_identifier}/contacts","href":"/api-reference/contacts-api/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi.json get /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}","href":"/api-reference/contacts-api/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.json patch /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}","href":"/api-reference/contacts-api/update-a-contact"}]},{"group":"Conversations API","pages":[{"title":"List all conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations","href":"/api-reference/conversations-api/list-all-conversations"},{"title":"Create a conversation","deprecated":null,"version":null,"openapi":"/openapi.json post /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations","href":"/api-reference/conversations-api/create-a-conversation"},{"title":"Get a single conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}","href":"/api-reference/conversations-api/get-a-single-conversation"},{"title":"Resolve a conversation","deprecated":null,"version":null,"openapi":"/openapi.json post /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_status","href":"/api-reference/conversations-api/resolve-a-conversation"},{"title":"Toggle typing status","deprecated":null,"version":null,"openapi":"/openapi.json post /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_typing","href":"/api-reference/conversations-api/toggle-typing-status"},{"title":"Update last seen and mark messages read","deprecated":null,"version":null,"openapi":"/openapi.json post /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/update_last_seen","href":"/api-reference/conversations-api/update-last-seen-and-mark-messages-read"}]},{"group":"Messages API","pages":[{"title":"List all messages","deprecated":null,"version":null,"openapi":"/openapi.json get /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages","href":"/api-reference/messages-api/list-all-messages"},{"title":"Create a message","deprecated":null,"version":null,"openapi":"/openapi.json post /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages","href":"/api-reference/messages-api/create-a-message"},{"title":"Update a message","deprecated":null,"version":null,"openapi":"/openapi.json patch /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages/{message_id}","href":"/api-reference/messages-api/update-a-message"}]},{"group":"Account","pages":[{"title":"Get account details","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}","href":"/api-reference/account/get-account-details"},{"title":"Update account","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}","href":"/api-reference/account/update-account"}]},{"group":"Account AgentBots","pages":[{"title":"List all AgentBots","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/agent_bots","href":"/api-reference/account-agentbots/list-all-agentbots"},{"title":"Create an Agent Bot","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/agent_bots","href":"/api-reference/account-agentbots/create-an-agent-bot"},{"title":"Get an agent bot details","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/agent_bots/{id}","href":"/api-reference/account-agentbots/get-an-agent-bot-details"},{"title":"Delete an AgentBot","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/accounts/{account_id}/agent_bots/{id}","href":"/api-reference/account-agentbots/delete-an-agentbot"},{"title":"Update an agent bot","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/agent_bots/{id}","href":"/api-reference/account-agentbots/update-an-agent-bot"}]},{"group":"Agents","pages":[{"title":"List Agents in Account","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/agents","href":"/api-reference/agents/list-agents-in-account"},{"title":"Add a New Agent","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/agents","href":"/api-reference/agents/add-a-new-agent"},{"title":"Remove an Agent from Account","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/accounts/{account_id}/agents/{id}","href":"/api-reference/agents/remove-an-agent-from-account"},{"title":"Update Agent in Account","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/agents/{id}","href":"/api-reference/agents/update-agent-in-account"}]},{"group":"Canned Responses","pages":[{"title":"List all Canned Responses in an Account","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/canned_responses","href":"/api-reference/canned-responses/list-all-canned-responses-in-an-account"},{"title":"Add a New Canned Response","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/canned_responses","href":"/api-reference/canned-responses/add-a-new-canned-response"},{"title":"Remove a Canned Response from Account","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/accounts/{account_id}/canned_responses/{id}","href":"/api-reference/canned-responses/remove-a-canned-response-from-account"},{"title":"Update Canned Response in Account","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/canned_responses/{id}","href":"/api-reference/canned-responses/update-canned-response-in-account"}]},{"group":"Custom Attributes","pages":[{"title":"List all custom attributes in an account","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/custom_attribute_definitions","href":"/api-reference/custom-attributes/list-all-custom-attributes-in-an-account"},{"title":"Add a new custom attribute","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/custom_attribute_definitions","href":"/api-reference/custom-attributes/add-a-new-custom-attribute"},{"title":"Get a custom attribute details","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/custom_attribute_definitions/{id}","href":"/api-reference/custom-attributes/get-a-custom-attribute-details"},{"title":"Remove a custom attribute from account","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/accounts/{account_id}/custom_attribute_definitions/{id}","href":"/api-reference/custom-attributes/remove-a-custom-attribute-from-account"},{"title":"Update custom attribute in Account","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/custom_attribute_definitions/{id}","href":"/api-reference/custom-attributes/update-custom-attribute-in-account"}]},{"group":"Contacts","pages":[{"title":"List Contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create Contact","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/contacts","href":"/api-reference/contacts/create-contact"},{"title":"Show Contact","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/contacts/{id}","href":"/api-reference/contacts/show-contact"},{"title":"Update Contact","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/accounts/{account_id}/contacts/{id}","href":"/api-reference/contacts/update-contact"},{"title":"Delete Contact","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/accounts/{account_id}/contacts/{id}","href":"/api-reference/contacts/delete-contact"},{"title":"Contact Conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/contacts/{id}/conversations","href":"/api-reference/contacts/contact-conversations"},{"title":"Search Contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/contacts/search","href":"/api-reference/contacts/search-contacts"},{"title":"Contact Filter","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/contacts/filter","href":"/api-reference/contacts/contact-filter"},{"title":"Create contact inbox","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes","href":"/api-reference/contacts/create-contact-inbox"},{"title":"Get Contactable Inboxes","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxes","href":"/api-reference/contacts/get-contactable-inboxes"},{"title":"Merge Contacts","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/actions/contact_merge","href":"/api-reference/contacts/merge-contacts"}]},{"group":"Contact Labels","pages":[{"title":"List Labels","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/contacts/{id}/labels","href":"/api-reference/contact-labels/list-labels"},{"title":"Add Labels","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/contacts/{id}/labels","href":"/api-reference/contact-labels/add-labels"}]},{"group":"Automation Rule","pages":[{"title":"List all automation rules in an account","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/automation_rules","href":"/api-reference/automation-rule/list-all-automation-rules-in-an-account"},{"title":"Add a new automation rule","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/automation_rules","href":"/api-reference/automation-rule/add-a-new-automation-rule"},{"title":"Get a automation rule details","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/automation_rules/{id}","href":"/api-reference/automation-rule/get-a-automation-rule-details"},{"title":"Remove a automation rule from account","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/accounts/{account_id}/automation_rules/{id}","href":"/api-reference/automation-rule/remove-a-automation-rule-from-account"},{"title":"Update automation rule in Account","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/automation_rules/{id}","href":"/api-reference/automation-rule/update-automation-rule-in-account"}]},{"group":"Help Center","pages":[{"title":"List all portals in an account","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/portals","href":"/api-reference/help-center/list-all-portals-in-an-account"},{"title":"Add a new portal","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/portals","href":"/api-reference/help-center/add-a-new-portal"},{"title":"Get a portal details","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/portals/{portal_slug}","href":"/api-reference/help-center/get-a-portal-details"},{"title":"Update a portal","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/portals/{portal_slug}","href":"/api-reference/help-center/update-a-portal"},{"title":"Add a new category","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/portals/{portal_slug}/categories","href":"/api-reference/help-center/add-a-new-category"},{"title":"Add a new article","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/portals/{portal_slug}/articles","href":"/api-reference/help-center/add-a-new-article"}]},{"group":"Conversations","pages":[{"title":"Get Conversation Counts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/conversations/meta","href":"/api-reference/conversations/get-conversation-counts"},{"title":"Conversations List","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/conversations","href":"/api-reference/conversations/conversations-list"},{"title":"Create New Conversation","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/conversations","href":"/api-reference/conversations/create-new-conversation"},{"title":"Conversations Filter","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/conversations/filter","href":"/api-reference/conversations/conversations-filter"},{"title":"Conversation Details","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/conversations/{conversation_id}","href":"/api-reference/conversations/conversation-details"},{"title":"Update Conversation","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/conversations/{conversation_id}","href":"/api-reference/conversations/update-conversation"},{"title":"Toggle Status","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_status","href":"/api-reference/conversations/toggle-status"},{"title":"Toggle Priority","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_priority","href":"/api-reference/conversations/toggle-priority"},{"title":"Toggle Typing Status","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_typing_status","href":"/api-reference/conversations/toggle-typing-status"},{"title":"Update Last Seen","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/conversations/{conversation_id}/update_last_seen","href":"/api-reference/conversations/update-last-seen"},{"title":"Update Custom Attributes","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/conversations/{conversation_id}/custom_attributes","href":"/api-reference/conversations/update-custom-attributes"},{"title":"Destroy Custom Attributes","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/conversations/{conversation_id}/destroy_custom_attributes","href":"/api-reference/conversations/destroy-custom-attributes"},{"title":"List Labels","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/conversations/{conversation_id}/labels","href":"/api-reference/conversations/list-labels"},{"title":"Add Labels","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/conversations/{conversation_id}/labels","href":"/api-reference/conversations/add-labels"},{"title":"Conversation Reporting Events","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/conversations/{conversation_id}/reporting_events","href":"/api-reference/conversations/conversation-reporting-events"}]},{"group":"Conversation Assignments","pages":[{"title":"Assign Conversation","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments","href":"/api-reference/conversation-assignments/assign-conversation"}]},{"group":"Inboxes","pages":[{"title":"Get account branded email layout","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/branded_email_layout","href":"/api-reference/inboxes/get-account-branded-email-layout"},{"title":"Update account branded email layout","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/branded_email_layout","href":"/api-reference/inboxes/update-account-branded-email-layout"},{"title":"List all inboxes","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/inboxes","href":"/api-reference/inboxes/list-all-inboxes"},{"title":"Create an inbox","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/inboxes","href":"/api-reference/inboxes/create-an-inbox"},{"title":"Get an inbox","description":"Get an inbox available in the current account","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/inboxes/{id}","href":"/api-reference/inboxes/get-an-inbox"},{"title":"Update Inbox","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/inboxes/{id}","href":"/api-reference/inboxes/update-inbox"},{"title":"List WhatsApp message templates","description":"List the cached message templates available for a native or Twilio WhatsApp inbox","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/inboxes/{id}/message_templates","href":"/api-reference/inboxes/list-whatsapp-message-templates"},{"title":"Show Inbox Agent Bot","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/inboxes/{id}/agent_bot","href":"/api-reference/inboxes/show-inbox-agent-bot"},{"title":"Add or remove agent bot","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/inboxes/{id}/set_agent_bot","href":"/api-reference/inboxes/add-or-remove-agent-bot"},{"title":"List Agents in Inbox","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/inbox_members/{inbox_id}","href":"/api-reference/inboxes/list-agents-in-inbox"},{"title":"Add a New Agent","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/inbox_members","href":"/api-reference/inboxes/add-a-new-agent"},{"title":"Remove an Agent from Inbox","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/accounts/{account_id}/inbox_members","href":"/api-reference/inboxes/remove-an-agent-from-inbox"},{"title":"Update Agents in Inbox","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/inbox_members","href":"/api-reference/inboxes/update-agents-in-inbox"}]},{"group":"Labels","pages":[{"title":"List all labels","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/labels","href":"/api-reference/labels/list-all-labels"},{"title":"Create a label","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/labels","href":"/api-reference/labels/create-a-label"},{"title":"Get a label","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/labels/{id}","href":"/api-reference/labels/get-a-label"},{"title":"Delete a label","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/accounts/{account_id}/labels/{id}","href":"/api-reference/labels/delete-a-label"},{"title":"Update a label","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/labels/{id}","href":"/api-reference/labels/update-a-label"}]},{"group":"Messages","pages":[{"title":"Get messages","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/conversations/{conversation_id}/messages","href":"/api-reference/messages/get-messages"},{"title":"Create New Message","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/conversations/{conversation_id}/messages","href":"/api-reference/messages/create-new-message"},{"title":"Delete a message","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}","href":"/api-reference/messages/delete-a-message"},{"title":"Update message status","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}","href":"/api-reference/messages/update-message-status"}]},{"group":"Integrations","pages":[{"title":"List all the Integrations","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/integrations/apps","href":"/api-reference/integrations/list-all-the-integrations"},{"title":"Create an integration hook","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/integrations/hooks","href":"/api-reference/integrations/create-an-integration-hook"},{"title":"Delete an Integration Hook","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/accounts/{account_id}/integrations/hooks/{hook_id}","href":"/api-reference/integrations/delete-an-integration-hook"},{"title":"Update an Integration Hook","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/integrations/hooks/{hook_id}","href":"/api-reference/integrations/update-an-integration-hook"}]},{"group":"Profile","pages":[{"title":"Fetch user profile","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/profile","href":"/api-reference/profile/fetch-user-profile"},{"title":"Update user profile","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/profile","href":"/api-reference/profile/update-user-profile"}]},{"group":"Teams","pages":[{"title":"List all teams","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/teams","href":"/api-reference/teams/list-all-teams"},{"title":"Create a team","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/teams","href":"/api-reference/teams/create-a-team"},{"title":"Get a team details","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/teams/{team_id}","href":"/api-reference/teams/get-a-team-details"},{"title":"Delete a team","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/accounts/{account_id}/teams/{team_id}","href":"/api-reference/teams/delete-a-team"},{"title":"Update a team","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/teams/{team_id}","href":"/api-reference/teams/update-a-team"},{"title":"List Agents in Team","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/teams/{team_id}/team_members","href":"/api-reference/teams/list-agents-in-team"},{"title":"Add a New Agent","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/teams/{team_id}/team_members","href":"/api-reference/teams/add-a-new-agent"},{"title":"Remove an Agent from Team","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/accounts/{account_id}/teams/{team_id}/team_members","href":"/api-reference/teams/remove-an-agent-from-team"},{"title":"Update Agents in Team","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/teams/{team_id}/team_members","href":"/api-reference/teams/update-agents-in-team"}]},{"group":"Custom Filters","pages":[{"title":"List all custom filters","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/custom_filters","href":"/api-reference/custom-filters/list-all-custom-filters"},{"title":"Create a custom filter","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/custom_filters","href":"/api-reference/custom-filters/create-a-custom-filter"},{"title":"Get a custom filter details","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}","href":"/api-reference/custom-filters/get-a-custom-filter-details"},{"title":"Delete a custom filter","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}","href":"/api-reference/custom-filters/delete-a-custom-filter"},{"title":"Update a custom filter","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}","href":"/api-reference/custom-filters/update-a-custom-filter"}]},{"group":"Webhooks","pages":[{"title":"List all webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/webhooks","href":"/api-reference/webhooks/list-all-webhooks"},{"title":"Add a webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/webhooks","href":"/api-reference/webhooks/add-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/accounts/{account_id}/webhooks/{webhook_id}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"Update a webhook object","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/webhooks/{webhook_id}","href":"/api-reference/webhooks/update-a-webhook-object"}]},{"group":"Reports","pages":[{"title":"Account Reporting Events","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/reporting_events","href":"/api-reference/reports/account-reporting-events"},{"title":"Get Account reports","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/accounts/{account_id}/reports","href":"/api-reference/reports/get-account-reports"},{"title":"Get Account reports summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/accounts/{account_id}/reports/summary","href":"/api-reference/reports/get-account-reports-summary"},{"title":"Account Conversation Metrics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/accounts/{account_id}/reports/conversations","href":"/api-reference/reports/account-conversation-metrics"},{"title":"Agent Conversation Metrics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/accounts/{account_id}/reports/conversations/","href":"/api-reference/reports/agent-conversation-metrics"},{"title":"Get conversation statistics grouped by channel type","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/accounts/{account_id}/summary_reports/channel","href":"/api-reference/reports/get-conversation-statistics-grouped-by-channel-type"},{"title":"Get conversation statistics grouped by inbox","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/accounts/{account_id}/summary_reports/inbox","href":"/api-reference/reports/get-conversation-statistics-grouped-by-inbox"},{"title":"Get conversation statistics grouped by agent","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/accounts/{account_id}/summary_reports/agent","href":"/api-reference/reports/get-conversation-statistics-grouped-by-agent"},{"title":"Get conversation statistics grouped by team","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/accounts/{account_id}/summary_reports/team","href":"/api-reference/reports/get-conversation-statistics-grouped-by-team"},{"title":"Get first response time distribution by channel","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/accounts/{account_id}/reports/first_response_time_distribution","href":"/api-reference/reports/get-first-response-time-distribution-by-channel"},{"title":"Get inbox-label matrix report","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/accounts/{account_id}/reports/inbox_label_matrix","href":"/api-reference/reports/get-inbox-label-matrix-report"},{"title":"Get outgoing messages count grouped by entity","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/accounts/{account_id}/reports/outgoing_messages_count","href":"/api-reference/reports/get-outgoing-messages-count-grouped-by-entity"}]},{"group":"Campaigns","pages":[{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/accounts/{account_id}/campaigns","href":"/api-reference/campaigns/create-a-campaign"},{"title":"Get a campaign","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts/{account_id}/campaigns/{id}","href":"/api-reference/campaigns/get-a-campaign"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/accounts/{account_id}/campaigns/{id}","href":"/api-reference/campaigns/delete-a-campaign"},{"title":"Update a campaign","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/accounts/{account_id}/campaigns/{id}","href":"/api-reference/campaigns/update-a-campaign"}]}]}]}]},"basePath":"","title":"Update Inbox - ChatClean Docs","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}