Add reminders to an expiry

Vorschau
posthttps://api.expiryedge.com/v2/expiries/{id}/reminders
editor or admin60/minIdempotency-Key
Anfrage
curl -X POST 'https://api.expiryedge.com/v2/expiries/exp_4Tq9sLm2/reminders' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "reminders": [
    {
      "amount": 30,
      "time_unit": "day",
      "period": "before",
      "time": "09:00"
    },
    {
      "amount": 7,
      "time_unit": "day",
      "period": "before",
      "time": "09:00",
      "sms_enabled": false
    }
  ]
}'
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
    }
  ]
}

Adds 1-20 reminders, scheduled from the expiry's stored expiry_date (an expiry without one is 400). time is in timezone (default: the organization's timezone, else UTC). Returns 201 with the created reminders as { data } and Location: /v2/expiries/{id}/reminders.

Pfadparameter

  • idstringerforderlich

Header

  • Idempotency-Keystring
    Optional client-generated key (1-255 characters of letters, digits, - _ : .).
    pattern: ^[A-Za-z0-9_\-:.]{1,255}$

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

201
Created.
  • dataarray of objects

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.
409
State or uniqueness conflict: EMAIL_EXISTS (contacts), GROUP_EXISTS (contact groups), CONFLICT (folder name taken), FOLDER_NOT_EMPTY, CLIENT_HAS_PROJECTS, TOO_MANY_ATTACHMENTS, INVALID_STATE (collection request cancel/resend), or IDEMPOTENCY_IN_PROGRESS (same Idempotency-Key still running; see Retry-After).
422
The Idempotency-Key was already used with a different body (IDEMPOTENCY_KEY_REUSED).
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.