Skip to main content

Reminders in Agreements

Trigger reminders manually to notify participants who haven’t yet signed or approved an agreement.


Understanding Reminders​

In addition to automatic reminders, Zigned supports sending manual reminders via API. This gives you full control to nudge participants as needed — whether individually or all at once.

Reminders are sent through a dedicated endpoint under the agreement resource. Depending on the request, you can remind a specific participant or all relevant participants still awaiting action.


How It Works​

  • No participant ID provided:
    Sends reminders to all participants who should act:

    • If signing order is enforced, only the next signer(s) or approver(s) in line will be reminded.
    • If no signing order, all participants who haven’t signed or approved will receive a reminder.

  • Participant ID provided:
    A reminder will be queued for the specified participant — but it will only be sent if the participant is eligible (e.g. not already completed, and it's their turn if signing order is enforced).
    If the reminder isn't sent, the API still returns a success response as long as the request is valid.


Usage​

To trigger reminders, make a POST request to the endpoint:

POST /agreements/[agreement_id]/reminders
{}

POST /agreements/[agreement_id]/reminders
{
  "participant_id": "[participant_id]"
}

Delivery and Logging​

If a reminder succeeds or fails to deliver, it will:

  • Trigger a webhook event (can vary depending on the participant role and result)
  • Be logged in the agreement’s event log You can learn more in the Agreement Events Overview.