Update a sweep config | Moov Documentation

Update a sweep config

Update settings on a sweep config.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/wallets.write scope.

PATCH

/accounts/{accountID}/sweep-configs/{sweepConfigID}

Ask

curl -X PATCH "https://api.moov.io/accounts/{accountID}/sweep-configs/{sweepConfigID}" \
  -H "Authorization: Bearer {token}" \
  -H "X-Moov-Version: v2026.07.00" \
  -d '{
  "status": "disabled"
}'

Ask

mc, _ := moov.NewClient()

var accountID string
var sweepConfigID string

sweepConfig, _ := mc.GetSweepConfig(ctx, accountID, sweepConfigID)
statementDesc := "my-sweep"
mc.UpdateSweepConfig(ctx, moov.UpdateSweepConfig{
  AccountID:           "string",
  SweepConfigID:       sweepConfig.SweepConfigID,
  StatementDescriptor: &statementDesc,
})

Ask

import { Moov } from "@moovio/sdk";

const moov = new Moov({
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.sweeps.updateConfig({
    accountID: "c16d0264-3e93-4d13-b8d8-6e8e98122631",
    sweepConfigID: "f7943244-882b-4a3a-837a-a58418358399",
    patchSweepConfig: {
      status: "disabled",
    },
  });

console.log(result);
}

run();

Ask

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\