Replace an expiry's reminders

Vorschau
patchhttps://api.expiryedge.com/v2/expiries/{id}/reminders
editor or admin60/min
Anfrage
curl -X PATCH 'https://api.expiryedge.com/v2/expiries/exp_4Tq9sLm2/reminders' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reminders": [
    {
      "id": "rem_7Jd2",
      "amount": 14,
      "time_unit": "day",
      "period": "before"
    },
    {
      "amount": 1,
      "time_unit": "day",
      "period": "after"
    }
  ]
}'
Antwort
{
  "data": [
    {
      "id": "rem_7Jd2",
      "expiry_id": "exp_4Tq9sLm2",
      "organization_id": "org_northwind",
      "amount": 30,
      "time_unit": "day",
      "period": "before",
      "time": "09:00",
      "timezone": "America/New_York",
      "reminder_date": "2026-09-15T00:00:00.000Z",
      "scheduled_at": "2026-09-15T13:00:00.000Z",
      "email_enabled": true,
      "sms_enabled": true,
      "whatsapp_enabled": true,
      "status": "pending",
      "sent_at": null
    }
  ],
  "next_cursor": "string",
  "has_more": true
}

Replaces the whole set with 1-20 reminders: an item with id updates that reminder, an item without one reuses a reminder with the same amount/time_unit/period or is created, and reminders not listed are deleted. A reminder moved into the future is re-armed (status: pending). Returns the full set. Use DELETE to remove all.

Pfadparameter

  • idstringerforderlich

Body-Parameter

application/json
  • remindersarray of objectserforderlich
    min items: 1 · max items: 20
  • timezonestring
    IANA timezone; default the organization's timezone, else UTC.

Rückgabe

200
The reminder set after the change.
  • dataarray of objectserforderlich
  • next_cursorstring | nullerforderlich
  • has_morebooleanerforderlich

Fehler

400
Invalid parameters or body (VALIDATION_FAILED; details names the fields).
401
Missing, invalid or expired token (UNAUTHORIZED).
403
Your role can't do this, or your account has no organization (FORBIDDEN).
404
No such record in your organization (records in other organizations are also 404).
405
Wrong HTTP method for this path; the Allow header lists the valid ones.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.