Mega icon

Mega

Work with Mega API

Inbox → Create

AI-generated

Summary

Create a new inbox with specified settings such as name, channel type, greeting message, and various configuration options.

Inputs

  • Name (required) — Specifies the name of the inbox to create.
  • Channel Type (required) — Selects the type of channel for the inbox (e.g., API, Email, SMS, Telegram, WhatsApp, etc.).
  • Channel Config — JSON object containing additional configuration details specific to the chosen channel type.
  • Greeting Enabled — Boolean to enable or disable displaying a greeting message on the widget.
  • Greeting Message — Text of the greeting message to be displayed if enabled.
  • Enable Email Collect — Boolean flag to enable collection of email addresses.
  • CSAT Survey Enabled — Boolean flag to enable a customer satisfaction survey.
  • Enable Auto Assignment — Boolean flag to enable automatic assignment of conversations.
  • Working Hours Enabled — Boolean to enable working hours for the inbox.
  • Out of Office Message — Message shown when out of office mode is active.
  • Timezone — Timezone setting for the inbox.
  • Allow Messages After Resolved — Boolean to allow messages after conversations are marked resolved.
  • Lock to Single Conversation — Boolean to lock the inbox to a single conversation at a time.
  • Portal ID — Numeric ID of the associated help center portal.
  • Sender Name Type — Style of sender name to display, either 'friendly' or 'professional'.
  • Business Name — Business name associated with the inbox.

Output shape

a single JSON object representing the created inbox including its properties

The operation returns the created inbox's data as a JSON object. Optional input fields have default values if omitted. Errors returned if required parameters are missing or invalid.

Links

Discussion