v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Email Validations

Estimate email validation

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

Synchronous probe — given a list of contact IDs, returns counts, credit sufficiency, and any blockers that would prevent scheduling. Useful for showing pre-flight feedback in the UI before triggering /schedule.

post/v3/email-validations/estimate

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

Estimate computed successfully

requestedCountinteger

Total number of contact IDs in the request body

eligibleCountinteger

Number of contacts the user can actually validate (filtered by team scope and validation-status)

creditsAvailableinteger

Email-validation credits currently available to the team

creditsRequiredinteger

Credits that would be charged if the eligible contacts are scheduled in full

creditsSufficientboolean

Whether creditsAvailable >= creditsRequired

canScheduleboolean

Whether the request can be scheduled — equivalent to blockers.length == 0

blockersinteger[]

Reasons why scheduling is currently blocked. Empty when canSchedule is true.