Etiquetas

List member labels

members.labels.list

Lists the organization's member labels in display order (name, color, order): tags that organize the team on the Members page and filter members.members.list (label_id). They do not change access. Requires view access to Members.

Escopo

members:read

Permissão

Ver o módulo

Tool do MCP

members_labels_listNa superfície completa; na compacta, mb_execute_operation com id: "members.labels.list".

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

Parâmetros

Sem parâmetros.

Resposta

Erros

Exemplo

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

Create a member label

members.labels.create

Creates a member label with a name (up to 80 characters) and an optional hex color (without it, the next color of the app's palette). It goes last in the order. Put it on members with members.members.update_labels or members.members.bulk.update_labels. Returns the label. Owner or admin only.

Escopo

members:write

Permissão

Editar no módulo · Só owner, admin

Tool do MCP

members_labels_createNa superfície completa; na compacta, mb_execute_operation com id: "members.labels.create".

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

Parâmetros

Resposta

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/members/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/members/labels" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME"
}'

Update a member label

members.labels.update

Updates a member label's name, color or position in the list, all inside updates: order is the position (0 = first; past the end = last) and the other labels shift to make room. Unknown fields are rejected. 404 member_label_not_found if it is not in this organization. Returns the label. Owner or admin only.

Escopo

members:write

Permissão

Editar no módulo · Só owner, admin

Tool do MCP

members_labels_updateNa superfície completa; na compacta, mb_execute_operation com id: "members.labels.update".

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

Parâmetros

Resposta

Erros

Exemplo

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

Delete a member label

members.labels.delete

Deletes a member label and removes it from every member that had it, in one write. The label stays 30 days in the trash, where an owner or admin can restore it (platform.trash.restore); restoring puts it back on those members (the ones still in the organization). Outside the app it needs a dry run and a confirm_token, except a REST DELETE with a key allowed to delete. 404 member_label_not_found. Owner or admin only.

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

members:write e «Permitir exclusões» (members:delete no OAuth)

Permissão

Editar no módulo · Só owner, admin

Tool do MCP

members_labels_deleteNa superfície completa; na compacta, mb_execute_operation com id: "members.labels.delete".

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

Parâmetros

Resposta

Erros

Exemplo

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