Menu

Referência da API · SEO Planner

Compartilhamentos

seo_planner · shares · 3 operações

POST/v1/seo-planner/shares

Email the month's SEO planning

seo_planner.shares.send

EscritaDesde 2026-11-01

SENDS an email (Amazon SES) with the SEO Planner of a month (month_key YYYY-MM): every action of the month with its type, status, description and sub-actions, plus a status 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 (an item of senders in branding.email_domain.get: the organization's verified domain or, for an Account, its workspace's; none or __system__ = MB Suite); 403 sender_not_allowed otherwise. locale (es, en, pt-BR; default es) is the language of the email: texts, month, action types and statuses. The send is recorded in the share history (seo_planner.shares.list). It reaches real inboxes: confirm the recipients first. Errors: 503 pdf_unavailable when the PDF service is not available (format pdf; nothing is sent, retry later); when SES does not send the email, 429 external_rate_limited, 409 external_rejected (its reason in details.provider_message), 503 external_unavailable (it surely did not reach SES: retry) or 409 external_outcome_unknown (no answer: the email may have gone out; check with the recipients before sending it again), all with details.platform ses. Viewers cannot share (403 role_required). Requires full access to the SEO 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
seo_planner:write
Permissão
Editar no módulo
Tool do MCP
seo_planner_shares_sendNa superfície completa; na compacta, mb_execute_operation com id: "seo_planner.shares.send".

Custo declarado: até 520 leituras e 1 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 to share (YYYY-MM).

formatenumcorpoobrigatório

html: the email with the month's actions; pdf: the same email with the month's PDF attached.

Valores: pdf, html

toarray<string>corpoobrigatório

Recipients (1 to 20 addresses).

subjectstringcorpoobrigatório

The subject (1 to 200 characters).

ccarray<string>corpoopcional

Copies (up to 20).

personal_notestringcorpoopcional

A personal note shown at the top of the email, signed by the sender (up to 2,000 characters).

sender_idstringcorpoopcional

The From: the id of a sender this person can use (an item of senders in branding.email_domain.get, of the organization or, for an Account, of its workspace); __system__ or nothing sends as MB Suite. 403 sender_not_allowed otherwise.

localeenumcorpoopcional

Language of the email (texts, month name, type and status labels): es (default), en or pt-BR.

Valores: es, en, pt-BR

Resposta

share_idstring

The share record (seo_planner.shares.list).

action_countnumber

Planner actions (cards) of the month.

effective_action_countnumber

The «Total actions» the email shows: each sub-action counts as one when the card has a checklist.

email_idstring

The SES message id.

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/seo-planner/shares" \
  -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/seo-planner/shares

List the SEO planning emails sent

seo_planner.shares.list

LeituraIdempotenteDesde 2026-11-01

Lists the emails that shared the SEO planning, newest first, paginated by cursor: month, format, recipients (to, cc), subject, personal note, sender, who sent it (sent_by with sent_by_name, the person's current name) and how many actions it carried. With month_key (YYYY-MM), only that month's. Viewers cannot see the history (403 role_required). Requires view access to the SEO Planner.

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

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

Parâmetros

limitintegerqueryopcional

How many items this page brings at most (see the maximum and the default in the schema).

Padrão: 50

cursorstringqueryopcional

The next_cursor of the previous page, exactly as it came (only for the same list and filters); without it, the first page.

month_keystringqueryopcional

Only the shares of this month (YYYY-MM).

Resposta

dataarray<object>
has_moreboolean
next_cursorstring

Erros

Exemplo

curl "https://api.mb-suite.com/v1/seo-planner/shares" \
  -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/seo-planner/shares" \
  -H "Authorization: Bearer $MB_TEST_KEY"
GET/v1/seo-planner/shares/preview

Preview the SEO planning email

seo_planner.shares.preview

LeituraIdempotenteDesde 2026-11-01

Builds, without sending anything, the HTML of the email that seo_planner.shares.send would send for a month (month_key YYYY-MM) in a format (html by default, or pdf: the email that goes with the PDF, without building the PDF), with the branding of the sender it would use (sender_id), the optional personal note and the locale (es by default, as the send). Returns html, action_count (the planner actions of the month) and effective_action_count (the «Total actions» the email shows, where each sub-action counts as one). Viewers cannot preview (403 role_required). Requires view access to the SEO Planner.

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

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

Parâmetros

month_keystringqueryobrigatório

The month (YYYY-MM).

formatenumqueryopcional

html (default) or pdf: the email of each format (the PDF itself is not built).

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

personal_notestringqueryopcional

A personal note shown at the top of the email, signed by the sender (up to 2,000 characters).

sender_idstringqueryopcional

The From: the id of a sender this person can use (an item of senders in branding.email_domain.get, of the organization or, for an Account, of its workspace); __system__ or nothing sends as MB Suite. 403 sender_not_allowed otherwise.

localeenumqueryopcional

Language of the email (texts, month name, type and status labels): es (default), en or pt-BR.

Valores: es, en, pt-BR

Resposta

htmlstring

The email's HTML.

action_countnumber

Planner actions (cards) of the month.

effective_action_countnumber

The «Total actions» the email shows: each sub-action counts as one when the card has a checklist.

Erros

Exemplo

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