Replace contacts and/or reminder schedules on many expiries

posthttps://api.expiryedge.com/v1/bulkUpdateNotificationSettings
editor or admin60/minJede Methode
Anfrage
curl -X POST 'https://api.expiryedge.com/v1/bulkUpdateNotificationSettings' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "expiryIds": [
    "exp_4Tq9sLm2",
    "exp_7Hn2kPq9"
  ],
  "updateContacts": true,
  "contactIds": [
    "c_8Hk2pQ",
    "c_3Rt7wX"
  ],
  "updateReminders": true,
  "reminders": [
    {
      "amount": 30,
      "time_unit": "day",
      "period": "before",
      "time": "09:00",
      "email": true,
      "sms": false,
      "whatsapp": false
    }
  ],
  "orgTimezone": "America/Chicago"
}'
Antwort
{
  "success": true,
  "updated_count": 2
}

With updateContacts, each expiry's contacts is replaced by contactIds (ids outside your organization are dropped; max 500). With updateReminders, each expiry's reminders are deleted and recreated from reminders (max 20). Processed in chunks of 400 ids.

Body-Parameter

application/json
  • expiryIdsarray of stringerforderlich
    min items: 1
  • updateContactsboolean
    At least one of updateContacts / updateReminders must be true.
  • contactIdsarray of string
    max items: 500
  • updateRemindersboolean
  • remindersarray of objects
    max items: 20
  • orgTimezonestring
    IANA timezone used when a reminder has no timezone. Defaults to UTC.

Rückgabe

200
Result per batch.
  • successbooleanerforderlich
  • updated_countintegererforderlich
  • errorsarray of objects
    Omitted when every id was processed.

Fehler

400
The request is missing required fields or contains invalid values.
401
Missing, expired or invalid bearer token.
403
Authenticated, but your role or organization does not allow this action.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
Unexpected server error. Retry later; quote requestId to support.