Regras de envio de sequências

List the sending rules of sequences

crm.sequences.rulesets.list

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.

Escopo

crm:read

Permissão

Ver o módulo

Tool do MCP

crm_sequences_rulesets_listNa superfície completa; na compacta, mb_execute_operation com id: "crm.sequences.rulesets.list".

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

Parâmetros

Resposta

Erros

Exemplo

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

Create sending rules for sequences

crm.sequences.rulesets.create

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).

Escopo

crm:write

Permissão

Editar no módulo · Ação do CRM: manage_sequence_settings

Tool do MCP

crm_sequences_rulesets_createNa superfície completa; na compacta, mb_execute_operation com id: "crm.sequences.rulesets.create".

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

Parâmetros

Resposta

Erros

Exemplo

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"
}'

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

Update sending rules

crm.sequences.rulesets.update

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).

Escopo

crm:write

Permissão

Editar no módulo · Ação do CRM: manage_sequence_settings

Tool do MCP

crm_sequences_rulesets_updateNa superfície completa; na compacta, mb_execute_operation com id: "crm.sequences.rulesets.update".

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

Parâmetros

Resposta

Erros

Exemplo

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": {}
}'

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/crm/sequence-rulesets/{ruleset_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'

Delete sending rules

crm.sequences.rulesets.delete

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).

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

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

Permissão

Editar no módulo · Ação do CRM: manage_sequence_settings

Tool do MCP

crm_sequences_rulesets_deleteNa superfície completa; na compacta, mb_execute_operation com id: "crm.sequences.rulesets.delete".

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

Parâmetros

Resposta

Erros

Exemplo

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
}'

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/crm/sequence-rulesets/{ruleset_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'