MB SuiteMB Suite
Menu

API reference · Inbox

Settings

social_inbox · config · 2 operations

GET/v1/social-inbox/configPATCH/v1/social-inbox/config
GET/v1/social-inbox/config

Get the Social Inbox configuration

social_inbox.config.get

ReadIdempotentSince 2026-11-01

Returns the inbox configuration of the organization: sync_enabled (whether messages are being ingested; it is turned on from the screen) and enabled_at (since when), enabled_sources (source → false means that source is not ingested; absent means enabled), inbox_agent_uids (who can be assigned, what config.update calls agent_uids; absent means every member) with inbox_agents (those members with their names) and updated_at (0 when the configuration was never saved). Requires view access to the Social Inbox.

Scope
social_inbox:read
Permission
View the module
MCP tool
social_inbox_config_getOn the full surface; on the compact one, mb_execute_operation with id: "social_inbox.config.get".

Declared cost: up to 23 reads and 0 writes per call (they count against the daily quota).

Parameters

No parameters.

Response

sync_enabledboolean

Whether the inbox is on (it brings new comments and messages from the connected networks).

updated_atnumber

Last change (epoch ms); 0 = the configuration was never saved.

enabled_atnumber | null

When the inbox was turned on (epoch ms).

enabled_sourcesobject | null

Source → false = not brought in (ig_comment, tt_message…). Absent or missing key = brought in.

inbox_agent_uidsarray<string> | null

The members offered in the Assign menu (what config.update calls agent_uids). Absent = every member.

inbox_agentsarray<object>

Those members with their names (only the ones still in the organization).

Errors

invalid_inputunknown_fieldauthentication_requiredscope_insufficientmodule_access_deniedoperation_not_foundrate_limitedquota_exceeded

Example

curl "https://api.mb-suite.com/v1/social-inbox/config" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl "https://api.mb-suite.com/v1/social-inbox/config" \
  -H "Authorization: Bearer $MB_TEST_KEY"
PATCH/v1/social-inbox/config

Update the Social Inbox sources and team

social_inbox.config.update

WriteIdempotentSince 2026-11-01

Updates what the inbox ingests and who can be assigned. enabled_sources replaces the source map (source → false stops ingesting it from now on; existing items stay; sources: ig_comment, ig_message, ig_mention, fb_comment, fb_message, fb_mention, li_comment, li_message, li_mention, tt_comment, tt_message; unknown ones are dropped). agent_uids replaces the assignable team (members of the organization or its agency; others are dropped; an empty list means everyone). Send one or both. Returns the configuration and what was dropped (dropped.sources, dropped.agent_uids). Owner or admin only.

Scope
social_inbox:write
Permission
Edit in the module · Only owner, admin
MCP tool
social_inbox_config_updateOn the full surface; on the compact one, mb_execute_operation with id: "social_inbox.config.update".

Declared cost: up to 25 reads and 1 writes per call (they count against the daily quota).

Parameters

enabled_sourcesobjectbodyoptional

Source → false stops bringing it in (ig_comment, ig_message, ig_mention, fb_comment, fb_message, fb_mention, li_comment, li_mention, tt_comment, tt_message); a missing key = brought in. Replaces the whole map; unknown sources are dropped (dropped.sources in the reply).

agent_uidsarray<string>bodyoptional

The members offered in the Assign menu (user ids from members.members.list); [] = every member. Replaces the list; non-members are dropped (dropped.agent_uids in the reply).

Response

sync_enabledboolean

Whether the inbox is on (it brings new comments and messages from the connected networks).

updated_atnumber

Last change (epoch ms); 0 = the configuration was never saved.

droppedobject

What the call sent and was not saved.

enabled_atnumber | null

When the inbox was turned on (epoch ms).

enabled_sourcesobject | null

Source → false = not brought in (ig_comment, tt_message…). Absent or missing key = brought in.

inbox_agent_uidsarray<string> | null

The members offered in the Assign menu (what config.update calls agent_uids). Absent = every member.

inbox_agentsarray<object>

Those members with their names (only the ones still in the organization).

Errors

role_requiredinvalid_inputunknown_fieldauthentication_requiredscope_insufficientcrm_action_deniedidempotency_key_reusedrate_limitedquota_exceeded

Example

curl -X PATCH "https://api.mb-suite.com/v1/social-inbox/config" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X PATCH "https://api.mb-suite.com/v1/social-inbox/config" \
  -H "Authorization: Bearer $MB_TEST_KEY"