Skip to main content
POST
Schedule email validation

Authorizations

Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Get your API key from the Reply dashboard: Settings → API Key.

Body

application/json

Request body shared by both /estimate and /schedule. Specifies the contacts to validate and an optional partial-credit acceptance flag.

contactIds
integer[]
required

Contact IDs to validate. Must be non-empty, contain at most 10000 items, and every value must be a positive integer.

Required array length: 1 - 10000 elements
Required range: x >= 1
acceptPartial
boolean | null

When true, the schedule call proceeds with min(eligibleCount, creditsAvailable) contacts even if available credits are below the eligible count. When false (default), insufficient credits become a NotEnoughCredits blocker on /estimate and a 400 on /schedule.

Response

Job scheduled successfully

Acknowledgement returned by /v3/email-validations/schedule. The jobId corresponds to a background job — poll /v3/background-jobs/{jobId} for status and result.

jobId
string<uuid>
read-only

Background-job identifier — use with /v3/background-jobs/{jobId} to poll status

scheduledCount
integer
read-only

Number of contacts scheduled for validation (capped by available credits when acceptPartial = true)

creditsReserved
integer
read-only

Credits held against the team's quota for this job. Released for any contacts whose validation does not succeed.