Skip to main content
POST
TypeScript SDK

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Required: a call without it is refused with 400. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, - and _. Send the same key again when you retry (after a timeout, a dropped connection or a 5xx) and the call is carried out once: the retry gets the first answer back, marked X-Idempotency-Cached: true. The same key with a different body is refused with 422, and a retry that arrives while the first call is still running with 409 (see Retry-After).

Required string length: 8 - 50
Pattern: ^[a-zA-Z0-9_-]{8,50}$
Example:

"9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d"

Path Parameters

partnerId
string<uuid>
required

The partner whose delivery to replay

deliveryId
string<uuid>
required

The delivery to send again (must be a webhook delivery of this partner)

Response

The replay was attempted; the new delivery row

success
boolean
required

Always true on a success.

Example:

true

data
object
required

One send of one notification, to one email address or to your webhook. It stays pending while it is being tried again, and ends delivered, failed (given up on) or cancelled (nobody wanted it any more, for example because the webhook was switched off).

Example:
meta
object

Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat.