Menu

Referência da API · Social Planner

Planejamento mensal

social_planner · planning · 2 operações

POST/v1/social-planner/planning/share

Email the month's planning

social_planner.planning.share

EscritaDesde 2026-11-01

SENDS an email (Amazon SES) with the Social Planner grid of a month (month_key YYYY-MM): every post of the month with date, networks, format, status, labels, text and thumbnail, plus a status and network summary; with format pdf the month's PDF is attached too. All recipients go in one email (to up to 20, cc up to 20). sender_id picks the From among the senders this person can use (the organization's domain senders; none or __system__ = MB Suite); 403 sender_not_allowed otherwise. The send is recorded in the planning share history. With format pdf, 503 pdf_unavailable when the PDF service is not available (nothing is sent). If Amazon SES does not take the email: 409 external_rejected, 429 external_rate_limited, 503 external_unavailable (it surely did not go out) or 409 external_outcome_unknown (it may have gone out: check before sending again). It reaches real inboxes: outside the screen it needs a dry run and a confirm_token; the dry run says the recipients, the From, the month, the format and how many posts go, and social_planner.planning.preview gives the HTML. Dates and times are the posts' own time zone (or the organization's); locale (es, en, pt-BR; default es) sets the email's language. Requires full access to the Social Planner.

Pede confirmação: primeiro dry_run: true (prévia e confirm_token, válido por 10 minutos e por uma única execução), depois o mesmo corpo com confirm_token. Em algumas poucas, só com certos dados: a descrição diz quando. Por que e como: Prévia e confirmação.

Escopo
social_planner:write
Permissão
Editar no módulo
Tool do MCP
social_planner_planning_shareNa superfície completa; na compacta, mb_execute_operation com id: "social_planner.planning.share".

Custo declarado: até 260 leituras e 2 escritas por chamada (contam na cota diária). Usa uma plataforma externa (ses): conta na cota de operações externas.

Parâmetros

month_keystringcorpoobrigatório

The month, YYYY-MM (like 2026-10), in the organization's time zone.

formatenumcorpoobrigatório

html = the email with the month's grid; pdf = a short email with the month's PDF attached.

Valores: pdf, html

toarray<string>corpoobrigatório

Recipients (1 to 20); all of them go in one email.

subjectstringcorpoobrigatório

Subject of the email.

ccarray<string>corpoopcional

Copy recipients (up to 20).

personal_notestringcorpoopcional

Optional personal note shown on top of the email, signed with the sender's name.

sender_idstringcorpoopcional

The From: a sender id of the organization's domain senders (the ones this person can use), or __system__ / nothing for MB Suite. It also decides the email's branding.

localeenumcorpoopcional

Language of the email (es, en or pt-BR): texts, statuses, formats, month and dates. Default es.

Valores: es, en, pt-BR

Resposta

share_idstring
post_countnumber
email_idstring

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/social-planner/planning/share" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "month_key": "MONTH_KEY",
  "format": "pdf",
  "to": [
    "TO"
  ],
  "subject": "SUBJECT",
  "dry_run": true
}'

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. Na prática esta operação não é simulada (usa outra plataforma): responde 409 sandbox_external_unavailable.

GET/v1/social-planner/planning/preview

Preview the month's planning email

social_planner.planning.preview

LeituraIdempotenteDesde 2026-11-01

Builds, without sending anything, the HTML of the email that social_planner.planning.share would send for a month (month_key YYYY-MM, in the organization's time zone), with the branding of the sender it would use (sender_id), the optional personal note and the language (locale es, en or pt-BR; default es). It comes as it would go out: the posts' thumbnails as absolute links signed for one hour that open without a session (the sent email carries them signed for good), dates and times in each post's time zone. Returns html and the number of posts in the month. Requires view access to the Social Planner.

Escopo
social_planner:read
Permissão
Ver o módulo
Tool do MCP
social_planner_planning_previewNa superfície completa; na compacta, mb_execute_operation com id: "social_planner.planning.preview".

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

Parâmetros

month_keystringqueryobrigatório

The month, YYYY-MM (like 2026-10), in the organization's time zone.

formatenumqueryopcional

html = the email with the month's grid; pdf = the short email that goes with the PDF. Default html.

Valores: pdf, html · Padrão: "html"

personal_notestringqueryopcional

Optional personal note shown on top of the email, signed with the sender's name.

sender_idstringqueryopcional

The From: a sender id of the organization's domain senders (the ones this person can use), or __system__ / nothing for MB Suite. It also decides the email's branding.

localeenumqueryopcional

Language of the email (es, en or pt-BR): texts, statuses, formats, month and dates. Default es.

Valores: es, en, pt-BR

Resposta

htmlstring
post_countnumber

Erros

Exemplo

curl "https://api.mb-suite.com/v1/social-planner/planning/preview?month_key=MONTH_KEY" \
  -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-planner/planning/preview?month_key=MONTH_KEY" \
  -H "Authorization: Bearer $MB_TEST_KEY"