Menu

Referência da API · CRM

Horários de sequências

crm · sequence_schedules · 4 operações

GET/v1/crm/sequence-schedules

List the sending schedules of sequences

crm.sequences.schedules.list

LeituraIdempotenteDesde 2026-11-01

Lists the organization's sending schedules for sequences, the default first and then by name: the IANA time zone and, for each weekday, whether it sends and between which hours (HH:mm), with who created it (created_by_id, created_by_name). A sequence with a schedule_id only sends inside those windows; without one it sends at any time. 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_schedules_listNa superfície completa; na compacta, mb_execute_operation com id: "crm.sequences.schedules.list".

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

Resposta

dataarray<object>
has_moreboolean
next_cursorstring

Erros

Exemplo

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

Create a sending schedule for sequences

crm.sequences.schedules.create

EscritaDesde 2026-11-01

Creates a sending schedule for sequences: a name, an IANA time zone (America/Argentina/Buenos_Aires…; an unknown zone is invalid_input) and optionally the 7 weekday windows (day, enabled, start_time and end_time as HH:mm; without them, Monday to Friday 09:00–18:00). is_default true makes it the organization's default and unsets the previous one. It is not assigned to any sequence: set schedule_id with crm.sequences.update. Returns schedule_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_schedules_createNa superfície completa; na compacta, mb_execute_operation com id: "crm.sequences.schedules.create".

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

Parâmetros

namestringcorpoobrigatório

The name the sequence settings show.

timezonestringcorpoobrigatório

An IANA time zone (America/Argentina/Buenos_Aires, America/Mexico_City, UTC): the windows are read in it.

windowsarray<object>corpoopcional

Exactly 7 windows, one per day (monday to sunday): day, enabled, start_time and end_time as HH:mm. Without them, Monday to Friday 9:00 to 18:00.

is_defaultbooleancorpoopcional

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

Resposta

schedule_idstring

Erros

Exemplo

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

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

Update a sending schedule

crm.sequences.schedules.update

EscritaIdempotenteDesde 2026-11-01

Updates a sending schedule; send at least one key in updates (name, timezone, windows with the 7 weekdays, is_default). Every sequence that uses it sends inside the new windows from the engine's next run. is_default true moves the default here. Not found (sequence_schedule_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_schedules_updateNa superfície completa; na compacta, mb_execute_operation com id: "crm.sequences.schedules.update".

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

Parâmetros

schedule_idstringrotaobrigatório

The sending schedule: an id from crm.sequences.schedules.list.

updatesobjectcorpoobrigatório

What changes (at least one key): name, timezone, windows (the 7 days, replaced as a whole), is_default.

Resposta

oktrue

Erros

Exemplo

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

Delete a sending schedule

crm.sequences.schedules.delete

IrreversívelDesde 2026-11-01

Deletes a sending schedule; the sequences that used it are left without a schedule and send at any time (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_schedule_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_schedules_deleteNa superfície completa; na compacta, mb_execute_operation com id: "crm.sequences.schedules.delete".

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

Parâmetros

schedule_idstringrotaobrigatório

The sending schedule: an id from crm.sequences.schedules.list.

Resposta

detached_from_sequencesnumber

Erros

Exemplo

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