Menu

API reference · Inbox

Labels

social_inbox · labels · 4 operations

GET/v1/social-inbox/labels

List Social Inbox labels

social_inbox.labels.list

ReadIdempotentSince 2026-11-01

Lists the labels used to tag inbox items (name, hex color, order), in the order the inbox shows them (up to 200). Use their ids with social_inbox.items.set_labels, in rules (add_labels) and to filter social_inbox.items.list (label_id). Requires view access to the Social Inbox.

Scope
social_inbox:read
Permission
View the module
MCP tool
social_inbox_labels_listOn the full surface; on the compact one, mb_execute_operation with id: "social_inbox.labels.list".

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

Parameters

No parameters.

Response

dataarray<object>

Errors

Example

curl "https://api.mb-suite.com/v1/social-inbox/labels" \
  -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/labels" \
  -H "Authorization: Bearer $MB_TEST_KEY"
POST/v1/social-inbox/labels

Create a Social Inbox label

social_inbox.labels.create

WriteSince 2026-11-01

Creates an inbox label with a name (up to 80 characters) and a hex color (#rrggbb; default red), placed last in the order. An organization (workspace or account) has up to 200 (409 limit_reached, details.resource inbox_labels). Returns the label with its id. Requires full access and an owner, admin or member role.

Scope
social_inbox:write
Permission
Edit in the module
MCP tool
social_inbox_labels_createOn the full surface; on the compact one, mb_execute_operation with id: "social_inbox.labels.create".

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

Parameters

namestringbodyrequired

The label's name (1 to 80 characters).

colorstringbodyoptional

Its color, hex like #3b82f6. Default: the first color of the palette.

Response

label_idstring
labelobject

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/social-inbox/labels" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME"
}'

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 POST "https://api.mb-suite.com/v1/social-inbox/labels" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME"
}'
PATCH/v1/social-inbox/labels/{label_id}

Rename or recolor a Social Inbox label

social_inbox.labels.update

WriteIdempotentSince 2026-11-01

Updates the name and/or the hex color (#rrggbb) of an inbox label; only what comes in updates changes, and the items that have it keep it. 404 inbox_label_not_found if it does not exist. Returns the label. Requires full access and an owner, admin or member role.

Scope
social_inbox:write
Permission
Edit in the module
MCP tool
social_inbox_labels_updateOn the full surface; on the compact one, mb_execute_operation with id: "social_inbox.labels.update".

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

Parameters

label_idstringpathrequired

An inbox label id (from social_inbox.labels.list).

updatesobjectbodyrequired

What changes (only what comes is written).

Response

labelobject

Errors

Example

curl -X PATCH "https://api.mb-suite.com/v1/social-inbox/labels/{label_id}" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'

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/labels/{label_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'
DELETE/v1/social-inbox/labels/{label_id}

Delete a Social Inbox label

social_inbox.labels.delete

IrreversibleSince 2026-11-01

Deletes an inbox label and removes it from the items that have it (up to 500 per call). It stays 30 days in the trash; restoring it brings the label back with the same id and puts it back on those items (the ones deleted meanwhile are skipped). Rules that add it (add_labels) keep adding it to new items while it is in the trash, where it does not show: the dry run lists them (counts.rules and a warning). Outside the screen it needs a dry run and a confirm_token, except a REST DELETE with a key allowed to delete. Returns how many items were updated. Requires full access and an owner, admin or member role.

With an API key, this DELETE runs directly: the record stays 30 days in the trash and the response carries its trash_item_id. With an OAuth token, and through the MCP, it needs dry_run → confirm_token.

Scope
social_inbox:write and “Allow deletions” (social_inbox:delete in OAuth)
Permission
Edit in the module
MCP tool
social_inbox_labels_deleteOn the full surface; on the compact one, mb_execute_operation with id: "social_inbox.labels.delete".

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

Parameters

label_idstringpathrequired

An inbox label id (from social_inbox.labels.list).

Response

oktrue
items_updatednumber
trash_item_idstring

The trash item this deletion left: the item_id of platform.trash.restore (POST /trash/{item_id}/restore). Missing if nothing went to the trash.

trash_item_idsarray<string>

Only when the deletion left more than one copy: all of them, the first being trash_item_id.

trash_expires_atnumber

When the copy leaves the trash for good (epoch ms): 30 days after the deletion.

Errors

Example

curl -X DELETE "https://api.mb-suite.com/v1/social-inbox/labels/{label_id}" \
  -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 DELETE "https://api.mb-suite.com/v1/social-inbox/labels/{label_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"