MB SuiteMB Suite
Menu

Referência da API · SEO Planner

Comentários

seo_planner · comments · 4 operações

GET/v1/seo-planner/items/{item_id}/commentsPOST/v1/seo-planner/items/{item_id}/commentsPATCH/v1/seo-planner/items/{item_id}/comments/{comment_id}DELETE/v1/seo-planner/items/{item_id}/comments/{comment_id}
GET/v1/seo-planner/items/{item_id}/comments

List the comments of an SEO planner action

seo_planner.comments.list

LeituraIdempotenteDesde 2026-11-01

Lists the internal comments of an SEO Planner action, oldest first, paginated by cursor: content (sanitized HTML), author and mentioned member uids. 404 seo_item_not_found if the action does not exist in this organization. Requires view access to the SEO Planner.

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

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

Parâmetros

item_idstringrotaobrigatório

The action id (id of an item of seo_planner.items.list).

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.

Resposta

dataarray<object>
has_moreboolean
next_cursorstring

Erros

seo_item_not_foundinvalid_inputunknown_fieldauthentication_requiredscope_insufficientmodule_access_deniedoperation_not_foundrate_limitedquota_exceeded

Exemplo

curl "https://api.mb-suite.com/v1/seo-planner/items/{item_id}/comments" \
  -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/items/{item_id}/comments" \
  -H "Authorization: Bearer $MB_TEST_KEY"
POST/v1/seo-planner/items/{item_id}/comments

Comment on an SEO planner action

seo_planner.comments.create

EscritaDesde 2026-11-01

Adds an internal comment to an SEO Planner action (simple HTML or text, sanitized; up to 10,000 characters) and bumps its comment_count. mentions are member uids to notify in the bell (only members of this organization or of its agency workspace receive the notice). The client portal does not show these comments. Returns the comment. Requires full access to the SEO Planner.

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

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

Parâmetros

item_idstringrotaobrigatório

The action id (id of an item of seo_planner.items.list).

contentstringcorpoobrigatório

The comment: plain text or simple HTML (it is sanitized), up to 10,000 characters.

mentionsarray<string>corpoopcional

Uids of members to mention (members of the organization or of its workspace: members.members.list); they get a notification in the bell.

Resposta

comment_idstring
commentobject

Erros

seo_item_not_foundinvalid_inputunknown_fieldauthentication_requiredscope_insufficientcrm_action_deniedidempotency_key_reusedrate_limitedquota_exceeded

Exemplo

curl -X POST "https://api.mb-suite.com/v1/seo-planner/items/{item_id}/comments" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "content": "CONTENT"
}'

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/items/{item_id}/comments" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "content": "CONTENT"
}'
PATCH/v1/seo-planner/items/{item_id}/comments/{comment_id}

Edit a comment of an SEO planner action

seo_planner.comments.update

EscritaIdempotenteDesde 2026-11-01

Replaces the content (and mentions) of a comment on an SEO Planner action. Only its author can edit it (403 comment_author_only); only newly added mentions are notified. Returns the updated comment. Requires full access to the SEO Planner.

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

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

Parâmetros

item_idstringrotaobrigatório

The action id (id of an item of seo_planner.items.list).

comment_idstringrotaobrigatório

The comment id (id of an item of seo_planner.comments.list).

contentstringcorpoobrigatório

The comment: plain text or simple HTML (it is sanitized), up to 10,000 characters.

mentionsarray<string>corpoopcional

Uids of members to mention (members of the organization or of its workspace: members.members.list); they get a notification in the bell.

Resposta

commentobject

Erros

seo_item_not_foundinvalid_inputunknown_fieldauthentication_requiredscope_insufficientcrm_action_deniedidempotency_key_reusedrate_limitedquota_exceeded

Exemplo

curl -X PATCH "https://api.mb-suite.com/v1/seo-planner/items/{item_id}/comments/{comment_id}" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "CONTENT"
}'

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/items/{item_id}/comments/{comment_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "CONTENT"
}'
DELETE/v1/seo-planner/items/{item_id}/comments/{comment_id}

Delete a comment of an SEO planner action

seo_planner.comments.delete

IrreversívelDesde 2026-11-01

Deletes a comment of an SEO Planner action and lowers its comment_count. Its author or an owner/admin of the organization can delete it (403 comment_delete_denied otherwise). It stays 30 days in the trash (platform.trash.restore brings it back to its action). 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_comments_deleteNa superfície completa; na compacta, mb_execute_operation com id: "seo_planner.comments.delete".

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

Parâmetros

item_idstringrotaobrigatório

The action id (id of an item of seo_planner.items.list).

comment_idstringrotaobrigatório

The comment id (id of an item of seo_planner.comments.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

seo_item_not_founddelete_not_allowedconfirmation_requiredinvalid_inputunknown_fieldauthentication_requiredscope_insufficientcrm_action_deniedidempotency_key_reusedrate_limitedquota_exceeded

Exemplo

curl -X DELETE "https://api.mb-suite.com/v1/seo-planner/items/{item_id}/comments/{comment_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/items/{item_id}/comments/{comment_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"