Authorizations
This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
Path Parameters
The numeric ID of the account
ID of the inbox
Body
The name of the inbox
"Support"
Image file for avatar
Enable greeting message
true
Greeting message to be displayed on the widget
"Hello, how can I help you?"
Enable email collection
true
Enable CSAT survey
true
Enable Auto Assignment
true
Enable working hours
true
Out of office message to be displayed on the widget
"We are currently out of office. Please leave a message and we will get back to you."
Timezone of the inbox
"America/New_York"
Allow messages after conversation is resolved
true
Lock to single conversation
true
Id of the help center portal to attach to the inbox
1
Sender name type for the inbox
friendly
, professional
"friendly"
Business name for the inbox
"My Business"
Response
Success
ID of the inbox
The name of the inbox
Website URL
The type of the inbox
The avatar image of the inbox
Widget Color used for customization of the widget
Website Token
The flag which shows whether Auto Assignment is enabled or not
Script used to load the website widget
Welcome title to be displayed on the widget
Welcome tagline to be displayed on the widget
The flag which shows whether greeting is enabled
A greeting message when the user starts the conversation
ID of the channel this inbox belongs to
The flag which shows whether working hours feature is enabled
The flag to enable collecting email from contacts
The flag to enable CSAT survey
Configuration settings for auto assignment
Message to show when agents are out of office
Configuration for working hours of the inbox
Timezone configuration for the inbox
Webhook URL for callbacks
Whether to allow messages after a conversation is resolved
Whether to lock a contact to a single conversation
Type of sender name to display (e.g., friendly)
Business name associated with the inbox
Whether HMAC verification is mandatory
Selected feature flags for the inbox
Expected reply time
Messaging service SID for SMS providers
Phone number associated with the inbox
Medium of communication (e.g., sms, email)
Provider of the channel