Send a reminder

API docs

Get started

Introduction

Guides

Send from a template
Send a PDF
- With coordinates
- With markers

Reference

Endpoints

Account
- getGet the current key
Templates
- getList templates
- getGet a template
Sending
Documents
Files
OpenAPI
- getGet this API description

Documents

Send a reminder

post/documents/{id}/remind

Emails a reminder to everyone who still has to sign. Recipients with delivery: "link" get no reminders.

Needs a key with documents:send. Send no body, or an empty {}.

Path parameters

idUUIDRequired
The document ID.

Example request

curl -X POST "https://www.inkly.so/api/v1/documents/3f1c2a7e-8b4d-4e21-9a6f-5d0c7e1b2a34/remind" \
  -H "Authorization: Bearer $INKLY_API_KEY"

Example response, 200

{
  "sent_count": 1,
  "skipped_count": 0,
  "failed_count": 0
}

Response fields

sent_countnumberRequired
skipped_countnumberRequired
failed_countnumberRequired

Errors specific to this endpoint

unknown_field400This field is not supported.
sending_paused403Sending is paused for this workspace. Contact support.
document_not_found404Document not found.
reminder_cooldown409A reminder is already in progress or cooling down.
reminder_not_available409Reminders are not available for this document.
temporarily_unavailable503The service is temporarily unavailable. Try again.

Every endpoint can also return the common errors.