v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Email Validations

Schedule email validation

<small>Requires the contacts:operate scope (or a broader one that includes it).</small>

Schedules an asynchronous email-validation job for the supplied contact IDs. Returns 202 Accepted with a Location header pointing at /v3/background-jobs/{jobId} — poll that endpoint for status and the eventual result.

The eligibility filter (team scope + RequiresValidation status) and the credits cap applied here mirror the /estimate semantics. Set acceptPartial = true to schedule whatever credits allow when the team's balance is below the eligible count.

post/v3/email-validations/schedule

Request body

contactIdsinteger[] required

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

acceptPartialboolean nullable

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

jobIdstring uuid

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

scheduledCountinteger

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

creditsReservedinteger

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