Menú

Referencia de la API · CRM

Reglas de envío de secuencias

crm · sequence_rulesets · 4 operaciones

GET/v1/crm/sequence-rulesets

List the sending rules of sequences

crm.sequences.rulesets.list

LecturaIdempotenteDesde 2026-11-01

Lists the organization's sending rules for sequences, the default first and then by name: what pauses or finishes a contact (triggers: account_reply_delay and a phone call after repeated opens; contact_triggers: finish on link click, mark unresponsive after N days), emails skipped by contact or account labels (email_triggers), and throttling (the CC and BCC addresses copied on every sequence email, ignore_bounce_protection), with who created them (created_by_id, created_by_name). A reply, an unsubscribe and a bounce always finish the contact, whatever the rules say. The sending pace is set by the schedules (crm.sequences.schedules.list). A sequence uses one through its ruleset_id; new sequences get the default. Paginated by cursor (limit up to 100, the default). Requires view access to the CRM.

Alcance
crm:read
Permiso
Ver el módulo
Tool del MCP
crm_sequences_rulesets_listEn la superficie completa; en la compacta, mb_execute_operation con id: "crm.sequences.rulesets.list".

Costo declarado: hasta 101 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: 100

cursorstringqueryopcional

The next_cursor of the previous page, exactly as it came (only for the same list and filters); without it, the first page.

Respuesta

dataarray<object>
has_moreboolean
next_cursorstring

Errores

Ejemplo

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

Create sending rules for sequences

crm.sequences.rulesets.create

EscrituraDesde 2026-11-01

Creates sending rules for sequences: a name and, optionally, triggers, contact_triggers, email_triggers and throttling (each group left out takes the standard set: pause 24 h after an account reply, mark unresponsive after 30 days, no CC or BCC, bounce protection on). is_default true makes them the organization's default (new sequences get them) and unsets the previous default. It is not assigned to any sequence: set ruleset_id with crm.sequences.update. Returns ruleset_id. Manager-tier only (manage_sequence_settings: owner, admin, crm_admin or sales_manager).

Alcance
crm:write
Permiso
Editar en el módulo · Acción del CRM: manage_sequence_settings
Tool del MCP
crm_sequences_rulesets_createEn la superficie completa; en la compacta, mb_execute_operation con id: "crm.sequences.rulesets.create".

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

Parámetros

namestringcuerporequerido

The name the sequence settings show.

is_defaultbooleancuerpoopcional

Make it the organization's default (new sequences take it; the previous default stops being one).

triggersobjectcuerpoopcional

When the account replies: account_reply_delay (none, pause_24h, pause_until_next_business_day or finish), and a phone call task after repeated opens (phone_call_on_repeated_opens: enabled, opens_threshold).

contact_triggersobjectcuerpoopcional

finish_on_link_click (the contact leaves after clicking a link) and mark_unresponsive_after_days (enabled, days: the contact leaves as unresponsive after that many days without a reply).

email_triggersobjectcuerpoopcional

Emails are skipped for contacts (skip_email_when_contact_label_in) or accounts (skip_email_when_account_label_in) with any of these labels: ids from crm.labels.list.

throttlingobjectcuerpoopcional

cc_all_emails_to and bcc_all_emails_to (addresses copied on every email of the sequences that use these rules) and ignore_bounce_protection (true keeps sending after a bounce). The sending pace is set by the schedules (crm.sequences.schedules.*).

Respuesta

ruleset_idstring

Errores

Ejemplo

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

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

Update sending rules

crm.sequences.rulesets.update

EscrituraIdempotenteDesde 2026-11-01

Updates sending rules; send at least one key in updates (name, is_default, triggers, contact_triggers, email_triggers, throttling: each group replaces the whole group). Every sequence that uses them follows the new rules from its next send. Changing the CC/BCC addresses or the bounce protection is also recorded as a security event. is_default true moves the default here. Not found (sequence_ruleset_not_found) if the id does not exist. Manager-tier only (manage_sequence_settings).

Alcance
crm:write
Permiso
Editar en el módulo · Acción del CRM: manage_sequence_settings
Tool del MCP
crm_sequences_rulesets_updateEn la superficie completa; en la compacta, mb_execute_operation con id: "crm.sequences.rulesets.update".

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

Parámetros

ruleset_idstringrutarequerido

The sending rules: an id from crm.sequences.rulesets.list.

updatesobjectcuerporequerido

What changes (at least one key): name, is_default, triggers, contact_triggers, email_triggers, throttling; each object sent replaces that whole part.

Respuesta

oktrue

Errores

Ejemplo

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

Delete sending rules

crm.sequences.rulesets.delete

IrreversibleDesde 2026-11-01

Deletes sending rules; the sequences that used them are left without sending rules (the result says how many). It does not go to the trash. Outside the screen it requires a dry run (which lists the affected sequences) and a confirm_token, and a credential that allows deleting. Not found (sequence_ruleset_not_found) if the id does not exist. Manager-tier only (manage_sequence_settings).

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
crm:write y «Permitir eliminar» (crm:delete en OAuth)
Permiso
Editar en el módulo · Acción del CRM: manage_sequence_settings
Tool del MCP
crm_sequences_rulesets_deleteEn la superficie completa; en la compacta, mb_execute_operation con id: "crm.sequences.rulesets.delete".

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

Parámetros

ruleset_idstringrutarequerido

The sending rules: an id from crm.sequences.rulesets.list.

Respuesta

detached_from_sequencesnumber

Errores

Ejemplo

curl -X DELETE "https://api.mb-suite.com/v1/crm/sequence-rulesets/{ruleset_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/crm/sequence-rulesets/{ruleset_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'