Menu

Referência da API · Inbox

Etiquetas

social_inbox · labels · 4 operações

GET/v1/social-inbox/labels

List Social Inbox labels

social_inbox.labels.list

LeituraIdempotenteDesde 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.

Escopo
social_inbox:read
Permissão
Ver o módulo
Tool do MCP
social_inbox_labels_listNa superfície completa; na compacta, mb_execute_operation com id: "social_inbox.labels.list".

Custo declarado: até 200 leituras e 0 escritas por chamada (contam na cota diária).

Parâmetros

Sem parâmetros.

Resposta

dataarray<object>

Erros

Exemplo

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

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

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

EscritaDesde 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.

Escopo
social_inbox:write
Permissão
Editar no módulo
Tool do MCP
social_inbox_labels_createNa superfície completa; na compacta, mb_execute_operation com id: "social_inbox.labels.create".

Custo declarado: até 2 leituras e 1 escritas por chamada (contam na cota diária).

Parâmetros

namestringcorpoobrigatório

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

colorstringcorpoopcional

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

Resposta

label_idstring
labelobject

Erros

Exemplo

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"
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

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

EscritaIdempotenteDesde 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.

Escopo
social_inbox:write
Permissão
Editar no módulo
Tool do MCP
social_inbox_labels_updateNa superfície completa; na compacta, mb_execute_operation com id: "social_inbox.labels.update".

Custo declarado: até 1 leituras e 1 escritas por chamada (contam na cota diária).

Parâmetros

label_idstringrotaobrigatório

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

updatesobjectcorpoobrigatório

What changes (only what comes is written).

Resposta

labelobject

Erros

Exemplo

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": {}
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

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

IrreversívelDesde 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.

Com uma API key, este DELETE roda direto: o registro fica 30 dias na lixeira e a resposta traz o seu trash_item_id. Com um token OAuth, e pelo MCP, pede dry_run → confirm_token.

Escopo
social_inbox:write e «Permitir exclusões» (social_inbox:delete no OAuth)
Permissão
Editar no módulo
Tool do MCP
social_inbox_labels_deleteNa superfície completa; na compacta, mb_execute_operation com id: "social_inbox.labels.delete".

Custo declarado: até 602 leituras e 501 escritas por chamada (contam na cota diária).

Parâmetros

label_idstringrotaobrigatório

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

Resposta

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.

Erros

Exemplo

curl -X DELETE "https://api.mb-suite.com/v1/social-inbox/labels/{label_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X DELETE "https://api.mb-suite.com/v1/social-inbox/labels/{label_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"