Referência da API · Inbox

Respostas salvas

social_inbox · snippets · 5 operações

GET/v1/social-inbox/snippetsList the saved replies (snippets) of the Social Inbox GET/v1/social-inbox/snippets/{snippet_id}Get one saved reply (snippet)POST/v1/social-inbox/snippetsCreate a saved reply (snippet)PATCH/v1/social-inbox/snippets/{snippet_id}Update a saved reply (snippet)DELETE/v1/social-inbox/snippets/{snippet_id}Delete a saved reply (snippet)

GET/v1/social-inbox/snippets

List the saved replies (snippets) of the Social Inbox

social_inbox.snippets.list

LeituraIdempotenteDesde 2026-11-01

Lists the saved replies of the inbox by name (up to 500): name, body with {{variables}} (name, nombre and username are filled from the item's author), category, locale, tone and how many times they were used. locale filters by language (es, en, pt…). Requires view access to the Social Inbox.

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

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

Parâmetros

localestringqueryopcional

Only saved replies in this language (es, en, pt-BR…).

Resposta

dataarray<object>

Erros

invalid_input unknown_field authentication_required scope_insufficient module_access_denied operation_not_found rate_limited quota_exceeded

Exemplo

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

GET/v1/social-inbox/snippets/{snippet_id}

Get one saved reply (snippet)

social_inbox.snippets.get

LeituraIdempotenteDesde 2026-11-01

Returns one saved reply of the inbox with its body, variables, category, locale, tone and usage count. 404 inbox_snippet_not_found if it is not in this organization. Requires view access.

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

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

Parâmetros

snippet_idstringrotaobrigatório

The saved reply id (from social_inbox.snippets.list).

Resposta

idstring

The saved reply id.

namestring

Its name.

bodystring

Its text, with optional {{variables}}: {{name}} or {{nombre}} (the author's first name) and {{username}} are filled in when a rule sends it; unknown ones are removed.

localestring

Its language (es, en, pt-BR…).

tonestring

formal, friendly, brief, empathetic or neutral.

usage_countnumber

How many times it was used from the composer.

categorystring | null

Its category, if any.

variablesarray<string> | null

The {{variables}} its body uses.

created_atnumber | null

When it was created (epoch ms).

created_by_idstring | null

Who created it.

updated_atnumber | null

Last edit (epoch ms).

updated_by_idstring | null

Who edited it last.

Erros

inbox_snippet_not_found invalid_input unknown_field authentication_required scope_insufficient module_access_denied operation_not_found rate_limited quota_exceeded

Exemplo

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

POST/v1/social-inbox/snippets

Create a saved reply (snippet)

social_inbox.snippets.create

EscritaDesde 2026-11-01

Creates a saved reply for the inbox: name (up to 120 characters), body (up to 8,192; {{name}}, {{nombre}} and {{username}} are filled from the item's author, unknown variables are dropped before sending), optional category, locale (default es) and tone (formal, friendly, brief, empathetic, neutral; default neutral). Up to 500 per organization (409 limit_reached, details.resource inbox_snippets). Returns it 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_snippets_createNa superfície completa; na compacta, mb_execute_operation com id: "social_inbox.snippets.create".

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

Parâmetros

namestringcorpoobrigatório

Its name (what the composer shows).

bodystringcorpoobrigatório

Its text; {{name}}, {{nombre}} (the author's first name) and {{username}} are filled in when a rule sends it.

categorystringcorpoopcional

Optional category to group saved replies.

localestringcorpoopcional

Its language (es, en, pt-BR…). Default es.

Padrão: "es"

toneenumcorpoopcional

formal, friendly, brief, empathetic or neutral (the default).

Valores: formal, friendly, brief, empathetic, neutral · Padrão: "neutral"

Resposta

snippet_idstring

snippetobject

Erros

invalid_input unknown_field authentication_required scope_insufficient crm_action_denied idempotency_key_reused rate_limited quota_exceeded

Exemplo

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

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/snippets" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME",
  "body": "BODY"
}'

PATCH/v1/social-inbox/snippets/{snippet_id}

Update a saved reply (snippet)

social_inbox.snippets.update

EscritaIdempotenteDesde 2026-11-01

Updates a saved reply: only what comes in updates changes (name, body, category, locale, tone; category null removes it); the variables are recalculated from the new body. Rules that reply with it use the new text from then on. 404 inbox_snippet_not_found if it does not exist. Returns it. 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_snippets_updateNa superfície completa; na compacta, mb_execute_operation com id: "social_inbox.snippets.update".

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

Parâmetros

snippet_idstringrotaobrigatório

The saved reply id (from social_inbox.snippets.list).

updatesobjectcorpoobrigatório

What changes (only what comes is written).

Resposta

snippetobject

Erros

inbox_snippet_not_found invalid_input unknown_field authentication_required scope_insufficient crm_action_denied idempotency_key_reused rate_limited quota_exceeded

Exemplo

curl -X PATCH "https://api.mb-suite.com/v1/social-inbox/snippets/{snippet_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/snippets/{snippet_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'

DELETE/v1/social-inbox/snippets/{snippet_id}

Delete a saved reply (snippet)

social_inbox.snippets.delete

IrreversívelDesde 2026-11-01

Deletes a saved reply. It stays 30 days in the trash; active rules that reply with it stop replying until it is restored with the same id (the dry run lists them). Outside the screen it needs a dry run and a confirm_token, except a REST DELETE with a key allowed to delete. 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_snippets_deleteNa superfície completa; na compacta, mb_execute_operation com id: "social_inbox.snippets.delete".

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

Parâmetros

snippet_idstringrotaobrigatório

The saved reply id (from social_inbox.snippets.list).

Resposta

oktrue

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

inbox_snippet_not_found delete_not_allowed confirmation_required invalid_input unknown_field authentication_required scope_insufficient crm_action_denied idempotency_key_reused rate_limited quota_exceeded

Exemplo

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