Menú

Referencia de la API · Web Forms

Formularios

web_forms · forms · 12 operaciones

GET/v1/web-formsList web forms GET/v1/web-forms/{form_id}Get one web form POST/v1/web-formsCreate a web form PATCH/v1/web-forms/{form_id}Update a web form POST/v1/web-forms/{form_id}/publishPublish a web form POST/v1/web-forms/{form_id}/unpublishUnpublish a web form POST/v1/web-forms/{form_id}/duplicateDuplicate a web form DELETE/v1/web-forms/{form_id}Delete a web form and its responses POST/v1/web-forms/{form_id}/test-notificationSend a test notification email POST/v1/web-forms/{form_id}/test-submitSend a test submission through the whole pipeline POST/v1/web-forms/{form_id}/crm-linkLink a web form to a CRM lead source, or create the source for it POST/v1/web-forms/{form_id}/crm-unlinkUnlink a web form from its CRM lead source

GET/v1/web-forms

List web forms

web_forms.forms.list

LecturaIdempotenteDesde 2026-11-01

Lists the organization's web forms (HTML forms embedded on websites that email every submission and can feed the CRM), newest first, paginated by cursor (limit up to 200). enabled=true returns only published forms (accepting submissions), false only unpublished ones; the page is completed up to limit (reading up to 500 forms per call). Each row carries the notification recipients, allowed origins, anti-spam settings, CRM link, counters, created_by_name, field_count and auto_responder_enabled; the fields and the auto-responder come with web_forms.forms.get. Use web_forms.submissions.list for the responses. Requires view access to Web Forms.

Alcance: web_forms:read
Permiso: Ver el módulo
Tool del MCP: web_forms_forms_listEn la superficie completa; en la compacta, mb_execute_operation con id: "web_forms.forms.list".

Costo declarado: hasta 701 lecturas y 0 escrituras por llamada (cuentan en el cupo diario).

Parámetros

limitintegerqueryopcional

How many items this page brings at most (see the maximum and the default in the schema).

Por defecto: 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.

enabledbooleanqueryopcional

true = only published forms; false = only unpublished ones. Filtered on the page read.

Respuesta

dataarray<object>

has_moreboolean

next_cursorstring

Errores

invalid_input unknown_field authentication_required scope_insufficient module_access_denied operation_not_found rate_limited quota_exceeded

Ejemplo

curl "https://api.mb-suite.com/v1/web-forms" \
  -H "Authorization: Bearer $MB_API_KEY"

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl "https://api.mb-suite.com/v1/web-forms" \
  -H "Authorization: Bearer $MB_TEST_KEY"

GET/v1/web-forms/{form_id}

Get one web form

web_forms.forms.get

LecturaIdempotenteDesde 2026-11-01

Returns one web form: its fields (name, label, type, required, crm_template), the notification email (from_name, to_emails, subject, conditional recipient_routing), allowed_origins, the anti-spam settings (honeypot_field_name, recaptcha_enabled, rate_limits), thank_you_url, the auto-responder, the CRM link (linked_source_id), its counters (stats) and who created it (created_by_id, created_by_name). A visitor's page submits with POST https://mb-suite.com/api/v1/public/forms/submit?formId=<id> and a JSON body {"formId": <id>, "<field name>": <value>, …}, sent from one of allowed_origins. Not found (web_form_not_found) if the id does not exist in this organization. Requires view access to Web Forms.

Alcance: web_forms:read
Permiso: Ver el módulo
Tool del MCP: web_forms_forms_getEn la superficie completa; en la compacta, mb_execute_operation con id: "web_forms.forms.get".

Costo declarado: hasta 2 lecturas y 0 escrituras por llamada (cuentan en el cupo diario).

Parámetros

form_idstringrutarequerido

The form's id (from web_forms.forms.list, or the form_id that web_forms.forms.create returns).

Respuesta

idstring

org_idstring

namestring

enabledboolean

fieldsarray<object>

honeypot_field_namestring

from_namestring

to_emailsarray<string>

subjectstring

allowed_originsarray<string>

rate_limitsobject

statsobject

created_atnumber

updated_atnumber

descriptionstring

ordernumber

from_emailstring

sender_idstring | null

reply_to_fieldstring | null

recipient_routingobject | null

turnstile_enabledboolean

turnstile_site_keystring | null

recaptcha_enabledboolean

recaptcha_min_scorenumber

thank_you_urlstring

email_brandingstring

crm_enabledboolean

linked_source_idstring | null

auto_responderobject | null

created_by_idstring

created_by_namestring | null

Display name of created_by_id (null if it is not a person of the organization).

Errores

invalid_input unknown_field authentication_required scope_insufficient module_access_denied operation_not_found rate_limited quota_exceeded

Ejemplo

curl "https://api.mb-suite.com/v1/web-forms/{form_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl "https://api.mb-suite.com/v1/web-forms/{form_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"

POST/v1/web-forms

Create a web form

web_forms.forms.create

EscrituraDesde 2026-11-01

Creates a web form: name, 1 to 40 fields (name, label, type text|email|phone|textarea|number, required), the internal recipients of the notification email (to_emails, up to 10), its sender name and subject ({{field_name}} placeholders allowed), the origins allowed to submit (allowed_origins, scheme://host without path) and optionally a thank-you URL, conditional routing of recipients, an auto-responder (needs a verified Branding domain and sender), rate limits and CRM availability. It is created unpublished by default (enabled=false): publish it with web_forms.forms.publish (or create it with enabled=true) and from then on it accepts submissions at POST https://mb-suite.com/api/v1/public/forms/submit and emails each one to to_emails. reCAPTCHA is off by default through the API; turn it on only if the page sends a g-recaptcha-response token. The CRM link is made from the CRM (a lead source of type MB Suite Form) or with web_forms.forms.link_crm, which can also create that source (create_source). Errors: branding_not_verified / sender_not_found (a sender_id or auto-responder sender not usable), routing_field_reserved. Returns the new form_id and the form. Requires edit access to Web Forms.

Instrucciones para agentes

Tell the person the form_id, whether it is published (enabled) and how the page submits: POST https://mb-suite.com/api/v1/public/forms/submit?formId=<form_id> with {"formId", one key per field name}, from one of the allowed origins. Never invent recipients: use the ones the person gave.

Alcance: web_forms:write
Permiso: Editar en el módulo
Tool del MCP: web_forms_forms_createEn la superficie completa; en la compacta, mb_execute_operation con id: "web_forms.forms.create".
Eventos que puede emitir: web_forms.form.published

Costo declarado: hasta 0 lecturas y 1 escrituras por llamada (cuentan en el cupo diario).

Parámetros

namestringcuerporequerido

Internal name of the form (visitors never see it).

fieldsarray<object>cuerporequerido

The form's fields (1 to 40), in the order the page shows them.

from_namestringcuerporequerido

Sender display name of the notification email.

to_emailsarray<string (email)>cuerporequerido

Internal recipients of the notification email sent for every submission.

subjectstringcuerporequerido

Subject of the notification email; {{field_name}} is replaced by the submitted value.

allowed_originsarray<string (uri)>cuerporequerido

Origins allowed to submit (scheme://host[:port], no path), e.g. https://www.example.com.

descriptionstringcuerpoopcional

Internal description.

enabledbooleancuerpoopcional

false (default) = draft; true = published (it accepts submissions right away and each one emails to_emails). Publish later with web_forms.forms.publish.

Por defecto: false

honeypot_field_namestringcuerpoopcional

Name of the hidden anti-bot field; the page must render it empty and hidden. Keep the default unless the page already uses it.

Por defecto: "_qzt_field"

sender_idstring | nullcuerpoopcional

Id of a Branding sender (verified email domain) for the notification email; null = form@mb-suite.com.

Por defecto: null

reply_to_fieldstring | nullcuerpoopcional

Name of the email field whose value becomes the Reply-To of the notification.

Por defecto: null

recipient_routingobject | nullcuerpoopcional

Conditional recipients: a field of the form picks who gets the notification; null or absent = always to_emails.

turnstile_enabledbooleancuerpoopcional

Cloudflare Turnstile gate (needs turnstile_site_key and the widget on the page).

Por defecto: false

turnstile_site_keystring | nullcuerpoopcional

The Turnstile site key of the page.

Por defecto: null

recaptcha_enabledbooleancuerpoopcional

reCAPTCHA Enterprise gate. Turn it on only if the page sends a g-recaptcha-response token (the snippet from the screen does): with it on, submissions without a token are silently dropped.

Por defecto: false

recaptcha_min_scorenumbercuerpoopcional

Minimum reCAPTCHA score (0 to 1) to accept a submission; without it, the platform default.

thank_you_urlstringcuerpoopcional

Absolute http(s) URL the visitor is sent to after submitting; without it the page shows its inline success message.

rate_limitsobjectcuerpoopcional

Anti-abuse limits. Default: per_ip_per_minute 5, per_ip_per_hour 50, per_form_per_day 1000.

auto_responderobject | nullcuerpoopcional

The auto-reply to the visitor; null removes it.

Por defecto: null

email_brandingenumcuerpoopcional

mb_suite (default), org or none: the frame of the notification email.

Valores: mb_suite, org, none · Por defecto: "mb_suite"

crm_enabledbooleancuerpoopcional

Makes the form available as a CRM lead source (the link itself is made from the CRM or with web_forms.forms.link_crm).

Por defecto: false

Respuesta

form_idstring

formobject

Errores

invalid_input unknown_field authentication_required scope_insufficient crm_action_denied idempotency_key_reused rate_limited quota_exceeded

Ejemplo

curl -X POST "https://api.mb-suite.com/v1/web-forms" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME",
  "fields": [],
  "from_name": "FROM_NAME",
  "to_emails": [
    "ana@example.com"
  ],
  "subject": "SUBJECT",
  "allowed_origins": [
    "ALLOWED_ORIGIN"
  ]
}'

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl -X POST "https://api.mb-suite.com/v1/web-forms" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME",
  "fields": [],
  "from_name": "FROM_NAME",
  "to_emails": [
    "ana@example.com"
  ],
  "subject": "SUBJECT",
  "allowed_origins": [
    "ALLOWED_ORIGIN"
  ]
}'

PATCH/v1/web-forms/{form_id}

Update a web form

web_forms.forms.update

EscrituraDesde 2026-11-01

Updates one or more settings of a web form (updates object): name, description, enabled, fields, honeypot_field_name, from_name, sender_id, to_emails, subject, reply_to_field, recipient_routing (null removes it), allowed_origins, recaptcha_enabled, recaptcha_min_score (null = global default), thank_you_url (null removes it), rate_limits, auto_responder, email_branding, crm_enabled. Only what is sent changes; fields replaces the whole list. crm_enabled cannot be turned off while the form is linked to a CRM lead source (crm_enabled_required_while_linked: unlink it first with web_forms.forms.unlink_crm). To only publish or unpublish prefer web_forms.forms.publish / unpublish. Returns the updated form. Requires edit access to Web Forms.

Alcance: web_forms:write
Permiso: Editar en el módulo
Tool del MCP: web_forms_forms_updateEn la superficie completa; en la compacta, mb_execute_operation con id: "web_forms.forms.update".
Eventos que puede emitir: web_forms.form.published

Costo declarado: hasta 2 lecturas y 1 escrituras por llamada (cuentan en el cupo diario).

Parámetros

form_idstringrutarequerido

The form's id (from web_forms.forms.list, or the form_id that web_forms.forms.create returns).

updatesobjectcuerporequerido

The fields to change.

Respuesta

formobject

Errores

web_form_not_found invalid_input unknown_field authentication_required scope_insufficient crm_action_denied idempotency_key_reused rate_limited quota_exceeded

Ejemplo

curl -X PATCH "https://api.mb-suite.com/v1/web-forms/{form_id}" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl -X PATCH "https://api.mb-suite.com/v1/web-forms/{form_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'

POST/v1/web-forms/{form_id}/publish

Publish a web form

web_forms.forms.publish

EscrituraIdempotenteDesde 2026-11-01

Publishes a web form (enabled=true): from now on the public endpoint accepts its submissions, emails them and, when linked, sends them to the CRM. Idempotent: on a form that is already published nothing changes (changed=false). Returns the form. Requires edit access to Web Forms.

Alcance: web_forms:write
Permiso: Editar en el módulo
Tool del MCP: web_forms_forms_publishEn la superficie completa; en la compacta, mb_execute_operation con id: "web_forms.forms.publish".
Eventos que puede emitir: web_forms.form.published

Costo declarado: hasta 2 lecturas y 1 escrituras por llamada (cuentan en el cupo diario).

Parámetros

form_idstringrutarequerido

The form's id (from web_forms.forms.list, or the form_id that web_forms.forms.create returns).

Respuesta

formobject

changedboolean

Errores

web_form_not_found invalid_input unknown_field authentication_required scope_insufficient crm_action_denied idempotency_key_reused rate_limited quota_exceeded

Ejemplo

curl -X POST "https://api.mb-suite.com/v1/web-forms/{form_id}/publish" \
  -H "Authorization: Bearer $MB_API_KEY"

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl -X POST "https://api.mb-suite.com/v1/web-forms/{form_id}/publish" \
  -H "Authorization: Bearer $MB_TEST_KEY"

POST/v1/web-forms/{form_id}/unpublish

Unpublish a web form

web_forms.forms.unpublish

EscrituraIdempotenteDesde 2026-11-01

Unpublishes a web form (enabled=false): the public endpoint answers its submissions with a generic 404 and stores nothing, while the form, its responses and its CRM link are kept. Use it to pause a form instead of deleting it. Idempotent: on a form that is already unpublished nothing changes (changed=false). Requires edit access to Web Forms.

Alcance: web_forms:write
Permiso: Editar en el módulo
Tool del MCP: web_forms_forms_unpublishEn la superficie completa; en la compacta, mb_execute_operation con id: "web_forms.forms.unpublish".

Costo declarado: hasta 2 lecturas y 1 escrituras por llamada (cuentan en el cupo diario).

Parámetros

form_idstringrutarequerido

The form's id (from web_forms.forms.list, or the form_id that web_forms.forms.create returns).

Respuesta

formobject

changedboolean

Errores

web_form_not_found invalid_input unknown_field authentication_required scope_insufficient crm_action_denied idempotency_key_reused rate_limited quota_exceeded

Ejemplo

curl -X POST "https://api.mb-suite.com/v1/web-forms/{form_id}/unpublish" \
  -H "Authorization: Bearer $MB_API_KEY"

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl -X POST "https://api.mb-suite.com/v1/web-forms/{form_id}/unpublish" \
  -H "Authorization: Bearer $MB_TEST_KEY"

POST/v1/web-forms/{form_id}/duplicate

Duplicate a web form

web_forms.forms.duplicate

EscrituraDesde 2026-11-01

Copies a web form with all its settings into a new one named '<name> (copy)' (the suffix in the caller's language: '(copia)', '(copy)' or '(cópia)'), unpublished, without the CRM link (a lead source points to a single form) and with its counters at zero; responses are not copied. Returns the new form_id and the form. Requires edit access to Web Forms.

Alcance: web_forms:write
Permiso: Editar en el módulo
Tool del MCP: web_forms_forms_duplicateEn la superficie completa; en la compacta, mb_execute_operation con id: "web_forms.forms.duplicate".

Costo declarado: hasta 1 lecturas y 1 escrituras por llamada (cuentan en el cupo diario).

Parámetros

form_idstringrutarequerido

The form's id (from web_forms.forms.list, or the form_id that web_forms.forms.create returns).

Respuesta

form_idstring

formobject

Errores

web_form_not_found invalid_input unknown_field authentication_required scope_insufficient crm_action_denied idempotency_key_reused rate_limited quota_exceeded

Ejemplo

curl -X POST "https://api.mb-suite.com/v1/web-forms/{form_id}/duplicate" \
  -H "Authorization: Bearer $MB_API_KEY"

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl -X POST "https://api.mb-suite.com/v1/web-forms/{form_id}/duplicate" \
  -H "Authorization: Bearer $MB_TEST_KEY"

DELETE/v1/web-forms/{form_id}

Delete a web form and its responses

web_forms.forms.delete

IrreversibleDesde 2026-11-01

Deletes a web form together with ALL its responses, and removes its link with the CRM lead source (the source stays active; leads already created stay in the CRM). The form's configuration goes to the 30-day trash and owners and admins can restore it (it comes back unlinked from the CRM and with its counters at zero); the responses are deleted for good and do not come back: export them first with web_forms.submissions.list if they are needed. To pause a form use web_forms.forms.unpublish instead. Outside the screen it always requires a dry run (which says how many responses will be lost) and a confirm_token. Requires edit access to Web Forms.

Pide confirmación: primero dry_run: true (vista previa y confirm_token, que vale 10 minutos y una sola vez), después el mismo cuerpo con confirm_token. En unas pocas, solo con ciertos datos: la descripción dice cuándo. Por qué y cómo: Vista previa y confirmación.

Alcance: web_forms:write y «Permitir eliminar» (web_forms:delete en OAuth)
Permiso: Editar en el módulo
Tool del MCP: web_forms_forms_deleteEn la superficie completa; en la compacta, mb_execute_operation con id: "web_forms.forms.delete".

Costo declarado: hasta 503 lecturas y 503 escrituras por llamada (cuentan en el cupo diario).

Parámetros

form_idstringrutarequerido

The form's id (from web_forms.forms.list, or the form_id that web_forms.forms.create returns).

Respuesta

oktrue

submissions_deletednumber

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.

Errores

web_form_not_found delete_not_allowed confirmation_required invalid_input unknown_field authentication_required scope_insufficient crm_action_denied idempotency_key_reused rate_limited quota_exceeded

Ejemplo

curl -X DELETE "https://api.mb-suite.com/v1/web-forms/{form_id}" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

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

POST/v1/web-forms/{form_id}/test-notification

Send a test notification email

web_forms.forms.send_test_notification

EscrituraDesde 2026-11-01

Sends the form's notification email with dummy values to its configured recipients (to_emails, or the routing defaults), through Amazon SES, so the recipients and the look of the email can be checked. Stores nothing. Returns sent=false with the error (for example, no valid recipients) instead of failing; the attempt is audited either way. At most one test per form and person every 30 seconds (cooldown_active, 429). Sends a real email: run it only when the person asks to test the notification. Outside the app it always runs in two steps: dry_run=true says to whom it goes (and, for a test submission, whether it creates a CRM lead and where the auto-reply goes) with the same checks and a confirm_token (10 minutes); then call it again with the confirm_token. Requires edit access to Web Forms.

Alcance: web_forms:write
Permiso: Editar en el módulo
Tool del MCP: web_forms_forms_send_test_notificationEn la superficie completa; en la compacta, mb_execute_operation con id: "web_forms.forms.send_test_notification".

Costo declarado: hasta 1 lecturas y 0 escrituras por llamada (cuentan en el cupo diario). Toca una plataforma externa (ses): cuenta en el cupo de operaciones externas.

Parámetros

form_idstringrutarequerido

The form's id (from web_forms.forms.list, or the form_id that web_forms.forms.create returns).

Respuesta

sentboolean

message_idstring | null

errorstring | null

recipientsarray<string>

Errores

web_form_not_found confirmation_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

Ejemplo

curl -X POST "https://api.mb-suite.com/v1/web-forms/{form_id}/test-notification" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar. En la práctica esta operación no se simula (toca otra plataforma): responde 409 sandbox_external_unavailable.

POST/v1/web-forms/{form_id}/test-submit

Send a test submission through the whole pipeline

web_forms.forms.test_submit

EscrituraDesde 2026-11-01

Runs a test submission of the form with the given values ({name, value} pairs, one per field) through the real pipeline, skipping only the origin, rate-limit, honeypot and CAPTCHA checks: it validates the values against the form's fields (validation_failed with details.fields), stores a response marked as a test (origin __test__), sends the notification email to the form's recipients through Amazon SES, creates a REAL lead in the CRM when the form is linked to a lead source, and sends the auto-responder (if on) to the caller's own email with a [TEST] subject prefix. It does not fire web_forms.submission.received. At most one test per form and person every 30 seconds (cooldown_active). Returns what happened at each step. Run it only when the person asks to test the form. Outside the app it always runs in two steps: dry_run=true says to whom it goes (and, for a test submission, whether it creates a CRM lead and where the auto-reply goes) with the same checks and a confirm_token (10 minutes); then call it again with the confirm_token. Requires edit access to Web Forms.

Instrucciones para agentes

Tell the person the test response is stored marked as a test and, when lead_created is true, that a real lead was created in the CRM (they may want to delete it).

Alcance: web_forms:write
Permiso: Editar en el módulo
Tool del MCP: web_forms_forms_test_submitEn la superficie completa; en la compacta, mb_execute_operation con id: "web_forms.forms.test_submit".
Eventos que puede emitir: crm.lead.created crm.deal.created

Costo declarado: hasta 3 lecturas y 4 escrituras por llamada (cuentan en el cupo diario). Toca una plataforma externa (ses): cuenta en el cupo de operaciones externas.

Parámetros

form_idstringrutarequerido

The form's id (from web_forms.forms.list, or the form_id that web_forms.forms.create returns).

valuesarray<object>cuerporequerido

The submitted values as {name, value} pairs, one per form field, exactly as a visitor's page would send them.

Respuesta

submission_idstring

email_sentboolean

email_errorstring | null

notification_recipientsarray<string>

notification_routed_valuestring | null

auto_responder_sentboolean

auto_responder_errorstring | null

auto_responder_skip_reasonstring | null

auto_responder_recipientstring | null

lead_createdboolean

lead_idstring | null

lead_typeenum | null

Valores: deal, prospect

person_idstring | null

Errores

Ejemplo

curl -X POST "https://api.mb-suite.com/v1/web-forms/{form_id}/test-submit" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "values": [],
  "dry_run": true
}'

Probar con tu API key de prueba

POST/v1/web-forms/{form_id}/crm-link

Link a web form to a CRM lead source, or create the source for it

web_forms.forms.link_crm

EscrituraIdempotenteDesde 2026-11-01

Takes a web form to the CRM: from then on every real submission also creates a lead in the CRM with the source's destination, pipeline, field mapping and deduplication, and the form is marked available to the CRM (crm_enabled). Two ways, one per call. With source_id: links an existing lead source of type mb_suite_form that is free (crm.lead_sources.list with type mb_suite_form); both sides are written in one transaction and the source is reactivated. With create_source: true: creates a new lead source of type mb_suite_form for this form and links it in the same transaction, as CRM → Settings → Sources → MB Suite Form does; new_source sets its name (default: the form's), destination (prospect by default, or deal), pipeline and stage (validated: a deal source needs its pipeline; without a stage, its first one) and deduplication (merge by default). Every field of the form is mapped to the CRM (email, phone, name, company, website and the like to their CRM fields, the rest to custom:<field name>, so no answer is lost); labels and AI scoring are left out (AI scoring costs AI credits per lead, so it starts off): change them with crm.lead_sources.update. Creating a source needs manage_sources in the CRM (CRM admins, owners and admins). The dry run (dry_run: true) runs the same checks without writing and says what it would create or link. Errors: lead_source_not_found, lead_source_type_invalid, web_form_already_linked (the form already has a source: unlink it first with web_forms.forms.unlink_crm; its source is in details.source_id), lead_source_already_linked, and the pipeline and stage ones (pipeline_required, pipeline_not_found, pipeline_archived, stage_not_in_pipeline). Linking the source it already has changes nothing (changed false); with create_source, a second call finds the form linked (web_form_already_linked) and never creates another source. It fires no webhook event: the leads the form creates later fire crm.lead.created or crm.deal.created. Returns form_id, the source_id linked (the new one with create_source) and changed. Writes in the CRM: requires edit access to Web Forms AND to the CRM (and the crm:write scope for a credential).

Alcance: web_forms:write
Permiso: Editar en el módulo
Tool del MCP: web_forms_forms_link_crmEn la superficie completa; en la compacta, mb_execute_operation con id: "web_forms.forms.link_crm".

Costo declarado: hasta 4 lecturas y 3 escrituras por llamada (cuentan en el cupo diario).

Parámetros

form_idstringrutarequerido

The form's id (from web_forms.forms.list, or the form_id that web_forms.forms.create returns).

source_idstringcuerpoopcional

An existing CRM lead source of type mb_suite_form that is not linked to another form (crm.lead_sources.list with type mb_suite_form). Omit it to create one with create_source.

create_sourcebooleancuerpoopcional

true: creates a new CRM lead source of type mb_suite_form for this form and links it in the same step, as CRM → Settings → Sources → MB Suite Form does (its settings in new_source). Instead of source_id, never with it. Requires manage_sources in the CRM.

new_sourceobjectcuerpoopcional

Only with create_source: the new source's name, destination, pipeline and stage, and what to do with a person who already exists. Everything is optional.

Respuesta

form_idstring

The form.

source_idstring

The CRM lead source the form is linked to: the one passed, or the one created with create_source (crm.lead_sources.get).

changedboolean

false when the form was already linked to that source (nothing was written).

Errores

web_form_not_found invalid_input unknown_field authentication_required scope_insufficient crm_action_denied idempotency_key_reused rate_limited quota_exceeded

Ejemplo

curl -X POST "https://api.mb-suite.com/v1/web-forms/{form_id}/crm-link" \
  -H "Authorization: Bearer $MB_API_KEY"

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl -X POST "https://api.mb-suite.com/v1/web-forms/{form_id}/crm-link" \
  -H "Authorization: Bearer $MB_TEST_KEY"

POST/v1/web-forms/{form_id}/crm-unlink

Unlink a web form from its CRM lead source

web_forms.forms.unlink_crm

EscrituraIdempotenteDesde 2026-11-01

Removes the link between the form and its CRM lead source (both sides, in one transaction): new submissions stop creating CRM leads, while the source keeps its history and stays as it was (active or not), and leads already created are kept. Idempotent: a form without a link returns unlinked_source_id=null. Writes in the CRM: requires edit access to Web Forms AND to the CRM (and the crm:write scope for a credential).

Alcance: web_forms:write
Permiso: Editar en el módulo
Tool del MCP: web_forms_forms_unlink_crmEn la superficie completa; en la compacta, mb_execute_operation con id: "web_forms.forms.unlink_crm".

Costo declarado: hasta 3 lecturas y 2 escrituras por llamada (cuentan en el cupo diario).

Parámetros

form_idstringrutarequerido

The form's id (from web_forms.forms.list, or the form_id that web_forms.forms.create returns).

Respuesta

form_idstring

unlinked_source_idstring | null

Errores

web_form_not_found invalid_input unknown_field authentication_required scope_insufficient crm_action_denied idempotency_key_reused rate_limited quota_exceeded

Ejemplo

curl -X POST "https://api.mb-suite.com/v1/web-forms/{form_id}/crm-unlink" \
  -H "Authorization: Bearer $MB_API_KEY"

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl -X POST "https://api.mb-suite.com/v1/web-forms/{form_id}/crm-unlink" \
  -H "Authorization: Bearer $MB_TEST_KEY"