Menu

Referência da API · Social Planner

Etiquetas

social_planner · labels · 5 operações

GET/v1/social-planner/labels

List post labels

social_planner.labels.list

LeituraIdempotenteDesde 2026-11-01

Lists the labels used to tag Social Planner posts (name, hex color, order), in the order the planner shows them (up to 200). Use their ids in label_ids when creating or updating posts and to filter social_planner.posts.list. Requires view access to the Social Planner.

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

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

Parâmetros

Sem parâmetros.

Resposta

dataarray<object>

Erros

Exemplo

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

Create a post label

social_planner.labels.create

EscritaDesde 2026-11-01

Creates a post label with a name (up to 50 characters) and a hex color (#rrggbb; default #ef4444, the first of the palette), placed last in the order (the first label is 0). Labels are per organization (workspace or account), up to 200 (409 limit_reached, details.resource post_labels). Returns the label with its id. Requires full access to the Social Planner.

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

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

Parâmetros

namestringcorpoobrigatório

The label's name (1 to 50 characters).

colorstringcorpoopcional

Its color, hex #rrggbb. Default #ef4444 (the first of the palette).

Padrão: "#ef4444"

Resposta

label_idstring
labelobject

Erros

Exemplo

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

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-planner/labels" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME"
}'
PATCH/v1/social-planner/labels/{label_id}

Rename, recolor or move a post label

social_planner.labels.update

EscritaIdempotenteDesde 2026-11-01

Updates the name, the color (#rrggbb) or the position (order) of a post label; posts that use it keep it. Returns the updated label. Requires full access.

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

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

Parâmetros

label_idstringrotaobrigatório

The Planner label id (from social_planner.labels.list).

updatesobjectcorpoobrigatório

What changes (only what comes is written).

Resposta

labelobject

Erros

Exemplo

curl -X PATCH "https://api.mb-suite.com/v1/social-planner/labels/{label_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-planner/labels/{label_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'
POST/v1/social-planner/labels/reorder

Reorder post labels

social_planner.labels.reorder

EscritaIdempotenteDesde 2026-11-01

Sets the order of post labels: label_ids in the new order (position = index). Ids that are not labels of this organization (another tab deleted one) are skipped and counted in skipped; repeated ids are 400 duplicate_label_ids. Returns count (reordered) and skipped. Requires full access.

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

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

Parâmetros

label_idsarray<string>corpoobrigatório

Label ids in the new order (from social_planner.labels.list): position = index. Ids that no longer exist are skipped (counted in skipped).

Resposta

countnumber

Labels reordered.

skippednumber

Ids skipped because they are not labels of this organization.

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/social-planner/labels/reorder" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "label_ids": [
    "LABEL_ID"
  ]
}'

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-planner/labels/reorder" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "label_ids": [
    "LABEL_ID"
  ]
}'
DELETE/v1/social-planner/labels/{label_id}

Delete a post label

social_planner.labels.delete

IrreversívelDesde 2026-11-01

Deletes a post label and removes it from every post that has it (the posts themselves are not touched otherwise). The label goes to the 30-day trash; restoring it brings the label back but not its assignments to posts. The dry run says how many posts have it. Returns how many posts were updated. Requires full access.

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

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

Parâmetros

label_idstringrotaobrigatório

The Planner label id (from social_planner.labels.list).

Resposta

oktrue
posts_updatednumber
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

Exemplo

curl -X DELETE "https://api.mb-suite.com/v1/social-planner/labels/{label_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-planner/labels/{label_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"