Coghub icon

Coghub

Interagir com a API do Coghub

Actions129

Inboxes → Inbox Creation

AI-generated

Summary

Create a new inbox for a specified account with customizable settings such as name, avatar, greeting message, working hours, and channel configuration.

Inputs

  • Account Id (required) — Numeric ID of the account to which the inbox will belong.
  • Name — Name of the inbox (default is 'Support').
  • Avatar — Image file URL or identifier to use as the avatar for the inbox.
  • Greeting Enabled — Boolean to enable or disable the greeting message on the widget.
  • Greeting Message — The greeting message text displayed on the widget.
  • Enable Email Collect — Boolean to enable collecting visitor emails.
  • Csat Survey Enabled — Boolean to enable customer satisfaction surveys.
  • Enable Auto Assignment — Boolean to enable automatic assignment of conversations.
  • Working Hours Enabled — Boolean to enable working hours restrictions.
  • Out Of Office Message — Message displayed when out of office.
  • Timezone — Timezone for the inbox, e.g., 'America/New_York'.
  • Allow Messages After Resolved — Boolean to allow messages after a conversation is marked resolved.
  • Lock To Single Conversation — Boolean to restrict to a single active conversation per user.
  • Portal Id — ID of the help center portal to attach to the inbox.
  • Sender Name Type — Type of sender name displayed (friendly or professional).
  • Business Name — Business name associated with the inbox.
  • Channel — JSON object defining the communication channel details such as type, website URL, welcome title and tagline, and widget color.

Output shape

a single record containing the created inbox's details

The response includes the created inbox object with all configured properties. Errors are returned if required inputs are missing or invalid.

Links

Discussion