Forms

Approve all pending signups

Confirm pending signups without waiting for the link click, up to 200 per call; call again while remaining is above zero. Each one becomes a contact, fires contact.subscribed and gets the welcome email if enabled. Signups whose confirmation email bounced, was marked as spam or failed are left pending and counted in skipped_undeliverable. Signups submitted through Tor are left pending and counted in skipped_tor. Requires the form:write scope.

post/v1/forms/{id}/pending/approve-all

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/forms/{id}/pending/approve-all
  • Auth: HTTP bearer

Path parameters

idstring required

The signup form ID

Request body

qstring

Only approve signups matching this search

Response

Approval result

approvedinteger required
skippedinteger required
remaininginteger required
skipped_undeliverableinteger required
skipped_torinteger required

Example response

{
  "approved": 8,
  "skipped_undeliverable": 1,
  "skipped_tor": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.