---
title: "Create Invoice/Estimate Reminder"
method: POST
path: "/invoice_estimate/reminder"
---

# Create Invoice/Estimate Reminder

`POST /invoice_estimate/reminder`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/invoice_estimate/reminder`
- Auth: API key in header `x-api-key`

Creates a configurable payment/due-date reminder rule, shared infrastructure for both Invoice and Estimate modules via the `type` field. Admin/TL only. date_type is cross-validated against type (INVOICE allows INVOICE_DATE/DUE_DATE; ESTIMATE allows ESTIMATE_DATE/EXPIRY_DATE/SENT_DATE) — defaults to DUE_DATE for INVOICE or EXPIRY_DATE for ESTIMATE if omitted.

## Request body

- object
  - `reminder` object, required
    - `reminder_type` 'EMAIL' | 'SMS', required
    - `type` 'INVOICE' | 'ESTIMATE', required
    - `reminder_to` 'SELECTED_USERS' | 'SELECTED_TEAMS' | 'CUSTOMER', required
    - `send_to_users` string[]: Required when reminder_to is SELECTED_USERS.
    - `send_to_teams` string[]: Required when reminder_to is SELECTED_TEAMS.
    - `date_type` 'INVOICE_DATE' | 'DUE_DATE' | 'ESTIMATE_DATE' | 'EXPIRY_DATE' | 'SENT_DATE'
    - `remind_before` number, required
    - `reminder_name` string, required
    - `send_at` string: Time of day to send.
    - `sms_body` string: Required when reminder_type is SMS.
    - `email_subject` string: Required when reminder_type is EMAIL.
    - `email_body` string: Required when reminder_type is EMAIL.
    - `additional_email_recipients` object[]
      - `type` 'CC' | 'BCC'
      - `email` string
    - `email_attachment_template` string: A template_uid from the shared Invoice/Estimate Templates module.
    - `email_config_uid` string

## Response `200`

200

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/invoice_estimate/reminder/post.md)

---

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