contactable_inboxes

source_idstring

Contact Inbox Source Id

inbox object

idnumber

ID of the inbox

namestring

The name of the inbox

website_urlstring

Website URL

channel_typestring

The type of the inbox

avatar_urlstring

The avatar image of the inbox

widget_colorstring

Widget Color used for customization of the widget

website_tokenstring

Website Token

enable_auto_assignmentboolean

The flag which shows whether Auto Assignment is enabled or not

web_widget_scriptstring

Script used to load the website widget

welcome_titlestring | nullnullable

Welcome title to be displayed on the widget

welcome_taglinestring | nullnullable

Welcome tagline to be displayed on the widget

greeting_enabledboolean

The flag which shows whether greeting is enabled

greeting_messagestring | nullnullable

A greeting message when the user starts the conversation

channel_idnumber

ID of the channel this inbox belongs to

working_hours_enabledboolean

The flag which shows whether working hours feature is enabled

enable_email_collectboolean

The flag to enable collecting email from contacts

csat_survey_enabledboolean

The flag to enable CSAT survey

auto_assignment_configobject

Configuration settings for auto assignment

out_of_office_messagestring | nullnullable

Message to show when agents are out of office

working_hours object[]

Configuration for working hours of the inbox

Array [

day_of_weeknumber

Day of the week (0-6, where 0 is Sunday)

closed_all_dayboolean

Whether the inbox is closed for the entire day

open_hournumber | nullnullable

Hour when inbox opens (0-23)

open_minutesnumber | nullnullable

Minutes of the hour when inbox opens (0-59)

close_hournumber | nullnullable

Hour when inbox closes (0-23)

close_minutesnumber | nullnullable

Minutes of the hour when inbox closes (0-59)

open_all_dayboolean

Whether the inbox is open for the entire day

]

timezonestring

Timezone configuration for the inbox

callback_webhook_urlstring | nullnullable

Webhook URL for callbacks

allow_messages_after_resolvedboolean

Whether to allow messages after a conversation is resolved

lock_to_single_conversationboolean

Whether to lock a contact to a single conversation

sender_name_typestring

Type of sender name to display (e.g., friendly)

business_namestring | nullnullable

Business name associated with the inbox

hmac_mandatoryboolean

Whether HMAC verification is mandatory

selected_feature_flagsstring[]nullable

Selected feature flags for the inbox

reply_timestring

Expected reply time

messaging_service_sidstring | nullnullable

Messaging service SID for SMS providers

phone_numberstring | nullnullable

Phone number associated with the inbox

mediumstring

Medium of communication (e.g., sms, email)

providerstring | nullnullable

Provider of the channel

contactable_inboxes

{
  "source_id": "string",
  "inbox": {
    "id": 0,
    "name": "string",
    "website_url": "string",
    "channel_type": "string",
    "avatar_url": "string",
    "widget_color": "string",
    "website_token": "string",
    "enable_auto_assignment": true,
    "web_widget_script": "string",
    "welcome_title": "string",
    "welcome_tagline": "string",
    "greeting_enabled": true,
    "greeting_message": "string",
    "channel_id": 0,
    "working_hours_enabled": true,
    "enable_email_collect": true,
    "csat_survey_enabled": true,
    "auto_assignment_config": {},
    "out_of_office_message": "string",
    "working_hours": [
      {
        "day_of_week": 0,
        "closed_all_day": true,
        "open_hour": 0,
        "open_minutes": 0,
        "close_hour": 0,
        "close_minutes": 0,
        "open_all_day": true
      }
    ],
    "timezone": "string",
    "callback_webhook_url": "string",
    "allow_messages_after_resolved": true,
    "lock_to_single_conversation": true,
    "sender_name_type": "string",
    "business_name": "string",
    "hmac_mandatory": true,
    "selected_feature_flags": "Unknown Type: array,null",
    "reply_time": "string",
    "messaging_service_sid": "string",
    "phone_number": "string",
    "medium": "string",
    "provider": "string"
  }
}