Skip to main content
POST
Send a scheduled reminder now

Authorizations

Authorization
string
header
required

A Dueflow access token: dfp_ (personal) or dfs_ (service). Permissions are the token's scopes intersected with the role ceiling, re-evaluated per request.

Headers

Idempotency-Key
string
required

A unique key per logical operation, e.g. a UUID. Retrying with the same key replays the original response instead of repeating the write; reusing it with different parameters is a 409.

Maximum string length: 255

Path Parameters

reminderId
string
required

Body

application/json

The body is of type object.

Response

Success

id
string
required
targetMemberId
string | null
required
targetOrganizationId
string | null
required
groupId
string | null
required
method
enum<string>
required
Available options:
email,
sms
status
enum<string>
required
Available options:
scheduled,
sending,
sent,
failed,
completed,
cancelled
subject
string
required
body
string
required
scheduledAt
string<date-time>
required
sentAt
string<date-time> | null
required
isRecurring
boolean
required
recurringIntervalDays
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
includePaymentInfo
boolean
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
outcome
enum<string>
required
Available options:
sent,
skipped