Convites

List pending invitations

members.invitations.list

Lists the invitations to this organization that are still pending and valid (an invitation lasts 30 days; expired ones and invitations to people who already joined are left out), newest first, paginated by cursor. Each one carries the email, the role it grants, who invited, when it expires, how many times its email was sent and accept_url, the link the person opens to join (they must sign in with the invited email). Owner or admin only.

Escopo

members:read

Permissão

Ver o módulo · Só owner, admin

Tool do MCP

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

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

Parâmetros

Resposta

Erros

Exemplo

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

Invite someone by email

members.invitations.create

Creates an invitation to join this organization with a role (default member; owner only for owners, 403 role_required with details.roles [owner]; through an API key or an app, at most member, 403 role_above_credential_ceiling: inviting an admin or an owner is done in MB Suite, signed in) and, unless send_email is false, emails it from MB Suite in the inviter's language (the organization name and the inviter come from the server). The person joins by opening accept_url signed in with that email; the invitation lasts 30 days. If a valid pending invitation already exists for that email it is returned as is (created false, nothing sent: use members.invitations.resend). 409 already_member if the email already belongs to a member. Outside the app, when it sends the email (send_email true, the default) it runs as a dry run first (it checks those rules and says who gets the email) and needs the confirm_token; with send_email false nothing goes out and the dry run is optional. Owner or admin only.

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. Nesta, só quando: send_email is true (the invitation email goes out).

Escopo

members:write

Permissão

Editar no módulo · Só owner, admin

Tool do MCP

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

Eventos que pode emitir

members.invitation.created

Custo declarado: até 24 leituras e 2 escritas por chamada (contam na cota diária). Usa uma plataforma externa (ses): conta na cota de operações externas.

Parâmetros

Resposta

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/members/invitations" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "ana@example.com",
  "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.

Send the invitation email again

members.invitations.resend

Emails a pending invitation again from MB Suite, with the organization name of today and the original inviter. At most once a minute per invitation (429 cooldown_active, details.retry_after in seconds) and ten times in total (409 limit_reached, details.resource invitation_emails); an expired invitation cannot be resent (409 invitation_expired: cancel it and invite again). 404 invitation_not_found if it is not in this organization. If the email provider does not send it (details.platform ses: 503 external_unavailable or 429 external_rate_limited, retry later; 409 external_rejected when it refuses the address), the invitation is unchanged and retrying sends it again; 409 external_outcome_unknown when the provider did not answer and the email may have gone out (check before resending). Owner or admin only.

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

members:write

Permissão

Editar no módulo · Só owner, admin

Tool do MCP

members_invitations_resendNa superfície completa; na compacta, mb_execute_operation com id: "members.invitations.resend".

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

Resposta

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/members/invitations/{invitation_id}/resend" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "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.

Cancel a pending invitation

members.invitations.cancel

Cancels a pending invitation: its link stops working at once. There is no trash for an invitation (to invite the person again, create a new one), so outside the app it always needs a dry run and a confirm_token. 404 invitation_not_found if it is not in this organization; 409 invitation_not_pending if it was already accepted or declined. Owner or admin only.

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

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

Permissão

Editar no módulo · Só owner, admin

Tool do MCP

members_invitations_cancelNa superfície completa; na compacta, mb_execute_operation com id: "members.invitations.cancel".

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

Parâmetros

Resposta

Erros

Exemplo

curl -X DELETE "https://api.mb-suite.com/v1/members/invitations/{invitation_id}" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "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.

curl -X DELETE "https://api.mb-suite.com/v1/members/invitations/{invitation_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'