Skip to content
FlashpiFlashpiFlashpi Docs

account.email_paused

POST

The account’s buyer emails of this mode were paused: too many hard bounces or complaints in the last 7 days, or by Flashpi’s staff. Documents are still issued; their emails fail with email_sending_paused until Flashpi’s staff resume them.

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
webhook-id
required
string format: uuid

The event id (UUIDv7), the same on every attempt and replay: deduplicate on it.

webhook-timestamp
required
string
/^\d+$/

Unix time (seconds) of this attempt. Refuse values more than 5 minutes from your clock.

webhook-signature
required
string

Space-separated v1,<base64> signatures: HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<body> with the base64-decoded part of the whsec_ secret. Accept the request if any of them matches (there is one per valid secret during a rotation).

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
One of:
Account event

An event about the account’s email sending: data is the AccountEmailSending as the API returned it when the event happened (texts in English).

object
id
required
string format: uuid

Example 

01a14082-3c1d-7f0e-8b2a-6d5e4f3a2b10
type
required
string
Allowed values: account.email_paused account.email_resumed

Example 

account.email_paused
environment
required

Mode of the resource.

string
Allowed values: test live
createdAt
required
string format: date-time
data
required

Whether the account’s buyer emails of one mode go out. Flashpi pauses them when the last 7 days have at least 3 hard bounces and 3 % of the emails sent, or at least 2 complaints and 0.05 % (they protect the email provider’s reputation that every customer shares). While paused, documents are still issued and authorized; their emails fail with email_sending_paused and resends answer 409 email_sending_paused. Only Flashpi’s staff resume them.

object
environment
required
string
Allowed values: test live

Example 

live
status
required
string
Allowed values: active paused

Example 

active
pausedAt
required
string | null format: date-time

Example 

null
pauseReason
required

Set while paused: bounce_rate (hard bounces), complaint_rate (complaints) or staff (Flashpi’s staff paused them).

string | null
Allowed values: bounce_rate complaint_rate staff

Example 

null
window
required

The buyer emails the account sent in the last 7 days in this mode (since Flashpi’s staff last resumed them, when that is later).

object
since
required

Where the counted period starts.

string format: date-time
sent
required

Emails the email provider accepted.

number

Example 

120
hardBounces
required

Of those, hard bounces (bounce_permanent: the address or the domain does not exist).

number

Example 

2
complaints
required

Of those, emails the recipient marked as spam.

number

Example 

0

Responses

Section titled “Responses”

2XX

Section titled “2XX”

Acknowledged. Anything else is retried.