Send an expiry reminder email now

posthttps://api.expiryedge.com/v1/sendExpiryNotificationNow

any role (admin, editor or viewer)30/15 minIdempotency-Key

Anfrage

curl -X POST 'https://api.expiryedge.com/v1/sendExpiryNotificationNow' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "expiryId": "exp_4Tq9sLm2",
  "contactIds": [
    "c_8Hk2pQ",
    "c_2Wn7rT"
  ]
}'

Antwort

{
  "attempted": 2,
  "succeeded": 1,
  "failed": 0,
  "skipped": 1,
  "results": [
    {
      "contactId": "c_8Hk2pQ",
      "email": "priya@northwinddental.example",
      "status": "sent"
    },
    {
      "contactId": "c_2Wn7rT",
      "email": "",
      "status": "skipped",
      "reason": "No email or email opt-out"
    }
  ]
}

Emails the expiry reminder immediately to up to 50 of the expiry's assigned contacts, outside the reminder schedule. Uses one email credit per recipient; per-contact outcomes are in results.

Header

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

Body-Parameter

application/json

expiryIdstringerforderlich
Expiry in your organization.
contactIdsarray of stringerforderlich
Contact ids; each must be assigned to the expiry (400 otherwise). Duplicates are removed.
min items: 1 · max items: 50

Rückgabe

200

Per-recipient results.

attemptedinteger
succeededinteger
failedinteger
skippedinteger
Contact missing, notifications disabled, no email / opt-out, or no email credits left.
resultsarray of objects

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.
`404`	The record does not exist or is not in your organization.
`405`	The endpoint does not accept this HTTP method.
`409`	A request with the same Idempotency-Key is still being processed. Retry after `Retry-After` seconds.
`422`	The Idempotency-Key was already used with a different request body.
`429`	Too many requests for this endpoint from your IP. Wait `Retry-After` seconds.
`500`	Unexpected server error. Retry later; quote `requestId` to support.