---
title: "Update EINs, frequency, checks, delivery, or pause"
method: PATCH
path: "/api/v1/pulse/{sub_id}"
tags: ["Pulse"]
---

# Update EINs, frequency, checks, delivery, or pause

`PATCH /api/v1/pulse/{sub_id}`

## Request

- Base URL: `https://data.useplinth.com`
- URL: `https://data.useplinth.com/api/v1/pulse/{sub_id}`
- Auth: API key in header `X-API-Key`

Any field omitted is left as it is. Changing the frequency re-anchors the next run from now; `active: false` pauses scheduled runs without deleting state, so unpausing resumes the diff rather than re-baselining.

## Path parameters

- `sub_id` string, required

## Request body

- PulsePatch
  - `eins` string[], nullable
  - `name` string, nullable
  - `frequency` string, nullable
  - `checks` string[], nullable
  - `email_to` string[], nullable
  - `email_mode` string, nullable
  - `active` boolean, nullable
  - `unsubscribe_url` string, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `401`: No API key, or a key we do not recognize.
- `402`: The call allowance is spent, the account is inactive, or the endpoint needs a paid plan — the message says which, and names the period it resets on (daily on free and non-profit plans, monthly on Pro).
- `422`: Validation Error

---

[API](https://skmtc.dev/useplinth/apis/plinth-grants-api.md) · [All operations](https://skmtc.dev/useplinth/apis/plinth-grants-api/llms.txt) · [OpenAPI document](https://skmtc.dev/useplinth/apis/plinth-grants-api/revisions/15273cd72ecf?raw)