---
title: "Update a payment reminder"
method: PATCH
path: "/api/v2/payment_reminders/{id}"
tags: ["Payment reminders"]
---

# Update a payment reminder

`PATCH /api/v2/payment_reminders/{id}`

## Request

- Base URL: `https://developer.productive.io` (the document declares no server; this is the origin it was published from)
- URL: `https://developer.productive.io/api/v2/payment_reminders/{id}`
- Auth: none declared

## Path parameters

- `id` string, required

## Request body

- object
  - `data` object
    - `attributes` object
      - `bcc` Bcc (unresolved $ref)
      - `before_due_date` BeforeDueDate (unresolved $ref)
      - `body` Body (unresolved $ref)
      - `cc` Cc (unresolved $ref)
      - `delivered_at` DeliveredAt (unresolved $ref)
      - `failed_at` FailedAt (unresolved $ref)
      - `from` From (unresolved $ref)
      - `invoice_id` InvoiceId (unresolved $ref)
      - `payment_reminder_sequence_id` PaymentReminderSequenceId (unresolved $ref)
      - `reminder_period` ReminderPeriod (unresolved $ref)
      - `scheduled_on` ScheduledOn (unresolved $ref)
      - `sent_at` SentAt (unresolved $ref)
      - `subject` Subject (unresolved $ref)
      - `to` To (unresolved $ref)

## Response `200`

Single payment reminder

- object
  - `data` object
    - `attributes` object
      - `bcc` Bcc (unresolved $ref)
      - `before_due_date` BeforeDueDate (unresolved $ref)
      - `body` Body (unresolved $ref)
      - `body_parsed` BodyParsed (unresolved $ref)
      - `cc` Cc (unresolved $ref)
      - `created_at` CreatedAt (unresolved $ref)
      - `deleted_at` DeletedAt (unresolved $ref)
      - `delivered_at` DeliveredAt (unresolved $ref)
      - `failed_at` FailedAt (unresolved $ref)
      - `from` From (unresolved $ref)
      - `reminder_period` ReminderPeriod (unresolved $ref)
      - `reminder_stopped_reason_id` ReminderStoppedReasonId (unresolved $ref)
      - `scheduled_on` ScheduledOn (unresolved $ref)
      - `sent_at` SentAt (unresolved $ref)
      - `stopped_at` StoppedAt (unresolved $ref)
      - `subject` Subject (unresolved $ref)
      - `subject_parsed` SubjectParsed (unresolved $ref)
      - `to` To (unresolved $ref)
      - `updated_at` UpdatedAt (unresolved $ref)
    - `relationships` object
      - `creator` union: A JSON:API single relationship — links to one related resource or `null`.
        - SingleLinkageNullable
          - `data` Resource, required: A JSON:API resource identifier object containing the resource type and ID.
            - `id` string, required: The unique identifier of the resource.
            - `type` string, required: The resource type name (e.g. `tasks`, `people`, `deals`).
        - NotIncluded: Placeholder for a relationship that was not sideloaded in this response.
          - `meta` object, required: Metadata indicating the sideload status of this relationship.
            - `included` false, required: Whether the related resource was included in the sideloaded data. Always `false` for this variant.
      - `invoice` union: A JSON:API single relationship — links to one related resource or `null`.
        - SingleLinkageNullable
          - `data` Resource, required: A JSON:API resource identifier object containing the resource type and ID.
            - `id` string, required: The unique identifier of the resource.
            - `type` string, required: The resource type name (e.g. `tasks`, `people`, `deals`).
        - NotIncluded: Placeholder for a relationship that was not sideloaded in this response.
          - `meta` object, required: Metadata indicating the sideload status of this relationship.
            - `included` false, required: Whether the related resource was included in the sideloaded data. Always `false` for this variant.
      - `organization` union: A JSON:API single relationship — links to one related resource or `null`.
        - SingleLinkageNullable
          - `data` Resource, required: A JSON:API resource identifier object containing the resource type and ID.
            - `id` string, required: The unique identifier of the resource.
            - `type` string, required: The resource type name (e.g. `tasks`, `people`, `deals`).
        - NotIncluded: Placeholder for a relationship that was not sideloaded in this response.
          - `meta` object, required: Metadata indicating the sideload status of this relationship.
            - `included` false, required: Whether the related resource was included in the sideloaded data. Always `false` for this variant.
      - `payment_reminder_sequence` union: A JSON:API single relationship — links to one related resource or `null`.
        - SingleLinkageNullable
          - `data` Resource, required: A JSON:API resource identifier object containing the resource type and ID.
            - `id` string, required: The unique identifier of the resource.
            - `type` string, required: The resource type name (e.g. `tasks`, `people`, `deals`).
        - NotIncluded: Placeholder for a relationship that was not sideloaded in this response.
          - `meta` object, required: Metadata indicating the sideload status of this relationship.
            - `included` false, required: Whether the related resource was included in the sideloaded data. Always `false` for this variant.
      - `updater` union: A JSON:API single relationship — links to one related resource or `null`.
        - SingleLinkageNullable
          - `data` Resource, required: A JSON:API resource identifier object containing the resource type and ID.
            - `id` string, required: The unique identifier of the resource.
            - `type` string, required: The resource type name (e.g. `tasks`, `people`, `deals`).
        - NotIncluded: Placeholder for a relationship that was not sideloaded in this response.
          - `meta` object, required: Metadata indicating the sideload status of this relationship.
            - `included` false, required: Whether the related resource was included in the sideloaded data. Always `false` for this variant.
  - `included` unknown[]
    - unknown
  - `meta` Meta: Pagination and response metadata returned with every collection endpoint.
    - `current_page` integer: The current page number in this paginated response (1-based).
    - `max_page_size` integer: Maximum number of records allowed per page for this endpoint.
    - `organization_features` object: Feature flags and capabilities enabled for the current organization, used for UI rendering.
    - `page_size` integer: Number of records returned per page in this response.
    - `settings` object: Organization or user settings relevant to this resource's display.
    - `total_count` integer: Total number of records matching the current query across all pages.
    - `total_pages` integer: Total number of pages available for the current query and page size.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `406`: Not Acceptable
- `408`: Request Timeout
- `415`: Unsupported Media Type
- `422`: Unprocessable Content
- `423`: Locked
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

- **2026-11-02** `fa3060fd0144`: 3 warning, 9 info
  - added the new `bad_decimal_format` enum value to the `errors/items/code` response property for the response status `422`
  - added the new `non_finite_number` enum value to the `errors/items/code` response property for the response status `422`
  - added the new `null_bytes_in_params` enum value to the `errors/items/code` response property for the response status `422`
  - added the non-success response with the status `400`
  - …8 more
- **2026-10-27** `f11a8740641a`: 1 info
  - endpoint added
  - …this revision’s changelog is incomplete

[Operation history](https://skmtc.dev/productive/apis/api-documentation/changes/api/v2/payment_reminders/:id/patch.md)

---

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