Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

Estimate a verification

How many of the target’s contacts were never verified and what verifying them would cost. Changes nothing.

POST/verifications/estimate
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Corps de la requête
requisapplication/json
targetVerificationTargetrequis
Afficher les propriétés
Exactement un de :
object
kindstringrequis
Valeurs autorisées :contacts
contact_idsstring<uuid>[]requis

Contacts of the team, by id

min 1 éléments · max 50000 éléments
object
kindstringrequis
Valeurs autorisées :segment
segment_idstring<uuid>requis

Every contact in this segment

object
kindstringrequis
Valeurs autorisées :broadcast
broadcast_idstring<uuid>requis

The broadcast's audience: the contacts it would mail, leaving out everyone who unsubscribed

Réponses
200

The counts and the estimated cost

objectstringrequis
Valeurs autorisées :verification_estimate
totalintegerrequis

Contacts the target names

unverifiedintegerrequis

Of them, never verified: what a start would verify (verified ones are skipped)

in_runintegerrequis

Of the unverified, already being verified

grant_remainingintegerrequis

Free verification credit left this quota month, which a run uses first

estimated_centsintegerrequis

What verifying the unverified would cost past the credit, in cents

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
404

The segment or broadcast is not one of the team's

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error

statusCodenumberrequis
namestringrequis
messagestringrequis
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Corpsapplication/json
Requête
curl -X POST 'https://api.billionsend.com/verifications/estimate' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "target": {
    "kind": "contacts",
    "contact_ids": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }
}'
Réponse
{
  "object": "verification_estimate",
  "total": 0,
  "unverified": 0,
  "in_run": 0,
  "grant_remaining": 0,
  "estimated_cents": 0
}

Cette page vous a-t-elle été utile ?