Custom Inboxes

Create Inbox

Create a new inbox.

Required Scopes: inboxes:create (+ plan feature custom_inboxes)

post/api/v1/inboxes

Request

  • Base URL: https://api.sendseven.com
  • URL: https://api.sendseven.com/api/v1/inboxes
  • Auth: HTTP bearer

Request body

namestring required
descriptionstring nullable
iconstring nullable

Lucide icon name

colorstring nullable

#RRGGBB hex color

access_mode'all' | 'specific'

Who can use this mailbox

tag_filter_mode'any' | 'all' | 'none'

How CustomInboxTagFilter rows are combined when filtering conversations.

channel_idsstring[]

Non-email channel IDs that belong to this inbox. Email connections are listed separately under email_connections.

tag_idsstring[] nullable

Tag IDs used by the tag rule (interpreted via tag_filter_mode)

allowed_user_idsstring[] nullable

Whitelisted user IDs (only used when access_mode='specific')

all_channelsboolean

True = the inbox covers every channel and email connection of the workspace (channel_ids / email_connections are ignored). False = only the listed ones; with none listed the inbox shows nothing.

access_tag_idsstring[] nullable

Team-member tag IDs that grant access (only used when access_mode='specific'): members holding ANY of these tags see the conversations matching this inbox's full filter. Separate from tag_ids, which filter conversations.

is_activeboolean
sort_orderinteger

Response

Successful Response

idstring required
tenant_idstring required
namestring required
descriptionstring nullable
iconstring nullable
colorstring nullable
access_modestring required
tag_filter_modestring required
is_activeboolean required
sort_orderinteger required
channel_idsstring[]
tag_idsstring[]
allowed_user_idsstring[]
all_channelsboolean
access_tag_idsstring[]
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 3 revisions of this API.