A sincronização automática pode executar 1, 2 ou 3 vezes ao dia, com horários distribuídos a cada 24, 12 ou 8 horas. Você pode configurar o padrão da aplicação ou ajustar um item individualmente. Use a API key da aplicação no header X-API-KEY.

​
Definir 3 sincronizações por dia como padrão

Esse comando define o padrão para novos itens, inclusive os criados pelo Connect Widget e por POST /items, e atualiza todos os itens existentes da mesma aplicação. applied informa quantos itens existentes receberam a configuração. A alteração é atômica: em caso de erro na atualização, o padrão e os itens permanecem como estavam. Outras aplicações do mesmo time não são alteradas. Para alterar apenas o padrão dos próximos itens, envie "applyToExistingItems": false:
Consulte o padrão atual com GET /auto-sync/defaults. Sem configuração explícita, o padrão inicial é a sincronização habilitada uma vez por dia.

​
Configurar um item específico

Use GET /items/{id}/auto-sync para consultar a configuração e o próximo horário. O horário retornado usa UTC. Converta para America/Sao_Paulo ao exibi-lo no Brasil. Campos omitidos mantêm o valor atual. Para desligar o agendamento, envie {"autoSyncEnabled":false}; a frequência fica preservada e nextAutoSyncAt passa a null. Para reativar, envie {"autoSyncEnabled":true}.
Alterar a frequência não dispara uma sincronização imediata. A primeira execução aguarda o próximo horário e um consentimento válido. Itens que aguardam autorização recebem a configuração, mas ficam com nextAutoSyncAt: null até estarem aptos. Os limites e a disponibilidade de cada instituição continuam valendo.

​
Configurar pelo painel

Selecione a aplicação e acesse Syncer → Itens monitorados → Aplicar a todos. Escolha 3x ao dia e clique em Aplicar. Isso atualiza os itens existentes e salva o padrão dos próximos. O seletor na linha de um item altera apenas aquele item.

​
Validação e autenticação

  • autoSyncFrequency aceita somente os números inteiros 1, 2 e 3.
  • Envie pelo menos autoSyncEnabled ou autoSyncFrequency em cada PATCH.
  • Esses endpoints exigem API key; tokens do Connect Widget não podem usá-los.
  • Um item de outra aplicação retorna 404 ITEM_NOT_FOUND.
  • Aplicações com atualizações bloqueadas retornam 409 CLIENT_HAS_ITEM_UPDATES_DISABLED ao tentar habilitar ou alterar a frequência sem desativar a sincronização.
O endpoint PATCH /items/{id} continua sendo usado para atualizar ou renovar a conexão. Configure o agendamento nos endpoints /auto-sync descritos acima. Para uma atualização pontual, use POST /items/{id}/refresh. Acompanhe os resultados pelos webhooks e consulte os limites de atualização.