Referência da API · SEO Planner

Templates de ação

seo_planner · action_templates · 8 operações

GET/v1/seo-planner/action-templates

List SEO action templates

seo_planner.action_templates.list

LeituraIdempotenteDesde 2026-11-01

Lists SEO action templates: a reusable action (name, subtitle, seo_type, description, icon, color and its sub-actions) to create planner actions (seo_planner.action_templates.apply) or build packs. source picks where from: all (default) = the organization's own, then its agency workspace's when the organization is an Account (read only), then the published templates of the MB Suite library; or org, parent, system. Paginated by cursor. Requires view access to the SEO Planner.

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

Custo declarado: até 601 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.

sourceenumqueryopcional

all (default: the organization's, then its workspace's when it is an Account, then the published ones of the MB Suite library), org, parent or system.

Valores: all, org, parent, system · Padrão: "all"

Resposta

dataarray<object>

has_moreboolean

next_cursorstring

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/seo-planner/action-templates" \
  -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/action-templates" \
  -H "Authorization: Bearer $MB_TEST_KEY"

GET/v1/seo-planner/action-templates/{template_id}

Get one SEO action template

seo_planner.action_templates.get

LeituraIdempotenteDesde 2026-11-01

Returns one SEO action template. Without source it looks in the organization's templates, then its workspace's (for an Account) and then the published templates of the MB Suite library; drafts of the library do not exist for an organization. 404 seo_action_template_not_found otherwise. Requires view access to the SEO Planner.

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

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

Parâmetros

template_idstringrotaobrigatório

The action template id (id of an item of seo_planner.action_templates.list).

sourceenumqueryopcional

Where to look: org, parent (the workspace of an Account) or system (the MB Suite library). Without it, in that order.

Valores: org, parent, system

Resposta

idstring

namestring

The title the created action gets.

seo_typestring

Action type it creates.

sourceenum

org (editable), parent (the agency workspace's, read only) or system (the MB Suite library: copy it with seo_planner.action_templates.clone_system).

Valores: org, parent, system

subtitlestring | null

descriptionstring | null

icon_keystring | null

colorstring | null

sub_actionsarray<object>

The checklist the created action gets.

ordernumber

source_org_idstring | null

With source parent: the workspace the template belongs to.

created_by_idstring | null

Who created it (null or system for the library).

created_by_namestring | null

Their name, when it is a person.

created_atnumber

updated_atnumber

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/seo-planner/action-templates/{template_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/seo-planner/action-templates/{template_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"

POST/v1/seo-planner/action-templates

Create an SEO action template

seo_planner.action_templates.create

EscritaDesde 2026-11-01

Creates an action template at the end of the organization's list, owned by the caller: name, seo_type, optional subtitle, description, icon and color (default: those of the type) and sub_actions (ordered titles). Returns the template. Requires full access to the SEO Planner.

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

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

Parâmetros

namestringcorpoobrigatório

The title the created actions get (1 to 200 characters).

seo_typeenumcorpoobrigatório

Their type.

Valores: blog_post, on_page_seo, speed_performance, technical_seo, website_audit, ai_geo, backlink, keyword_research, seo_analytics, international_seo, local_seo, setup_tools, competitor_analysis, link_audit, rank_tracking, client_report, custom

subtitlestringcorpoopcional

Their subtitle.

descriptionstringcorpoopcional

Their description.

icon_keystringcorpoopcional

MDI icon name (default: the type's).

colorstringcorpoopcional

Hex color (default: the type's).

sub_actionsarray<object>corpoopcional

The checklist the created actions get, in order.

Resposta

template_idstring

templateobject

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/seo-planner/action-templates" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME",
  "seo_type": "blog_post"
}'

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/seo-planner/action-templates" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME",
  "seo_type": "blog_post"
}'

PATCH/v1/seo-planner/action-templates/{template_id}

Update an SEO action template

seo_planner.action_templates.update

EscritaDesde 2026-11-01

Changes the name, subtitle, seo_type, description, icon, color or sub_actions (the whole ordered list) of one of the organization's action templates; templates of the workspace or the library cannot be edited from here. Planner actions already created from it are not touched. Unknown fields are rejected. Returns the template. Requires full access to the SEO Planner.

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

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

Parâmetros

template_idstringrotaobrigatório

The id of one of the organization's own action templates (a workspace or library one cannot be edited: copy it first).

updatesobjectcorpoobrigatório

The fields to change (at least one).

Resposta

templateobject

Erros

seo_action_template_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/seo-planner/action-templates/{template_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/seo-planner/action-templates/{template_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'

DELETE/v1/seo-planner/action-templates/{template_id}

Delete an SEO action template

seo_planner.action_templates.delete

IrreversívelDesde 2026-11-01

Deletes one of the organization's action templates. It goes to the 30-day trash, where an owner or admin can restore it. Planner actions and packs built from it are not touched. Outside the app it needs a dry run and a confirm_token, except a REST DELETE with a key allowed to delete. Requires full access to the SEO Planner.

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: seo_planner:write e «Permitir exclusões» (seo_planner:delete no OAuth)
Permissão: Editar no módulo
Tool do MCP: seo_planner_action_templates_deleteNa superfície completa; na compacta, mb_execute_operation com id: "seo_planner.action_templates.delete".

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

Parâmetros

template_idstringrotaobrigatório

The id of one of the organization's own action templates (source org).

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

seo_action_template_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/seo-planner/action-templates/{template_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/seo-planner/action-templates/{template_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"

POST/v1/seo-planner/action-templates/{template_id}/duplicate

Duplicate an SEO action template

seo_planner.action_templates.duplicate

EscritaDesde 2026-11-01

Copies one of the organization's action templates into a new one named '<name> (Copy)' (the suffix in the caller's language: '(Copia)', '(Copy)' or '(Cópia)') at the end of the list, owned by the caller. Returns the new template id. Requires full access to the SEO Planner.

Escopo: seo_planner:write
Permissão: Editar no módulo
Tool do MCP: seo_planner_action_templates_duplicateNa superfície completa; na compacta, mb_execute_operation com id: "seo_planner.action_templates.duplicate".

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

Parâmetros

template_idstringrotaobrigatório

The id of one of the organization's own action templates (source org).

Resposta

template_idstring

Erros

seo_action_template_not_found 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/seo-planner/action-templates/{template_id}/duplicate" \
  -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 POST "https://api.mb-suite.com/v1/seo-planner/action-templates/{template_id}/duplicate" \
  -H "Authorization: Bearer $MB_TEST_KEY"

POST/v1/seo-planner/action-templates/system/{system_template_id}/clone

Copy a library action template into the organization

seo_planner.action_templates.clone_system

EscritaDesde 2026-11-01

Copies a published action template of the MB Suite library (an id from seo_planner.action_templates.list with source system) into the organization so it can be edited. Drafts of the library cannot be copied (404 seo_action_template_not_found). Returns the new template id. Requires full access to the SEO Planner.

Escopo: seo_planner:write
Permissão: Editar no módulo
Tool do MCP: seo_planner_action_templates_clone_systemNa superfície completa; na compacta, mb_execute_operation com id: "seo_planner.action_templates.clone_system".

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

Parâmetros

system_template_idstringrotaobrigatório

The id of a published library template (an item of seo_planner.action_templates.list with source system).

Resposta

template_idstring

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/seo-planner/action-templates/system/{system_template_id}/clone" \
  -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 POST "https://api.mb-suite.com/v1/seo-planner/action-templates/system/{system_template_id}/clone" \
  -H "Authorization: Bearer $MB_TEST_KEY"

POST/v1/seo-planner/action-templates/{template_id}/apply

Create a planner action from an SEO action template

seo_planner.action_templates.apply

EscritaDesde 2026-11-01

Creates one SEO Planner action from a template in the month month_key (YYYY-MM): pending, with the template's name as title, its subtitle, type, description and sub-actions (unticked), linked to the template (template_id). The template is read on the server (the organization's, its workspace's or a published library template; without source, in that order). Returns the new action. Requires full access to the SEO Planner.

Escopo: seo_planner:write
Permissão: Editar no módulo
Tool do MCP: seo_planner_action_templates_applyNa superfície completa; na compacta, mb_execute_operation com id: "seo_planner.action_templates.apply".
Eventos que pode emitir: seo_planner.item.created

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

Parâmetros

template_idstringrotaobrigatório

The action template id (id of an item of seo_planner.action_templates.list).

month_keystringcorpoobrigatório

The month of the new action (YYYY-MM).

sourceenumcorpoopcional

Where to look: org, parent (the workspace of an Account) or system (the MB Suite library). Without it, in that order.

Valores: org, parent, system

Resposta

item_idstring

itemobject

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/seo-planner/action-templates/{template_id}/apply" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "month_key": "MONTH_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 POST "https://api.mb-suite.com/v1/seo-planner/action-templates/{template_id}/apply" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "month_key": "MONTH_KEY"
}'