Skip to content

Re-deliver an alias's emails from a time range​

POST
/v1/aliases/{alias}/replay

Re-delivers the alias's inbound emails received in [since, until] to the destinations the alias routes to now — already-delivered emails are sent again (a new replay_id). Quarantined emails are never replayed. Bounded: up to 1,000 emails per call; a larger window returns next_cursor — call again with it. dry_run: true only counts.

Authorizations​

apiKey

Scoped API key. Scopes are read ⊂ write ⊂ admin. A call needing more scope than the key holds returns 403 insufficient_scope.

Type
HTTP (bearer)

Parameters​

Path Parameters

alias*

The alias id (al_…) or its address (percent-encode the @).

Type
string
Required
Example"al_01KXC4Q2M7Z5T8N3R6W9Y1B4D7"

Request Body​

application/json
JSON
{
  
"since": "2026-10-15T00:00:00Z",
  
"until": "2026-10-15T23:59:59Z",
  
"status": "string",
  
"dry_run": false,
  
"cursor": "string"
}

Responses​

Counted only (dry_run true).

application/json
JSON
{
  
"replay_id": "rpl_ee19dc5fb2be4881851e84f872ec9a93",
  
"alias_id": "al_01KXC4Q2M7Z5T8N3R6W9Y1B4D7",
  
"dry_run": true,
  
"scanned": 0,
  
"replayed": 0,
  
"enqueued": 0,
  
"skipped": 0,
  
"excluded": 0,
  
"destinations": [
  
  
"string"
  
],
  
"next_cursor": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Emithook · a Finnoto product