Mark many expiries done

posthttps://api.expiryedge.com/v1/bulkMarkExpiriesDone
editor or admin60/minJede Methode
Anfrage
curl -X POST 'https://api.expiryedge.com/v1/bulkMarkExpiriesDone' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "expiryIds": [
    "exp_4Tq9sLm2",
    "exp_7Hn2kPq9"
  ],
  "closingNotes": "Renewed for 2027.",
  "checklistCompletedById": {
    "exp_4Tq9sLm2": [
      "chk_submit_form",
      "chk_pay_fee"
    ]
  }
}'
Antwort
{
  "success": true,
  "completed_count": 1,
  "completed_items": [
    {
      "id": "exp_4Tq9sLm2",
      "name": "Northwind Dental - State Dental License"
    }
  ],
  "errors": [
    {
      "id": "exp_7Hn2kPq9",
      "error": "Required checklist items must be completed",
      "missing_required": [
        "chk_upload_certificate"
      ]
    }
  ]
}

Fires on_done workflows and creates next occurrences for recurring items. Items with incomplete required checklist items are reported in errors (with missing_required). Keep batches at or below 500 ids.

Body-Parameter

application/json
  • expiryIdsarray of stringerforderlich
    min items: 1
  • closingNotesstring
    Stored as closing_notes on every item.
  • checklistCompletedByIdmap of array of string
    Expiry id -> array of completed checklist item ids.
  • checklistCommentsByIdmap of map of string
    Expiry id -> {checklist item id -> comment}.

Rückgabe

200
Result per batch.
  • successbooleanerforderlich
  • completed_countintegererforderlich
  • completed_itemsarray of objectserforderlich
  • 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.