---
title: "Update rules / enable / disable"
method: PATCH
path: "/v1/routes/{routeId}"
tags: ["routes"]
---

# Update rules / enable / disable

`PATCH /v1/routes/{routeId}`

## Request

- Base URL: `https://postbag.dev`
- URL: `https://postbag.dev/v1/routes/{routeId}`
- Auth: HTTP bearer

## Path parameters

- `routeId` string, required

## Request body

- object
  - `enabled` boolean: Disable a route without deleting it.
  - `mode` union: instant delivers as submissions arrive; digest batches into one payload per period.
    - object
      - `type` 'instant', required
    - object
      - `type` 'digest', required
      - `cron` string, required: Cron expression for digest mode, e.g. '0 9 * * *'.
      - `timezone` string, required: IANA timezone the cron runs in.
  - `window` object: Only deliver submissions received in this ISO datetime range.
    - `from` string, date-time, nullable
    - `until` string, date-time, nullable
  - `quality` object: Defaults to excluding spam and quarantined submissions from delivery.
    - `exclude_spam` boolean
    - `exclude_quarantined` boolean
  - `filter` string: A JSONata boolean expression; only matching submissions are delivered.
  - `transform` string: A JSONata expression applied to the payload before delivery.

## Response `200`

ok

- Route
  - `id` string, required
  - `form_id` string, nullable, required
  - `stream_id` string, nullable, required
  - `destination_id` string, required
  - `enabled` boolean, required
  - `mode` object, required
  - `window` object
  - `quality` object
  - `filter` string, nullable
  - `transform` string, nullable
  - `counts` object
  - `created_at` string

## Other responses

- `400`: Error
- `401`: Error
- `403`: Error
- `404`: Not found
- `409`: Error
- `422`: Error

---

[API](https://skmtc.dev/postbag/apis/postbag-api.md) · [All operations](https://skmtc.dev/postbag/apis/postbag-api/llms.txt) · [OpenAPI document](https://skmtc.dev/postbag/apis/postbag-api/revisions/3da976524695?raw)