---
title: "Update a repeating send"
method: PATCH
path: "/repeating-sends/{id}"
tags: ["Repeating Sends"]
---

# Update a repeating send

`PATCH /repeating-sends/{id}`

## Request

- Base URL: `https://api.primitive.dev/v1`
- URL: `https://api.primitive.dev/v1/repeating-sends/{id}`
- Auth: HTTP bearer

Pause, resume or cancel a repeat, or change its cadence, limits,
message or whether the recipient may stop it. `active` resumes a paused
repeat or one the recipient stopped; the next message goes out within
about a minute. A null `only_if_recipient_idle_minutes`, `max_sends`
or `until` clears that limit.

## Request body

- UpdateRepeatingSendRequest
  - `status` 'active' | 'paused' | 'canceled'
  - `every_minutes` integer
  - `only_if_recipient_idle_minutes` integer, nullable
  - `stoppable_by_recipient` boolean
  - `max_sends` integer, nullable
  - `until` string, date-time, nullable
  - `body_text` string
  - `subject` string

## Response `200`

The updated repeating send

- object
  - `success` true, required
  - `data` RepeatingSend, required
    - `id` string, uuid, required
    - `org_id` string, uuid, required
    - `from_address` string, required
    - `to_address` string, required
    - `subject` string, required
    - `body_text` string, nullable, required
    - `body_html` string, nullable, required
    - `every_minutes` integer, required
    - `only_if_recipient_idle_minutes` integer, nullable, required
    - `stoppable_by_recipient` boolean, required
    - `max_sends` integer, nullable, required
    - `until` string, date-time, nullable, required
    - `status` 'active' | 'paused' | 'stopped_by_recipient' | 'canceled' | 'completed', required
    - `next_run_at` string, date-time, nullable, required
    - `sent_count` integer, required
    - `last_sent_at` string, date-time, nullable, required
    - `last_sent_email_id` string, uuid, nullable, required
    - `root_message_id` string, nullable, required
    - `stopped_at` string, date-time, nullable, required
    - `stop_reason` string, nullable, required: Reason the recipient gave when it stopped the repeat. Recipient-written, untrusted text.
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `400`: Invalid request parameters
- `401`: Invalid or missing API key
- `404`: Resource not found

## Changes

> 32 revisions in range; 1 not diffed.

- **2026-10-21** `0360ea8d4f3d`: 39 warning
  - added the new `agent_changed` enum value to the `error/code` response property for the response status `400`
  - added the new `agent_changed` enum value to the `error/code` response property for the response status `401`
  - added the new `agent_changed` enum value to the `error/code` response property for the response status `404`
  - added the new `agent_limit` enum value to the `error/code` response property for the response status `400`
  - …35 more
- **2026-10-21** `5279a7bed7ac`: 33 warning
  - added the new `archive_busy` enum value to the `error/code` response property for the response status `400`
  - added the new `archive_busy` enum value to the `error/code` response property for the response status `401`
  - added the new `archive_busy` enum value to the `error/code` response property for the response status `404`
  - added the new `archive_invalid` enum value to the `error/code` response property for the response status `400`
  - …29 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/primitive/apis/primitive-api/changes/repeating-sends/:id/patch.md)

---

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