Referência da API · Partners

Convites

partners · invitations · 5 operações

GET/v1/partners/invitationsList the partner invitations sent by the workspace GET/v1/partners/invitations/{invitation_id}Get one partner invitation POST/v1/partners/invitationsInvite another organization to become an account of the workspace POST/v1/partners/invitations/{invitation_id}/resendResend a pending partner invitation POST/v1/partners/invitations/{invitation_id}/cancelCancel a pending partner invitation

GET/v1/partners/invitations

List the partner invitations sent by the workspace

partners.invitations.list

LeituraIdempotenteDesde 2026-11-01

Lists the partner invitations this workspace sent, newest first, paginated by cursor (limit up to 200). A partner invitation asks the owner of ANOTHER organization (by email) to link it as an account of the workspace; that organization keeps paying its own subscription. Each invitation: recipient_email, status (pending, expired = pending but past expires_at, accepted, declined, cancelled), who sent it, created_at, expires_at (7 days after sending or the last resend), responded_at, cancelled_at and, once accepted, child_org_id and child_org_name (the new account, see platform.orgs.get). Filter with status (or all, the default); a filtered page is filled up to limit while reading (up to 500 invitations per page; then has_more says whether more follow). Only workspaces send invitations: called on an Account (org_id of an Account) it is 400, run it without org_id. Owners and admins only.

Escopo: partners:read
Permissão: Ver o módulo · Só owner, admin
Tool do MCP: partners_invitations_listNa superfície completa; na compacta, mb_execute_operation com id: "partners.invitations.list".

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

statusenumqueryopcional

Only the invitations in this status (expired: pending past their 30 days), or all (the default).

Valores: pending, expired, accepted, declined, cancelled, all

Resposta

dataarray<object>

has_moreboolean

next_cursorstring

Erros

role_required 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/partners/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/partners/invitations" \
  -H "Authorization: Bearer $MB_TEST_KEY"

GET/v1/partners/invitations/{invitation_id}

Get one partner invitation

partners.invitations.get

LeituraIdempotenteDesde 2026-11-01

Returns one partner invitation sent by this workspace, with the same fields as partners.invitations.list (status expired means pending but past expires_at: it can still be resent or cancelled, no longer accepted). An invitation sent by another organization is not found (partner_invitation_not_found). Owners and admins only.

Escopo: partners:read
Permissão: Ver o módulo · Só owner, admin
Tool do MCP: partners_invitations_getNa superfície completa; na compacta, mb_execute_operation com id: "partners.invitations.get".

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

Parâmetros

invitation_idstringrotaobrigatório

The partner invitation id (partners.invitations.list).

Resposta

idstring

statusenum

Valores: pending, expired, accepted, declined, cancelled

recipient_emailstring

parent_org_idstring

parent_org_namestring

invited_bystring

invited_by_namestring

invited_by_emailstring

created_atnumber

expires_atnumber

responded_atnumber | null

cancelled_atnumber | null

child_org_idstring | null

child_org_namestring | null

Erros

partner_invitation_not_found role_required 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/partners/invitations/{invitation_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/partners/invitations/{invitation_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"

POST/v1/partners/invitations

Invite another organization to become an account of the workspace

partners.invitations.send

EscritaDesde 2026-11-01

SENDS a partner invitation by email (Amazon SES, from MB Suite, in the inviter's language) to the owner of another organization (email; recipient_email, its name in the output, is accepted too): it can accept it from MB Suite (Settings → Partners) within 7 days, choosing one of the organizations it owns, which then becomes an account of this workspace while it keeps paying its own subscription (on an internal or paying workspace, its base price moves to the partner tier from its next invoice). Accepting and declining are done by the invited person in the app, never through the API (partners.invitation.accepted / partners.invitation.declined fire). Only a workspace can invite (partners_workspace_only), and it takes a direct owner or admin with edit access to Accounts (partners_accounts_access_required: only agency workspaces link accounts). Errors: partner_invitation_email_invalid, partner_invitation_exists (409, a pending invitation for that email already exists: resend or cancel it; details.invitation_id), partner_invitation_own_member (the email belongs to a member of the workspace). It reaches a real inbox: confirm the address with the person first. Returns the invitation.

Instruções para agentes

Tell the person the invitation was emailed and that the other organization has 7 days to accept it from MB Suite (Settings → Partners).

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: partners:write
Permissão: Editar no módulo · Só owner, admin
Tool do MCP: partners_invitations_sendNa superfície completa; na compacta, mb_execute_operation com id: "partners.invitations.send".
Eventos que pode emitir: partners.invitation.sent

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

emailstringcorpoopcional

The email of the owner of the organization to link (recipient_email is accepted too).

recipient_emailstringcorpoopcional

Same as email: the name the invitation shows it with in the output.

Resposta

invitation_idstring

invitationobject

Erros

confirmation_required role_required external_rejected external_unavailable external_rate_limited external_outcome_unknown sandbox_external_unavailable 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/partners/invitations" \
  -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.

POST/v1/partners/invitations/{invitation_id}/resend

Resend a pending partner invitation

partners.invitations.resend

EscritaDesde 2026-11-01

Emails a pending partner invitation again (Amazon SES) and gives it 7 more days from now (expires_at moves); it also revives an expired one (status expired). Only pending invitations (partner_invitation_not_pending, 409, once accepted, declined or cancelled). Same permissions as partners.invitations.send: a direct owner or admin with edit access to Accounts. It reaches a real inbox again: run it only when the person asks. Returns the invitation.

Escopo: partners:write
Permissão: Editar no módulo · Só owner, admin
Tool do MCP: partners_invitations_resendNa superfície completa; na compacta, mb_execute_operation com id: "partners.invitations.resend".
Eventos que pode emitir: partners.invitation.sent

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

invitation_idstringrotaobrigatório

The partner invitation id (partners.invitations.list).

Resposta

invitationobject

Erros

partner_invitation_not_found confirmation_required role_required external_rejected external_unavailable external_rate_limited external_outcome_unknown sandbox_external_unavailable 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/partners/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

POST/v1/partners/invitations/{invitation_id}/cancel

Cancel a pending partner invitation

partners.invitations.cancel

EscritaIdempotenteDesde 2026-11-01

Cancels a pending (or expired) partner invitation: its link stops working and the invited organization can no longer accept it; nobody is emailed. The invitation stays in the list as cancelled (nothing is deleted). Idempotent: on an invitation already cancelled nothing changes (changed=false); an accepted or declined one is partner_invitation_not_pending (409). A direct owner or admin with edit access to Accounts. Returns the invitation.

Escopo: partners:write
Permissão: Editar no módulo · Só owner, admin
Tool do MCP: partners_invitations_cancelNa superfície completa; na compacta, mb_execute_operation com id: "partners.invitations.cancel".
Eventos que pode emitir: partners.invitation.cancelled

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

Parâmetros

invitation_idstringrotaobrigatório

The partner invitation id (partners.invitations.list).

Resposta

invitationobject

changedboolean

Erros

partner_invitation_not_found role_required 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/partners/invitations/{invitation_id}/cancel" \
  -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/partners/invitations/{invitation_id}/cancel" \
  -H "Authorization: Bearer $MB_TEST_KEY"